华为云用户手册

URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/throttles/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID，管理员权限可查询。 instance_id 是 String 实例ID，可从API网关控制台的专享版实例信息中获取。 id 是 String 流控策略的ID。

响应消息 表3 参数说明 参数 类型 说明 id String 流控策略的ID name String 流控策略的名称 api_call_limits Integer 单个API流控时间内能够被访问的次数限制 user_call_limits Integer 单个用户流控时间内能够访问API的次数限制 app_call_limits Integer 单个APP流控时间内能够访问API的次数限制 ip_call_limits Integer 单个IP流控时间内能够访问API的次数限制 time_interval Integer 流控的时长 time_unit String 流控的时间单位 remark String 描述 create_time Timestamp 创建时间 is_include_special_throttle Integer 是否包含特殊流控配置： 1：包含 2：不包含 type Integer 流控策略的类型，取值如下： 1 独享 2 共享 bind_num Integer 流控绑定的API数量 enable_adaptive_control String 是否开启动态流控： TRUE FALSE 暂不支持 响应消息样例： {"id": "0325b671-2d50-4614-9868-22102262695d","name": "每秒1000次","api_call_limits": 1000,"user_call_limits": 500,"app_call_limits": 300, "ip_call_limits": 600,"time_interval": 1,"time_unit": "SECOND","create_time": "2017-12-29T01:55:59Z","remark": "API每秒1000次，用户500次，APP300次，IP600次","is_inclu_special_throttle": 2, "type":1,"bind_num": 0, "enable_adaptive_control": "FALSE"}

响应消息 表6 参数说明 名称 类型 说明 id String VPC通道的编号。 name String VPC通道的名称。 type Integer VPC通道的类型。 2：API网关内置支持负载均衡功能的快速通道类型 member_type String VPC通道的成员类型。 ip（暂不支持） instance 仅VPC通道类型为2时有效。 status Integer VPC通道的状态。 1：正常 2：异常 port Integer VPC通道中主机的端口号。 balance_strategy Integer 分发算法。 1：加权轮询（wrr） 2：加权最少连接（wleastconn） 3：源地址哈希（source） 4：URI哈希（uri） create_time Timestamp VPC通道的创建时间。 响应消息样例： { "name": "vpc_001", "type": 2, "member_type": "instance", "port": 15565, "balance_strategy": 1, "id": "c3e6a7d85d9e47be89dfcc3cd37405d7", "create_time": "2018-07-27T12:30:48.027484Z", "status": 1}

请求消息 表3 参数说明 参数 是否必选 类型 说明 name 是 String VPC通道的名称。 长度为3 ~ 64位的字符串，字符串由中文、英文字母、数字、“-”、“_”组成，且只能以英文或中文开头。 说明： 中文字符必须为UTF-8或者unicode编码。 type 是 Integer VPC通道的类型。 2：API网关内置支持负载均衡功能的快速通道类型 member_type type = 2时必选 String VPC通道的成员类型。 ip（暂不支持） instance 仅VPC通道类型为2时有效，缺省为instance。 port type = 2时必选 Integer VPC通道中主机的端口号。 取值范围1 ~ 65535，仅VPC通道类型为2时有效。 balance_strategy type = 2时必选 Integer 分发算法。 1：加权轮询（wrr） 2：加权最少连接（wleastconn） 3：源地址哈希（source） 4：URI哈希（uri） 仅VPC通道类型为2时有效，缺省为1。 vpc_health_config type = 2时必选 字典数据类型 健康检查详情，仅VPC通道类型为2时有效。 vpc_instances 是 字典数据类型 后端实例列表，VPC通道类型为1时，有且仅有1个后端实例。 表4 健康检查详情 参数 是否必选 类型 说明 protocol 是 String 使用以下协议，对VPC中主机执行健康检查。 TCP HTTP HTTPS path protocol = http时必选 String 健康检查时的目标路径。 说明： 需要服从URI规范。 port 否 Integer 健康检查的目标端口，缺省时为VPC中主机的端口号。 取值范围1 ~ 65535。 threshold_normal 是 Integer 正常阈值。 判定VPC通道中主机正常的依据为：连续检查x成功，x为您设置的正常阈值。 取值范围2 ~ 10 threshold_abnormal 是 Integer 异常阈值。 判定VPC通道中主机异常的依据为：连续检查x失败，x为您设置的异常阈值。 取值范围2 ~ 10。 time_out 是 Integer 超时时间：检查期间，无响应的时间，单位为秒。必须小于time_interval字段取值。 取值范围2 ~ 30。 time_interval 是 Integer 间隔时间：连续两次检查的间隔时间，单位为秒。必须大于time_out字段取值。 取值范围5 ~ 300。 http_code protocol = http时必选 String 检查目标HTTP响应时，判断成功使用的HTTP响应码。 取值范围为100到599之前的任意整数值，支持如下三种格式： 多个值，如：200,201,202 一系列值，如：200-299 组合值，如：201,202,210-299 表5 后端实例列表 参数 是否必选 类型 说明 instance_name 是 String 后端实例的名称。 支持汉字，英文，数字，“-”,“_”,“.”，1 ~ 64字符。 说明： 中文字符必须为UTF-8或者unicode编码。 instance_id 是 String 后端实例的编号。 支持英文，数字，“-”,“_”，1 ~ 64字符。 weight type = 2时必选 Integer 权重值。 权重值越大，转发到该后端实例的请求数量越多。 取值范围1 ~ 100，仅VPC通道类型为2时有效。 请求消息样例： { "balance_strategy": 1, "name": "vpc_001", "port": 15565, "type": 2, "member_type": "instance", "vpc_health_config": { "http_code": "205", "path": "/hc", "port": 15563, "protocol": "http", "threshold_abnormal": 5, "threshold_normal": 5, "time_interval": 200, "time_out": 30 }, "vpc_instances": [ { "instance_id": "instance01", "instance_name": "instance_name01", "weight": 10 } ]}

URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1/{project_id}/apigw/instances/{instance_id}/vpc-channels/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID，管理员权限可查询。 instance_id 是 String 实例ID，可从API网关控制台的专享版实例信息中获取。 id 是 String VPC通道的编号。

URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/purchases/groups[?page_size, page_no, id, group_id, group_name] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值：id、group_id 、group_name 、page_size、page_no。 URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 否 String 订购关系编号 group_id 否 String API分组编号 group_name 否 String API分组名称 page_size 否 Integer 每页显示的条数，默认值：20 page_no 否 Integer 页码，默认值：1

响应消息 表3 参数说明 名称 类型 说明 total Integer 满足查询条件的分组总数 size Integer 本次查询返回的分组个数 purchases 字典数据类型 本次查询返回的分组列表 表4 purchases参数说明 参数 类型 说明 id String 订购关系编号 group_id String 分组编号 group_name String 分组名称 group_remark String 分组描述 order_time Timestamp 订购时间 start_time Timestamp 生效时间 expire_time Timestamp 过期时间 group_domains []String 分组访问 域名 列表，查询列表时不返回 quota_left Integer 剩余访问次数 quota_used Integer 已使用访问次数 app_key String 生成的APP的key app_secret String 生成的APP的secret 响应参数样例： {"total": 3,"size": 3,"purchases": [{"id": "615af8d9-f31d-4cdf-8807-b191dc969a07","group_id": "f0585333-5722-4878-b7fa-31ae00b6ae3a","group_name": "api_group_003","group_remark": "分组003","group_domains": null,"quota_used": 0,"quota_left": 2000000000,"order_time": "2017-12-29T06:22:46Z","start_time": "2018-01-01T00:00:00Z","expire_time": "2019-01-01T00:00:00Z","app_key": "0e24****4785","app_secret": "******"},{"id": "9d0b****e4d13","group_id": "02a8****71ae7","group_name": "api_group_002","group_remark": "分组002","group_domains": null,"quota_used": 0,"quota_left": 2000000000,"order_time": "2017-12-29T06:22:46Z","start_time": "2018-01-01T00:00:00Z","expire_time": "2019-01-01T00:00:00Z","app_key": "0e242****04785","app_secret": "******"},{"id": "3f30d****c587","group_id": "73c5802****47f09","group_name": "api_group_001","group_remark": "分组001","group_domains": null,"quota_used": 0,"quota_left": 2000000000,"order_time": "2017-12-29T06:16:03Z","start_time": "2018-01-01T00:00:00Z","expire_time": "2019-01-01T00:00:00Z","app_key": "0e242****4785","app_secret": "******"}]}

