华为云用户手册

对象模型 本节介绍API及后端服务的对象模型。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 API对象模型 参数 类型 说明 操作类型 是否必选 id String API的编号 R - name String API的名称 CRU 是 group_id String API所属分组的编号 CR 是 type Integer API的类型： 1：公有API 2：私有API CRU 是 status Integer API的状态： 1：启用 2：禁用 3：已删除 默认1 该字段已废弃 R - version String API的版本 CRU 否 req_protocol String API的访问协议 HTTP HTTPS BOTH：同时支持HTTP和HTTPS 默认：HTTPS CRU 否 req_method String API的访问方式 GET POST PUT DELETE HEAD PATCH OPTIONS ANY CRU 是 req_uri String API的访问地址，不含 域名 、端口号、请求协议等，是URI CRU 是 auth_type String API的认证方式 NONE：无认证 APP：APP认证 IAM ：IAM认证 AUTHORIZER：自定义认证 CRU 是 authorizer_id String 前端自定义认证对象的ID CRU 否 match_mode String API的路由匹配方式： SWA：前缀匹配 NORMAL：正常匹配 CRU 是 arrange_necessary Integer 是否需要编排 1：是 2：否 目前默认为：2 R - backend_type String 后端服务类型： HTTP：web后端 FUNCTION：函数服务 MOCK： MOCK CRU 是 register_time Timestamp API创建时间 R - update_time Timestamp API修改时间 R - remark String API描述 CRU 否 tag String API标签 CRU 否 cors String 是否支持跨域 TRUE 支持 FALSE 不支持 默认：FALSE CRU 否 表2 web后端对象模型 参数 类型 说明 操作类型 是否必选 id String 编号 R - status Integer 状态： 1：启用 2：禁用 3：已删除 默认1 该字段已废弃 R - version String 版本 CRU 否 url_domain String 后端endpoint CRU 是 req_protocol String 访问协议 HTTP HTTPS CRU 是 req_method String 请求方式 GET POST PUT DELETE HEAD PATCH OPTIONS ANY CRU 是 req_uri String 访问地址，是URI CRU 是 timeout Integer 超时时间，单位：毫秒（1-60000） CRU 是 front_api_id String 对应的API编号 R - register_time Timestamp 创建时间 R - update_time Timestamp 修改时间 R - remark String 描述 CRU 否 vpc_status Integer 是否使用VPC通道 1：使用 2：不使用 CRU 否，默认不使用 vpc_info String VPC通道信息 CRU 否 如果vpc_status=1，即：使用VPC通道，则该字段必填 authorizer_id String 后端自定义认证对象的ID CRU 否 表3 MOCK后端对象模型 参数 类型 说明 操作类型 是否必选 id String 编号 R - front_api_id String 对应的API编号 R - status Integer 状态： 1：启用 2：禁用 3：已删除 默认1 该字段已废弃 R - version String 版本 CRU 否 result_content String 返回结果 CRU 否 register_time Timestamp 创建时间 R - update_time Timestamp 修改时间 R - remark String 描述 CRU 否 表4 函数工作流 对象模型 参数 类型 说明 操作类型 是否必选 id String 编号 R - front_api_id String 对应的API编号 R - status Integer 状态： 1：启用 2：禁用 3：已删除 默认1 该字段已废弃 R - version String 函数版本号 CRU 否 function_urn String 函数的URN CRU 是 invocation_type String 函数类型：async|sync(异步|同步) CRU 是 timeout Integer 超时时间（1-60000），单位：毫秒 CRU 是 register_time Date 创建时间 R - update_time Date 修改时间 R - remark String 描述 CRU 否 表5 请求参数对象模型 参数 类型 说明 操作类型 是否必选 id String 编号 R - front_api_id String 对应的API编号 R - name String 参数名称 CRU 是 type String 参数类型： string number CRU 是 location String 参数位置： PATH QUERY HEADER FORMDATA CRU 是 default_value String 参数默认值 CRU 否 sample_value String 参数示例值 CRU 否 required Integer 参数是否必须： 1：是 2：否 CRU 是 valid_enable Integer 是否开启参数校验： 1：是 2：否 CRU 是 remark String 参数描述 CRU 否 enumerations String 参数枚举值 CRU 否 min_num String 参数最小值 CRU 否 max_num String 参数最大值 CRU 否 min_size Integer 参数最小长度 CRU 否 max_size Integer 参数最大长度 CRU 否 regular String 正则校验规则（暂不支持） CRU 否 json_schema String JSON校验规则（暂不支持） CRU 否 表6 后端参数对象模型 参数 类型 说明 操作类型 是否必选 id String 编号 R - front_api_id String 对应的API编号 R - req_param_id String 对应的请求参数的编号 R - name String 参数名称 CRU 是 location String 参数位置： PATH QUERY HEADER FORMDATA CRU 是 origin String 参数类型： REQUEST CONSTANT SYSTEM CRU 是 value String 参数值： 类型为REQUEST时，值为请求参数的参数名称。 类型为SYSTEM时，值为网关参数名称。 类别为CONSTANT时，值为参数真正的值。 CRU 否 remark String 描述 CRU 否 policy_id String 关联的策略条件编号 CRU 否 表7 WEB策略后端对象模型 参数 类型 说明 操作类型 是否必选 id String 编号 R - front_api_id String 对应的API编号 R - name String 策略后端名称 CRU 是 url_domain String 后端endpoint CRU 是 req_protocol String 访问协议 HTTP HTTPS CRU 是 req_method String 请求方式 GET POST PUT DELETE HEAD PATCH OPTIONS ANY CRU 是 req_uri String 访问地址，是URI CRU 是 timeout Integer 超时时间，单位：毫秒（1-60000） CRU 否 vpc_status Integer 是否使用VPC通道 1：使用 2：不使用 CRU 否，默认不使用 vpc_info String VPC通道信息 CRU 否 如果vpc_status=1，即：使用VPC通道，则该字段必填 effect_mode String 关联的策略组合模式 ALL ANY CRU 是 表8 MOCK策略后端对象模型 参数 类型 说明 操作类型 是否必选 id String 编号 R - front_api_id String 对应的API编号 R - name String 策略后端名称 CRU 是 result_content String 返回结果 CRU 否 effect_mode String 关联的策略组合模式 ALL ANY CRU 是 表9 函数工作流策略后端对象模型 参数 类型 说明 操作类型 是否必选 id String 编号 R - front_api_id String 对应的API编号 R - name String 策略后端名称 CRU 是 version String 函数版本号 CRU 否 function_urn String 函数的URN CRU 是 invocation_type String 函数类型：async|sync(异步|同步) CRU 是 timeout Integer 超时时间（1-60000），单位：毫秒 CRU 是 effect_mode String 关联的策略组合模式 ALL ANY CRU 是 表10 策略后端条件对象模型 参数 类型 说明 操作类型 是否必选 id String 策略后端条件对象的编号 R - condition_type String 策略条件： exact：绝对匹配 enum：枚举 pattern：正则 CRU 否 condition_value String 策略值 CRU 是 condition_origin String 策略类型： param：参数 source：源IP CRU 是 req_param_id String 关联的请求参数对象编号 R - policy_backend_id String 关联的策略后端对象编号 CRU 是 表11 认证方式参数对象模型 参数 类型 说明 操作类型 是否必选 app_code_auth_type String AppCode简易认证类型，仅在auth_type为APP时生效，默认为DISABLE： DISABLE：不开启简易认证 HEADER：开启简易认证且AppCode位置在HEADER CRU - 父主题： API管理（待下线）

