检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
run_env_name String 发布的环境名 run_env_id String 发布的环境id publish_id String API发布记录编号 acl_name String 绑定的其他同类型的ACL策略名称 req_uri String API的访问地址 auth_type String
实例ID,可从API网关控制台的专享版实例信息中获取。 id 否 String VPC通道的编号。 name 否 String VPC通道的名称。 vpc_type 否 Integer VPC通道的类型。 page_size 否 Integer 每页显示的VPC通道数量,默认值:20。
将流控策略应用于API,则所有对该API的访问将会受到该流控策略的限制。当一定时间内的访问次数超过流控策略设置的API最大访问次数限制后,后续的访问将会被拒绝,从而能够较好的保护后端API免受异常流量的冲击,保障服务的稳定运行。 为指定的API绑定流控策略,绑定时,需要指定在哪个环境上生效。
功能介绍 流控策略可以限制一段时间内可以访问API的最大次数,也可以限制一段时间内单个租户和单个APP可以访问API的最大次数。 如果想要对某个特定的APP进行特殊设置,例如设置所有APP每分钟的访问次数为500次,但想设置APP1每分钟的访问次数为800次,可以通过在流控策略中设置特殊APP来实现该功能。
success Array 发布或下线成功的信息 failure Array 发布或下线失败的API及错误信息 表5 success参数说明(批量发布) 名称 类型 说明 publish_id String 发布记录的ID api_id String 发布成功的API ID api_name
Integer 后端实例对象的状态。 instance_name String 云服务器的名称。 instance_id String 云服务器的ID。 host String 云服务器的主机地址 weight Integer 权重值。 权重值越大,转发到该云服务器的请求数量越多。 取值范围1
系统默认分配的子域名 register_time Timestamp 创建时间 update_time Timestamp 最近修改时间 remark String 描述 call_limits Integer 流控时长内分组下的API的总访问次数限制,默认不限,请根据服务的负载能力自行设置
String VPC通道的编号。 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 id String VPC通道的编号。 name String VPC通道的名称。 type Integer VPC通道的类型。 2:API网关内置支持负载均衡功能的快速通道类型 member_type
修改APP 功能介绍 修改指定APP的信息。其中可修改的属性为:name、remark,当支持用户自定义key和secret的开关开启时,app_key和app_secret也支持修改,其它属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
String 授权创建的时间 appid String APP的编号 app_name String APP的名称 app_creator String APP的创建者,取值如下: USER:租户自己创建 MARKET:API市场分配 app_remark String APP的描述信息 app_type
api_id 是 String api的ID。 throttle_id 否 String 流控策略的编号 throttle_name 否 String 流控策略的名称 env_id 否 String 绑定的环境编号 page_size 否 Integer 每页显示的条数,默认值:20 page_no
String 发布记录的编号 throttle_apply_id String 与流控策略的绑定关系编号 throttle_name String 绑定的流控策略名称 apply_time Timestamp 已绑定的流控策略的绑定时间 auth_type String API的认证方式 req_uri
String API所属分组的名称 api_type Integer API类型 sign_id String 签名密钥的编号 sign_name String 签名密钥的名称 sign_key String 签名密钥的key sign_secret String 签名密钥的密钥 env_id
自定义VPC通道名称,用于识别不同的VPC通道。 端口 VPC通道中主机的端口号,即用户的后端业务端口号。 取值为1 ~ 65535。 成员类型 选择负载通道中的服务器成员类型。成员类型在负载通道创建后将不能修改。 实例:通过选择弹性云服务器的方式添加负载通道成员。 IP地址:通过填写IP地址的方式添加负载通道成员。
Integer 剩余访问次数 quota_used Integer 已使用访问次数 app_key String 生成的APP的key app_secret String 生成的APP的secret 响应参数样例: { "total": 3, "size": 3, "purchases":
每页显示的条数,默认值:20 page_no 否 Integer 页码,默认值:1 precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持name 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的流控策略的数量 size
Integer 流控时长内分组下的API的总访问次数限制,默认不限,请根据服务的负载能力自行设置 time_interval Integer 流控时长 time_unit String 流控的时间单位 url_domains 字典数据类型 分组上绑定的独立域名列表 响应消息样例: {
创建API分组 功能介绍 API分组是API的管理单元,一个API分组等同于一个服务入口,创建API分组时,返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。 专享版API网关已经陆续开放V2版本的接口,请优先使用V2版本接口管理您的API。 URI HTTP/HTTPS请求方法以及URI如下表所示。
描述 call_limits Integer 流控时长内分组下的API的总访问次数限制,默认不限,请根据服务的负载能力自行设置 time_interval Integer 流控时长 time_unit String 流控的时间单位 url_domains Array of UrlDomainsResp
类型 说明 id String VPC通道的编号。 name String VPC通道的名称。 type Integer VPC通道的类型。 2:API网关内置支持负载均衡功能的快速通道类型 member_type String VPC通道的成员类型。 ip(暂不支持) instance