响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的签名密钥的数量 size Integer 本次返回的列表长度 signs 字典数据类型 本次查询到的签名密钥列表 表4 signs参数说明 参数 类型 说明 id String 签名密钥的编号 name String 签名密钥的名称 sign_key String 签名密钥的key sign_secret String 签名密钥的密钥 create_time Timestamp 创建时间 update_time Timestamp 更新时间 bind_num Integer 绑定的API数量 响应消息样例： {"total": 2,"size": 2,"signs": [{"name": "signature01","sign_key": "abcd_1234","sign_secret": "******","id": "3a793b65a9034bdfae08924f149bfb4a","create_time": "2018-02-06T12:17:36Z","update_time": "2018-02-07T02:00:27.964766Z", "bind_num":1},{"name": "sada","sign_key": "asdasdasdasda","sign_secret": "******","id": "51ce490901f4411fa54eb06d33bd7218","create_time": "2018-02-06T11:53:08Z","update_time": "2018-02-06T11:53:08Z", "bind_num":1}]}

响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的APP总数 size Integer 本次查询返回的列表长度 apps 字典数据类型 APP列表 表4 apps参数说明 参数 类型 说明 id String 编号 name String 名称 status Integer 状态 app_key String APP的key app_secret String 密钥 register_time Timestamp 创建时间 remark String 描述 update_time Timestamp 更新时间 creator String APP的创建者，取值如下： USER：用户自行创建 MARKET：云商店分配 app_type String APP类型，默认为apig bind_num Integer 绑定的API数量 响应消息样例： {"total": 2,"size": 2,"apps": [{"id": "98ef****a286a4","name": "app_002","status": 1,"app_key": "f627f****54d3fe2","app_secret": "******","remark": "第二个APP","register_time": "2017-12-28T12:32:50Z","update_time": "2017-12-28T12:32:50Z","creator": "MARKET", "app_type": "apig", "bind_num": 2},{"id": "14b39****4537e9","name": "app_001","status": 1,"app_key": "d49b****76eb","app_secret": "******","remark": "第一个APP","register_time": "2017-12-28T12:26:54Z","update_time": "2017-12-28T12:29:35.571Z","creator": "USER", "app_type": "apig", "bind_num": 2}]}

URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apps[?page_size, page_no, id, name, app_key, creator] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值：id、name、app_key、creator、page_size、page_no。 URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 否 String 编号 name 否 String 名称 status 否 Integer 状态 app_key 否 String APP的KEY creator 否 String APP的创建者，取值如下： USER：用户自行创建 MARKET：云商店分配 page_size 否 Integer 每页显示的条数，默认值：20 page_no 否 Integer 页码，默认值：1 precise_search 否 String 指定需要精确匹配查找的参数名称，目前仅支持name

响应消息 表3 参数说明 参数 类型 说明 id String 流控策略的编号 name String 流控策略的名称 api_call_limits Integer 单个API流控时间内能够被访问的次数限制 user_call_limits Integer 单个用户流控时间内能够访问API的次数限制 app_call_limits Integer 单个APP流控时间内能够访问API的次数限制 ip_call_limits Integer 单个IP流控时间内能够访问API的次数限制 time_interval Integer 流控的时长 time_unit String 流控的时间单位 remark String 描述 create_time Timestamp 创建时间 is_include_special_throttle Integer 是否包含特殊流控配置： 1：包含 2：不包含 type Integer 流控策略的类型，取值如下： 1：独享 2：共享 bind_num Integer 流控绑定的API数量 enable_adaptive_control String 是否开启动态流控： TRUE FALSE 暂不支持 响应消息样例： {"id": "0325b671-2d50-4614-9868-22102262695d","name": "每秒800次","api_call_limits": 800,"user_call_limits": 500,"app_call_limits": 300, "ip_call_limits": 600,"time_interval": 1,"time_unit": "SECOND","create_time": "2017-12-29T01:55:59.9904225Z","remark": "API每秒800次，用户500次，APP300次，IP600次","is_inclu_special_throttle": 2, "type":1,"bind_num": 0, "enable_adaptive_control": "FALSE"}