响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的API总数 size Integer 本次返回的列表长度 auths 字典数据类型 本次返回的API列表 表4 auths参数说明 名称 类型 说明 id String 授权关系编号 api_id String API的编号 api_name String API的名称 group_name String API绑定的分组 api_remark String API的描述信息 api_type Integer API类型 envname String API授权绑定的环境名称 env_id String API授权绑定的环境编号 auth_role String 授权者 auth_time String 授权创建的时间 appid String APP的编号 app_name String APP的名称 app_creator String APP的创建者，取值如下： USER：租户自己创建 MARKET：API市场分配 app_remark String APP的描述信息 app_type String APP的类型 publish_id String API的发布编号 响应消息样例： {"total": 1,"size": 1,"auths": [{"id": "cfa688d8-094b-445a-b270-6aeb0b70a84a","api_id": "6632a062-9dcf-4f18-9646-3cabb925a290","api_name": "查询API列表","group_name": "api_group_001","api_type": 1,"api_remark": "查询API列表","envname": "RELEASE","auth_role": "PROVIDER","auth_time": "2017-12-28T12:46:43Z","appid": "14b399ac-967f-4115-bb62-c0346b4537e9","app_name": "app_001","app_creator": "USER","env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID","app_remark": "APP的描述信息","app_type": "apig","publish_id": "f500ba7e369b4b1ebae99aa9d114a17a"}]}

URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/app-auths/binded-apis[?page_size, page_no, app_id, api_id, api_name,group_id,group_name,env_id] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值：app_id、 api_id 、 api_name、group_id、group_name、env_id、page_size、page_no。 URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID，管理员权限可查询。 instance_id 是 String 实例ID，可从API网关控制台的专享版实例信息中获取。 app_id 是 String 应用编号 api_id 否 String API编号 api_name 否 String API名称 group_id 否 String API分组编号 group_name 否 String API分组名称 env_id 否 String 授权的环境编号 page_size 否 Integer 每页显示的条数，默认值：20 page_no 否 Integer 页码，默认值：1

响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的环境总数 size Integer 本次返回的列表长度 envs 字典数据类型 本次返回的环境列表 表4 envs参数说明 参数 类型 说明 id String 环境ID name String 环境名称 create_time Timestamp 创建时间 remark String 描述信息 响应消息样例： {"total": 2,"size": 2,"envs": [{"id": "DEFAULT_ENVIRONMENT_RELEASE_ID","name": "RELEASE","remark": "生产环境","create_time": "2017-12-29T03:39:03.165657Z"},{"id": "cca3616a-f368-4b32-9064-b2a631cb3eeb","name": "DEVELOP","remark": "开发环境","create_time": "2017-12-28T12:50:47Z"}]}

URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/envs[?page_no, page_size,name] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值：name、page_size、page_no。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID，管理员权限可查询。 instance_id 是 String 实例ID，可从API网关控制台的专享版实例信息中获取。 name 否 String 环境名称 page_size 否 Integer 每页显示的条数，默认值：20 page_no 否 Integer 页码，默认值：1 precise_search 否 String 指定需要精确匹配查找的参数名称，目前仅支持variable_name

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

响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的APP总数 size Integer 本次返回的列表长度 auths 字典数据类型 本次返回的APP列表 表4 auths参数说明 名称 类型 说明 id String 授权关系编号 api_id String API的编号 api_name String API的名称 group_name String API绑定的分组 api_remark String API的描述信息 api_type Integer API类型 envname String api授权绑定的环境 auth_role String 授权者 auth_time String 授权创建的时间 appid String APP的编号 app_name String APP的名称 app_creator String APP的创建者，取值如下： USER：租户自己创建 MARKET：API市场分配 publish_id String API发布ID env_id String 环境ID app_remark String APP的描述 app_type String APP类型 响应消息样例： {"total": 1,"size": 1,"auths": [{"id": "cfa688d8-094b-445a-b270-6aeb0b70a84a","api_id": "6632a062-9dcf-4f18-9646-3cabb925a290","api_name": "查询API列表","group_name": "api_group_001","api_type": 1,"api_remark": "查询API列表","envname": "RELEASE","auth_role": "PROVIDER","auth_time": "2017-12-28T12:46:43Z","appid": "14b399ac-967f-4115-bb62-c0346b4537e9","app_name": "app_001","app_creator": "USER", "publish_id": "fe9d8ea9f9424594abc3bbe8d861c0f0", "env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID", "app_remark": "", "app_type": "apig"}]}

功能介绍 将API发布到不同的环境后，对于不同的环境，可能会有不同的环境变量，比如，API的服务部署地址，请求的版本号等。 用户可以定义不同的环境变量，用户在定义API时，在API的定义中使用这些变量，当调用API时，API网关会将这些变量替换成真实的变量值，以达到不同环境的区分效果。 环境变量定义在API分组上，该分组下的所有API都可以使用这些变量。 环境变量的变量名称必须保持唯一，即一个分组在同一个环境上不能有两个同名的变量 环境变量区分大小写，即变量ABC与变量abc是两个不同的变量 设置了环境变量后，使用到该变量的API的调试功能将不可使用。 定义了环境变量后，使用到环境变量的地方应该以对称的#标识环境变量，当API发布到相应的环境后，会对环境变量的值进行替换，如：定义的API的URL为：https://#address#:8080，环境变量address在RELEASE环境上的值为：192.168.1.5，则API发布到RELEASE环境后的真实的URL为：https://192.168.1.5:8080。

响应消息 表3 参数说明 参数 类型 说明 id String 环境变量的编号 env_id String 环境编号 group_id String API分组编号 variable_name String 变量名 variable_value String 变量值 响应消息样例： {"id": "104185e53e8f4c63a7e5ef4117bf870c","env_id": "cca3616af3684b329064b2a631cb3eeb","group_id": "73c58022f20d495aa18885d718647f09","variable_name": "address","variable_value": "192.168.1.5"}

