检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
实例ID,可从API网关控制台的专享版实例信息中获取。 api_id 是 String API的编号 env_id 否 String 环境的编号 env_name 否 String 环境的名称 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 total Integer 满足条件的API历史版本总数
version_id String 在线的版本号 表7 BatchFailure 参数 参数类型 描述 api_id String 发布或下线失败的API ID api_name String 发布或下线失败的APi名称 error_code String 发布或下线失败的错误码 error_msg
修改APP 功能介绍 修改指定APP的信息。其中可修改的属性为:name、remark,当支持用户自定义key和secret的开关开启时,app_key和app_secret也支持修改,其它属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
0/apigw/authorizers/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String 自定义认证的ID 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 id String 编号 name String 自定义认证的名称 type String
API认证 使用FunctionGraph服务实现APIG的自定义认证 使用APIG的APP认证和自定义认证实现API的双重认证 配置APIG专享版与客户端间的单向认证或双向认证
实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码:
实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码:
实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码:
实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 FormData参数
page_no, id, name, type] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:id、name、type、page_size、page_no URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 否 String
instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 group_id 是 String 分组的编号 domain_id 是 String 域名的编号 certificate_id 是 String 证书的编号 请求参数 表2 请求Header参数 参数 是否必选
系统默认分配的子域名列表 register_time Timestamp 创建时间 update_time Timestamp 最近修改时间 remark String 描述 call_limits Integer 流控时长内分组下的API的总访问次数限制,默认不限,请根据服务的负载能力自行设置
id 是 String 流控策略的ID。 请求消息 无 响应消息 表3 参数说明 参数 类型 说明 id String 流控策略的ID name String 流控策略的名称 api_call_limits Integer 单个API流控时间内能够被访问的次数限制 user_call_limits
ct-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 app_secret 否 String 密钥。支持英文,数字,“_”,“-”,“!”,“@”,“#”,“$”,“%”,且只能以英文或数字开头,8 ~ 128个字符。用户自定义APP的密钥需要开启配额开关。
导入导出API 导入导出API的限制与兼容性说明 通过API设计文件导入API 通过CSE微服务导入API 通过CCE工作负载导入API 导出APIG的API 父主题: 管理API
实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码:
entity_type] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:id、name、acl_type、entity_type、page_size、page_no。 URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明
String 筛选的特殊应用名称 user 否 String 筛选的特殊租户的账号ID 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 throttle_specials 字典数据类型 本次查询返回的特殊配置列表 total Integer 符合条件的特殊设置总数 size
URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。
功能介绍 流控策略可以限制一段时间内可以访问API的最大次数,也可以限制一段时间内单个租户和单个APP可以访问API的最大次数。 如果想要对某个特定的APP进行特殊设置,例如设置所有APP每分钟的访问次数为500次,但想设置APP1每分钟的访问次数为800次,可以通过在流控策略中设置特殊APP来实现该功能。