请求消息 表2 参数说明 参数 是否必选 类型 说明 name 是 String 流控策略名称。 支持汉字，英文，数字，下划线，且只能以英文和汉字开头，3 ~ 64字符。 说明： 中文字符必须为UTF-8或者unicode编码。 api_call_limits 是 Integer API流量限制是指时长内一个API能够被访问的次数上限。该值不超过系统默认配额限制，系统默认配额为200tps，用户可根据实际情况修改该系统默认配额。输入的值不超过2147483647。正整数。 user_call_limits 否 Integer 用户流量限制是指一个API在时长之内每一个用户能访问的次数上限，该数值不超过API流量限制值。输入的值不超过2147483647。正整数。 app_call_limits 否 Integer APP流量限制是指一个API在时长之内被每个APP访问的次数上限，该数值不超过用户流量限制值。输入的值不超过2147483647。正整数。 ip_call_limits 否 Integer 源IP流量限制是指一个API在时长之内被每个IP访问的次数上限，该数值不超过API流量限制值。输入的值不超过2147483647。正整数。 time_interval 是 Integer 流量控制的时长单位。与“流量限制次数”配合使用，表示单位时间内的API请求次数上限。输入的值不超过2147483647。正整数。 time_unit 是 String 流控的时间单位： SECOND MINUTE HOUR DAY remark 否 String 流控策略描述 字符长度不超过255。 说明： 中文字符必须为UTF-8或者unicode编码。 type 否 Integer 流控策略的类型，取值如下： 1：独享，表示绑定到流控策略的单个API流控时间内能够被调用多少次。 2：共享，表示绑定到流控策略的所有API流控时间内能够被调用多少次。 enable_adaptive_control 否 String 是否开启动态流控： TRUE FALSE 暂不支持 请求消息样例： {"api_call_limits": 800,"user_call_limits": 500,"app_call_limits": 300, "ip_call_limits": 600,"name": "每秒800次","remark": "API每秒800次，用户500次，APP300次，IP600次","time_interval": 1,"time_unit": "SECOND"}

对象模型 本节介绍特殊流控的对象模型，如下表所示： “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 特殊流控对象模型 参数 类型 说明 操作类型 是否必选 id String 特殊配置的编号 R - strategy_id String 流控策略编号 CR 是 instance_id String 生效的特殊对象的编号 CR 是 instance_type String 对象类型APP/USER CR 是 call_limits Integer 特殊对象在流控时间内能够访问API的最大次数限制 CRU 是 apply_time Timestamp 设置的时间 R - 父主题： 设置特殊流控

响应消息 表3 参数说明 名称 类型 说明 total Integer 满足条件的流控策略总数 size Integer 本次查询返回的列表长度 throttles 字典数据类型 本次查询返回的流控策略列表 表4 throttles参数说明 参数 类型 说明 id String 流控策略的ID name String 流控策略的名称 api_call_limits Integer 单个API流控时间内能够被访问的次数限制 user_call_limits Integer 单个用户流控时间内能够访问API的次数限制 app_call_limits Integer 单个APP流控时间内能够访问API的次数限制 ip_call_limits Integer 单个源IP流控时间内能够访问API的次数限制 time_interval Integer 流控的时长 time_unit String 流控的时间单位 remark String 描述 create_time Timestamp 创建时间 is_include_special_throttle Integer 是否包含特殊流控：1、包含；2、不包含 env_name String 流控策略生效的环境（即在哪个环境上有效） type Integer 流控策略的类型 bind_id String 流控策略与API绑定关系编号 bind_time Timestamp 流控策略与API绑定时间 bind_num Integer 流控策略绑定的API数量 enable_adaptive_control String 是否开启动态流控，暂不支持 响应消息样例： {"total": 1,"size": 1,"throttles": [{"id": "0325b671-2d50-4614-9868-22102262695d","name": "每秒1000次","api_call_limits": 1000,"user_call_limits": 500,"app_call_limits": 300,"ip_call_limits": 100,"time_interval": 1,"time_unit": "SECOND","create_time": "2017-12-29T01:55:59Z","remark": "API每秒1000次，用户500次，APP300次","is_inclu_special_throttle": 2,"env_name": "RELEASE", "type":1, "bind_id":"359f5c1868f647b6ad0f0d285154a791", "bind_time":"2019-07-08T01:27:38Z", "bind_num":1, "enable_adaptive_control":"FALSE"}]}

URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/throttle-bindings/binded-throttles[?page_no, page_size, api_id, throttle_id, throttle_name,env_id] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值：api_id 、throttle_id、throttle_name、env_id、page_size、page_no。 URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 api_id 是 String api的ID。 throttle_id 否 String 流控策略的编号 throttle_name 否 String 流控策略的名称 env_id 否 String 绑定的环境编号 page_size 否 Integer 每页显示的条数，默认值：20 page_no 否 Integer 页码，默认值：1

响应消息 表4 参数说明 参数 类型 说明 id String 特殊配置的编号 strategy_id String 流控策略编号 instance_id Integer 特殊对象的身份标识 instance_name String 作用的APP或租户的名称 instance_type Integer 特殊对象的类型 call_limits Integer 特殊对象在流控时间内能够访问API的最大次数限制 apply_time Timestamp 设置时间 app_id String 作用的APP编号 app_name String 作用的APP名称 响应消息样例： {"id": "778879b8-df10-495b-a087-874859fdea6d","strategy_id": "a3106cfe-801f-4919-b0d7-d785dc5b47f9","instance_id": "98efd77d-10b5-4eca-8170-ed30a4a286a4","instance_name": "app_002","instance_type": "APP","call_limits": 180,"apply_time": "2017-12-29T03:11:18Z","app_id": "98efd77d-10b5-4eca-8170-ed30a4a286a4","app_name": "app_002"}

响应消息 表3 参数说明 名称 类型 说明 id String 编号 acl_name String 名称 acl_type String 类型 PERMIT（白名单类型） DENY（黑名单类型） acl_value String ACL策略的值 entity_type String 对象类型： IP DOMAIN update_time Timestamp 更新时间 响应消息样例： {"id": "d402b35e-1054-4280-b1c5-0d741a28c995","acl_name": "goodone","entity_type": "DOMAIN","acl_type": "PERMIT","acl_value": "19asdfaf-adfadf","update_time": "2017-11-18T14:27:36.918578+08:00"}

请求消息 表2 参数说明 参数 类型 说明 acl_name String ACL策略名称。 支持汉字，英文，数字，下划线，且只能以英文和汉字开头，3 ~ 64字符。 说明： 中文字符必须为UTF-8或者unicode编码。 acl_type String 类型 PERMIT (白名单类型) DENY (黑名单类型) acl_value String ACL策略值，支持一个或多个值，使用英文半角逗号分隔 entity_type String 对象类型： IP DOMAIN 请求消息样例： { "acl_name": "test001","acl_type": "PERMIT", "acl_value": "192.168.1.5,192.168.10.0/24,192.168.12.12-192.168.12.19", "entity_type": "IP"}

响应消息 表3 参数说明 名称 类型 说明 id String 编号 acl_name String 名称 acl_type String 类型 PERMIT（白名单类型） DENY（黑名单类型） acl_value String ACL策略值 entity_type String 对象类型： IP DOMAIN update_time Timestamp 更新时间 响应消息样例： {"id": "d402b35e-1054-4280-b1c5-0d741a28c995", "acl_name": "test", "entity_type": "IP","acl_type": "PERMIT", "acl_value": "192.168.1.5,192.168.10.0/24,192.168.12.12-192.168.12.19","update_time": "2017-11-18T14:27:36.918578+08:00"}

响应消息 表4 参数说明 名称 类型 说明 - 字典数据类型 API与签名密钥的绑定关系列表 表5 字典类型响应参数 名称 类型 说明 id String 绑定关系的ID api_id String API编号 api_name String API名称 api_remark String API描述 group_name String API所属分组的名称 api_type Integer API类型 sign_id String 签名密钥的编号 sign_name String 签名密钥的名称 sign_key String 签名密钥的key sign_secret String 签名密钥的密钥 env_id String API所属环境的编号 env_name String API所属环境的名称 binding_time Timestamp 绑定时间 publish_id String API发布ID 响应消息样例： [ { "id": "d8426fb090e442c4a56a35e451bea085", "api_id": "3c6769c6-ec61-4b45-b478-c60310dbaa1b", "api_name": "bbb", "api_remark": "", "group_name": "asd", "api_type": 1, "sign_id": "3a793b65a9034bdfae08924f149bfb4a", "sign_name": "signature01", "sign_key": "abcd_1234", "sign_secret": "******", "env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID", "env_name": "RELEASE", "binding_time": "2018-02-07T03:17:26.396039456Z", "publish_id": "23234202f5834ab69113fc1b790b6bed" }, { "id": "97952732e6d7452d99de02db99acce27", "api_id": "d85c502a-f916-47e8-bba0-50537a2d1af2", "api_name": "aaa", "api_remark": "", "group_name": "asd", "api_type": 1, "sign_id": "3a793b65a9034bdfae08924f149bfb4a", "sign_name": "signature01", "sign_key": "abcd_1234", "sign_secret": "******", "env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID", "env_name": "RELEASE", "binding_time": "2018-02-07T03:17:26.39803282Z", "publish_id": "6581f68efddc4ff0815e156ec6ecfb52" }]

URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法 请求方法 URI POST /v1/{project_id}/apigw/instances/{instance_id}/sign-bindings URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID，管理员权限可查询。 instance_id 是 String 实例ID，可从API网关控制台的专享版实例信息中获取。

请求消息 表3 参数说明 名称 是否必选 类型 说明 sign_id 是 String 签名密钥编号 publish_ids 是 Array of strings API的发布记录编号 请求参数样例： { "sign_id": "3a793b65a9034bdfae08924f149bfb4a", "publish_ids": [ "374a6d5a-20c7-4ea1-82e1-19fce4556956", "65e6fe53-1ac3-4481-ba36-9f0bc6f22057" ]}

对象模型 本节介绍VPC通道的对象模型。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 VPC通道对象模型 参数 类型 说明 操作类型 是否必选 id String VPC通道的编号 R - name String VPC通道的名称 CRU 是 type Integer VPC通道的类型 2：Builtin通道类型 CRU 是 status Integer VPC通道的状态 1：正常 2：异常 R 是 project_id String 租户的编号 CRU 是 port Integer 端口 CR 是 balance_strategy Integer 分发算法 1：加权轮询（wrr） 2：加权最少连接（wleastconn） 3：源地址哈希（source） 4：URI哈希（uri） CRU 是 create_time Timestamp 创建时间 R 是 表2 健康检查对象模型 参数 类型 说明 操作类型 是否必选 id String 健康检查的编号 R - vpc_id String VPC通道的编号 CRU 是 protocol String 协议 tcp http CRU 是 path Integer 路径，仅当协议为http时生效 CRU 否 port Integer 端口，无值时，使用通道端口 CRU 否 threshold_normal Integer 正常阈值 CRU 是 threshold_abnormal Integer 异常阈值 CRU 是 time_out Integer 超时时间 CRU 是 time_interval Integer 间隔时间 CRU 是 http_code String 成功状态码，仅当协议为http时生效 CRU 否 create_time Timestamp 创建时间 R 是 表3 后端实例对象模型 参数 类型 说明 操作类型 是否必选 id String 后端实例对象的编号 R - vpc_id String VPC通道的编号 CRU 是 ext_vpc_id String 后端实例对象的主机关联的VPC的编号 该字段已废弃 R 是 instance_id String 实例的编号 CRU 否 instance_name String 实例的名称 CRU 否 host String 后端实例对象的主机地址 CRU 是 status Integer 后端实例对象状态 1：正常 2：异常 R 是 weight Integer 权重值 CRU 是 create_time Timestamp 创建时间 R 是 父主题： VPC通道管理（待下线）

URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/apis/runtime/{id}[?env_id] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值：env_id。 URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID，管理员权限可查询。 instance_id 是 String 实例ID，可从API网关控制台的专享版实例信息中获取。 id 是 String API的编号