请求消息 表2 参数说明 参数 是否必选 类型 说明 env_id 是 String 环境编号 group_id 是 String API分组编号 variable_name 是 String 变量名 支持英文字母、数字、英文格式的下划线、中划线，必须以英文字母开头，3 ~ 32个字符。在API定义中等于#Name的值#部分（区分大小写），发布到环境里的API被变量值替换。 说明： 中文字符必须为UTF-8或者unicode编码。 variable_value 是 String 变量值 支持英文字母、数字、英文格式的下划线、中划线，斜线（/）、点、冒号，1 ~ 255个字符。 请求消息样例： {"env_id": "cca3616af3684b329064b2a631cb3eeb","group_id": "73c58022f20d495aa18885d718647f09","variable_name": "address","variable_value": "192.168.1.5"}

响应消息 表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"}

URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/acls[?page_size, page_no, id, name, acl_type, entity_type] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值：id、name、acl_type、entity_type、page_size、page_no。 URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 否 String 编号 name 否 String 名称 acl_type 否 String 类型：PERMIT或DENY entity_type 否 String 作用的对象类型：IP或DOMAIN page_size 否 Integer 每页显示的条数，默认值：20 page_no 否 Integer 页码，默认值：1 precise_search 否 String 指定需要精确匹配查找的参数名称，目前仅支持name

响应消息 表3 参数说明 名称 类型 说明 size Integer 当前页返回的ACL策略个数 total Integer ACL策略总个数 acls 字典数据类型 本次查询返回的ACL策略列表 表4 acls参数说明 名称 类型 说明 id String 编号 acl_name String 名称 acl_type String 类型 PERMIT（白名单类型） DENY（黑名单类型） acl_value String ACL策略的值 entity_type String 对象类型： IP DOMAIN update_time Timestamp 更新时间 bind_num Integer 绑定的API数量 响应消息样例： {"total": 1,"size": 1,"acls": [{"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", "bind_num":1}]}

响应消息 表3 参数说明 参数 类型 说明 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 响应消息样例： { "id": "3f3****cc587", "group_id": "73c58****7f09", "group_name": "api_group_001", "group_remark": "分组001", "group_domains": [ "test.market.example.com" ], "quota_used": 0, "quota_left": 2000000000, "order_time": "2018-01-02T10: 51: 26Z", "start_time": "2018-01-01T00: 00: 00Z", "expire_time": "2019-01-01T00: 00: 00Z", "app_key": "0e242****4785", "app_secret": "******"}

对象模型 本节介绍APP与API之间的授权关系的对象模型，如下表所示。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 APP授权关系对象模型 参数 类型 说明 操作类型 是否必选 id String 授权关系的ID R - app_id String APP的编号 CR 是 front_api_id String api的编号 CR 是 env_id String 环境编号（发布环境） CR 是 create_time Timestamp 授权时间 R - auth_role String 授权者 R - 父主题： APP授权管理

URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/env-variables[?page_size, page_no, env_id, group_id, variable_name] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值：env_id、group_id、variable_name、page_size、page_no 表2 参数说明 名称 是否必选 类型 说明 env_id 否 String 环境编号 group_id 是 String API分组编号 variable_name 否 String 变量名 page_size 否 Integer 每页显示的条数，默认值：20 page_no 否 Integer 页码，默认值：1 precise_search 否 String 指定需要精确匹配查找的参数名称，目前仅支持variable_name

响应消息 表3 参数说明 名称 类型 说明 variables 字典数据类型 本次返回的环境变量列表 total Integer 满足条件的环境变量总数 size Integer 本次返回的列表长度 表4 variables参数说明 参数 类型 说明 id String 环境变量编号 env_id String 环境编号 group_id String API分组编号 variable_name String 变量名 variable_value String 变量值 响应消息样例： {"total": 2,"size": 2,"variables": [{"id": "09ab8135722440b9bf5d107f2a09d409","env_id": "cca3616af3684b329064b2a631cb3eeb","group_id": "73c58022f20d495aa18885d718647f09","variable_name": "port","variable_value": "8080"},{"id": "104185e53e8f4c63a7e5ef4117bf870c","env_id": "cca3616af3684b329064b2a631cb3eeb","group_id": "73c58022f20d495aa18885d718647f09","variable_name": "address","variable_value": "192.168.1.5"}]}