响应消息 表4 参数说明 参数 类型 说明 id String API编号 name String API名称 group_id String API所属分组的编号 group_name String API所属分组的名称 type Integer API类型 version String API版本 req_protocol String API访问协议 req_method String API请求方式 req_uri String API访问地址 auth_type String API认证方式 auth_opt 字段数据类型 API认证方式参数 authorizer_id String 前端自定义认证对象的ID match_mode String API匹配方式 remark String API描述 bakend_type String 后端类型 run_env_name String 发布的环境名 run_env_id String 发布的环境id publish_id String 发布记录的编号 tag String 服务名称标签，待废弃字段 tags []String 标签 cors Bool 是否支持跨域访问 body_remark String API请求体描述，可以是请求体示例、媒体类型、参数等信息 result_normal_sample String 正常响应示例，描述API的正常返回信息 result_failure_sample String 失败返回示例，描述API的异常返回信息 sl_domain String 分组的二级域名 req_params 字典数据类型 API的请求参数列表 表5 req_params参数说明 参数 类型 说明 id String 参数编号 name String 参数名称 type String 参数类型 location String 参数位置 default_value String 参数默认值 sample_value String 参数示例值 required Integer 是否必须 valid_enable Integer 是否开启校验 remark String 描述 enumerations String 参数枚举值 min_num Integer 参数最小值（参数类型为NUMBER时有效） max_num Integer 参数最大值（参数类型为NUMBER时有效） min_size Integer 参数最小长度 max_size Integer 参数最大长度 regular String 正则校验规则 json_schema String JSON校验规则 表6 auth_opt参数说明 参数 类型 说明 app_code_auth_type String AppCode简易认证类型 响应消息样例： { "name": "market_api01", "type": 1, "version": "V0.0.1", "req_protocol": "HTTPS", "req_method": "GET", "req_uri": "/test01", "auth_type": "APP", "auth_opt": { "app_code_auth_type": "HEADER" }, "tags": ["APIG-SN-test", "test"], "cors": true, "match_mode": "NORMAL", "backend_type": "MOCK", "remark": "market_api01", "group_id": "7f848adc971749cda9c6aff3877cfc3e", "body_remark": "market_api01", "result_normal_sample": "success", "result_failure_sample": "", "id": "0e51b689e0784bc884f43756bbf34fa5", "group_name": "market_group01", "run_env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID", "run_env_name": "RELEASE", "publish_id": "f07eb9f5e5ba4bbfbe89326f5cae99c7", "sl_domain": "61297835ff1e4905b6f635dbcdf1777e.apigw.example.com", "req_params": [ { "name": "project_id", "type": "STRING", "location": "PATH", "default_value": "", "sample_value": "", "required": 1, "valid_enable": 2, "remark": "", "enumerations": "", "min_num": 0, "max_num": 0, "min_size": 0, "max_size": 0, "regular": "", "json_schema": "", "id": "2a61905ea2304186a9422faba2940735" } ]}

响应消息 表3 参数说明 名称 类型 说明 common_name String 证书域名 san 字典数据类型 SAN域名 version String 证书版本 organization 字典数据类型 公司、组织 organizational_unit 字典数据类型 部门 locality 字典数据类型 城市 state 字典数据类型 省份 country 字典数据类型 国家 not_before Timestamp 证书有效期起始时间 not_after Timestamp 证书有效期截止时间 serial_number String 序列号 issuer 字典数据类型 颁发者 signature_algorithm String 签名算法

请求消息 表3 参数说明 名称 是否必选 类型 说明 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串，字符串由中文、英文字母、数字、“_”组成，且只能以英文或中文开头。 type 是 String 自定义认证类型： FRONTEND：前端 BACKEND：后端 authorizer_type 是 String 只能为：FUNC authorizer_uri 是 String 函数urn identities 否 List 认证来源 ttl 否 Integer 缓存时间 user_data 否 String 用户数据

响应消息 表5 参数说明 名称 类型 说明 id String 编号 name String 自定义认证的名称 type String 自定义认证类型： FRONTEND：前端 BACKEND：后端 authorizer_type String 只能为：FUNC authorizer_uri String 函数urn identities Array 认证来源 ttl Integer 缓存时间 user_data String 用户数据 create_time Time 创建时间

URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1/{project_id}/apigw/instances/{instance_id}/authorizers URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID，管理员权限可查询。 instance_id 是 String 实例ID，可从API网关控制台的专享版实例信息中获取。

请求消息 表3 参数说明 名称 是否必选 类型 说明 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串，字符串由中文、英文字母、数字、“_”组成，且只能以英文或中文开头。 type 是 String 自定义认证类型： FRONTEND：前端 BACKEND：后端 authorizer_type 是 String 只能为：FUNC authorizer_uri 是 String 函数urn identities 否 List 认证来源 ttl 否 Integer 缓存时间 user_data 否 String 用户数据