响应消息 表3 参数说明 名称 类型 说明 throttle_applys 字典数据类型 API与流控策略的绑定关系列表 表4 throttle_applys参数说明 名称 类型 说明 id String 绑定关系的ID。 strategy_id String 流控策略的ID。 publish_id String API的发布记录编号 scope Integer 策略作用域，取值如下： 1: 整个API 2: 单个用户 3: 单个APP 目前只支持1 apply_time Timestamp 绑定时间 响应消息样例： {"throttle_applys": [{"id": "507c6a9f-8322-4dc2-8ba5-b4d74e3690d3","strategy_id": "0325b671-2d50-4614-9868-22102262695d","publish_id": "374a6d5a-20c7-4ea1-82e1-19fce4556956","scope": 1,"apply_time": "2017-12-29T03:01:11.138456Z"},{"id": "90f05978-06a3-4096-8bea-b5e2fa12b843","strategy_id": "0325b671-2d50-4614-9868-22102262695d","publish_id": "65e6fe53-1ac3-4481-ba36-9f0bc6f22057","scope": 1,"apply_time": "2017-12-29T03:01:11.138456Z"}]}

功能介绍 将流控策略应用于API，则所有对该API的访问将会受到该流控策略的限制。当一定时间内的访问次数超过流控策略设置的API最大访问次数限制后，后续的访问将会被拒绝，从而能够较好的保护后端API免受异常流量的冲击，保障服务的稳定运行。 为指定的API绑定流控策略，绑定时，需要指定在哪个环境上生效。 同一个API发布到不同的环境可以绑定不同的流控策略；一个API在发布到特定环境后只能绑定一个默认的流控策略。

请求消息 表2 参数说明 名称 是否必选 类型 说明 publish_ids 是 Array of strings API的发布记录编号 strategy_id 是 String 流控策略编号 请求参数样例： { "publish_ids": [ "374a6d5a-20c7-4ea1-82e1-19fce4556956", "65e6fe53-1ac3-4481-ba36-9f0bc6f22057" ], "strategy_id": "0325b671-2d50-4614-9868-22102262695d"}

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

响应消息 表3 参数说明 名称 类型 说明 total Integer 满足查询条件的API总数 size Integer 本次查询返回的API个数 apis 字典数据类型 本次查询返回的API列表 表4 apis参数说明 参数 类型 说明 id String API编号 name String API名称 purchase_id String 订购关系编号 remark String API描述 req_uri String API的访问地址 响应消息样例： {"total": 3,"size": 3,"apis": [{"id": "cb498965-8acf-4c98-bd08-4033ef1fcfb4","name": "查询环境列表","purchase_id": "730f8a84-c8db-45ba-a6a5-2669ceb08574","remark": "查询环境列表","req_uri": "/envs"},{"id": "5bbc47e2-95b0-4a56-904e-a3cdc422f8e9","name": "查询分组列表","purchase_id": "2ae11f50-3938-4560-8b76-58e89bb3f825","remark": "查询分组列表","req_uri": "/groups"},{"id": "6632a062-9dcf-4f18-9646-3cabb925a290","name": "查询API列表","purchase_id": "2ae11f50-3938-4560-8b76-58e89bb3f825","remark": "查询API列表","req_uri": "/apis"}]}

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

响应消息 表3 参数说明 名称 类型 说明 - 字典数据类型 API与签名密钥的绑定关系列表 表4 字典类型响应参数 名称 类型 说明 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" }]

响应消息 表3 参数说明 名称 类型 说明 size Integer 当前页返回的ACL策略个数 total Integer ACL策略总个数 acls 字典数据类型 本次查询返回的ACL策略列表 表4 acls参数说明 名称 类型 说明 id String 编号 acl_name String 名称 acl_type String 类型 PERMIT（白名单类型） DENY（黑名单类型） acl_value String ACL策略的值 entity_type String 对象类型： IP DOMAIN update_time Timestamp 更新时间 bind_num Integer 绑定的API数量 响应消息样例： {"total": 1,"size": 1,"acls": [{"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", "bind_num":1}]}

URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/acls[?page_size, page_no, id, name, acl_type, entity_type] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值：id、name、acl_type、entity_type、page_size、page_no。 URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID，管理员权限可查询。 instance_id 是 String 实例ID，可从API网关控制台的专享版实例信息中获取。 id 否 String 编号 name 否 String 名称 acl_type 否 String 类型：PERMIT或DENY entity_type 否 String 作用的对象类型：IP或DOMAIN page_size 否 Integer 每页显示的条数，默认值：20 page_no 否 Integer 页码，默认值：1 precise_search 否 String 指定需要精确匹配查找的参数名称，目前仅支持name

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

对象模型 本节介绍签名密钥的对象模型，如下表所示： “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 签名密钥模型 参数 类型 说明 操作类型 是否必选 id String 签名密钥的编号 R - name String 签名密钥的名称 CRU 是 sign_key String 签名密钥的key CRU 是 sign_secret String 签名密钥的密钥 CRU 是 create_time Timestamp 创建时间 R - update_time Timestamp 更新时间 R - 父主题： 签名密钥管理（待下线）

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

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