华为云用户手册

响应消息 表4 参数说明 名称 类型 说明 -- 字典数据类型 API与APP的授权关系列表 表5 API与APP授权关系列表消息说明 名称 类型 说明 id String 授权关系编号 api_id String API编号 app_id String APP编号 auth_time Timestamp 授权时间 auth_role String 授权者： PROVIDER：API提供者授权 CONSUMER：API消费者授权 auth_result String 授权结果： SUC CES S：授权成功 SKIPPED：跳过 响应消息样例： [{"id": "dffcaff92d144135a9f420fcd485bbf3","api_id": "8aa097b00e9843efabc9c593d11b769d","app_id": "f8c6ea15-0d1b-4c5b-bd4b-911610bd3b3e","auth_time": "2018-03-30T09:37:43.490197204Z","auth_role": "PROVIDER","auth_result": "SUCCESS"}]

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

请求消息 表3 参数说明 名称 是否必选 类型 说明 api_ids 是 Array of strings API的编号列表 可以选择租户自己的API，也可以选择从云商店上购买的API。 app_ids 是 Array of strings APP的编号列表 env_id 是 String 需要授权的环境编号 请求参数样例： {"api_ids": ["5bbc47e2-95b0-4a56-904e-a3cdc422f8e9","6632a062-9dcf-4f18-9646-3cabb925a290"],"app_ids": ["14b399ac-967f-4115-bb62-c0346b4537e9"],"env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID"}

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

功能介绍 将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 参数说明 参数 是否必选 类型 说明 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": "cca3616a-f368-4b32-9064-b2a631cb3eeb","group_id": "73c58022-f20d-495a-a188-85d718647f09","variable_name": "address","variable_value": "192.168.1.5"}

响应消息 表4 参数说明 参数 类型 说明 id String 环境变量的编号 env_id String 环境编号 group_id String API分组编号 variable_name String 变量名 variable_value String 变量值 响应消息样例： {"id": "104185e5-3e8f-4c63-a7e5-ef4117bf870c","env_id": "cca3616a-f368-4b32-9064-b2a631cb3eeb","group_id": "73c58022-f20d-495a-a188-85d718647f09","variable_name": "address","variable_value": "192.168.1.5"}

URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/throttle-bindings/unbinded-apis[?page_size, page_no, throttle_id, group_id, env_id, api_id, api_name] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值：group_id、env_id、throttle_id、api_id、api_name、page_size、page_no。

请求消息 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID，管理员权限可查询。 instance_id 是 String 实例ID，可从API网关控制台的专享版实例信息中获取。 throttle_id 是 String 流控策略的编号 env_id 否 String 环境的编号 group_id 否 String API分组编号 api_id 否 String API编号 api_name 否 String API名称 page_size 否 Integer 每页显示的条数，默认值：20 page_no 否 Integer 页码，默认值：1

响应消息 表3 参数说明 名称 类型 说明 total Integer 满足查询条件的API的总个数 size Integer 当前查询到的列表长度 apis 字典数据类型 当前查询到的API列表 表4 apis参数说明 参数 类型 说明 id String API编号 name String API名称 group_id String API所属分组的编号 group_name String API所属分组的名称 type Integer API类型 remark String API描述 run_env_name String 发布的环境名 run_env_id String 发布的环境编号 publish_id String 发布记录的编号 throttle_apply_id String 与流控策略的绑定关系编号 throttle_name String 绑定的流控策略名称 apply_time Timestamp 已绑定的流控策略的绑定时间 auth_type String API的认证方式 req_uri String API的访问地址 响应消息样例： {"total": 2,"size": 2,"apis": [{"id": "5bbc47e2-95b0-4a56-904e-a3cdc422f8e9","name": "查询分组列表","type": 1,"remark": "查询分组列表","group_id": "73c58022-f20d-495a-a188-85d718647f09","group_name": "api_group_001","run_env_name": "RELEASE","run_env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID","publish_id": "65e6fe53-1ac3-4481-ba36-9f0bc6f22057","auth_type": "APP","req_uri": "/test"},{"id": "6632a062-9dcf-4f18-9646-3cabb925a290","name": "查询API列表","type": 1,"remark": "查询API列表","group_id": "73c58022-f20d-495a-a188-85d718647f09","group_name": "api_group_001","run_env_name": "RELEASE","run_env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID","publish_id": "374a6d5a-20c7-4ea1-82e1-19fce4556956","auth_type": "APP","req_uri": "/test"}]}

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

响应消息 表4 参数说明 名称 类型 说明 throttle_applys 字典数据类型 API与流控策略的绑定关系列表 表5 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"}]}

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

请求消息 表3 参数说明 名称 是否必选 类型 说明 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"}

对象模型 本节介绍特殊流控的对象模型，如下表所示： “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： 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 - 父主题： 设置特殊流控（待下线）

URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /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的ID。

请求消息 表3 参数说明 参数 是否必选 类型 说明 call_limits 是 Integer 流控时间内特殊对象能够访问API的最大次数限制 instance_id 是 String 特殊APP的编号或特殊租户的账号ID instance_type 是 String 对象类型：APP/USER strategy_id 是 String 流控策略编号 请求消息样例： {"call_limits": 150,"instance_id": "98efd77d-10b5-4eca-8170-ed30a4a286a4","instance_type": "APP","strategy_id": "a3106cfe-801f-4919-b0d7-d785dc5b47f9"}

响应消息 表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": 150, "apply_time": "2017-12-29T03: 11: 18.2698381Z", "app_id": "98efd77d-10b5-4eca-8170-ed30a4a286a4", "app_name": "app_002"}

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

对象模型 API需要绑定ACL策略，ACL策略才能够对API起到保护作用。本节介绍ACL策略与API的绑定关系的对象模型，如表1所示。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 api绑定acl的应用参数列表 参数 类型 说明 操作类型 是否必选 id String 绑定关系编号 R - front_api_id String API编号 CR 是 env_id String 环境的编号 CR 是 acl_id String ACL策略编号 CR 是 create_time Timestamp 绑定的时间 CR 否 父主题： API绑定ACL策略（待下线）

响应消息 表3 参数说明 参数 类型 说明 total Integer 符合条件的API总数 size Integer 本次查询返回的API个数 apis 字典数据类型 本次查询返回的API列表 表4 apis参数说明 参数 类型 说明 id String API的ID。 name String API名称 group_id String API所属分组的编号 group_name String API所属分组的名称。 type Integer API开放状态 remark String API描述 run_env_name String 发布的环境名 run_env_id String 发布的环境id publish_id String API发布记录编号 acl_name String 绑定的其他同类型的ACL策略名称 req_uri String API的访问地址 auth_type String API的认证方式 响应消息样例： { "total": 1, "size": 1, "apis": [ { "name": "bbbbb", "type": 1, "remark": "aaa", "group_id": "70f1b578da9b4dfe889b4c33d1b995c2", "id": "91c26288acea4448be205265d77dae22", "group_name": "test001", "run_env_name": "RELEASE", "run_env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID", "publish_id": "a6e06a00c382436eb524fa2dd343cb6d", "req_uri": "/test", "auth_type": "NONE" } ]}

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

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

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

响应消息 表3 参数说明 名称 类型 说明 total Integer 本次查询满足条件的签名密钥总数 size Integer 本次查询返回的签名密钥列表长度 bindings 字典数据类型 本次查询返回的签名密钥列表 表4 bindings参数说明 名称 类型 说明 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的发布编号 响应消息样例： { "total": 2, "size": 2, "bindings": [ { "id": "4588ec6f5dab4f67b298dc693f58029e", "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-07T07: 08: 51Z", "publish_id": "3a793b65a9034bdfae08924f149bfsda" }, { "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: 26Z", "publish_id": "3a793b65a9034bdfae08924f149bfsda" } ]}

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

请求消息 表3 参数说明 参数 是否必选 类型 说明 apis 是 String Array 需要发布或下线的API ID列表 env_id 是 String 环境ID remark 否 String 对本次发布的描述信息 字符长度不超过255 说明： 中文字符必须为UTF-8或者unicode编码。 请求消息样例： {"apis": ["81efcfd94b8747a0b21e8c04144a4e8c","7addcd00cfab433984b1d8bf2fe08aaa"],"env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID","remark": "发布到生产环境"}

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

响应消息 表4 参数说明 名称 类型 说明 success Array 发布或下线成功的信息 failure Array 发布或下线失败的API及错误信息 表5 success参数说明（批量发布） 名称 类型 说明 publish_id String 发布记录的ID api_id String 发布成功的API ID api_name String 发布成功的APi名称 env_id String 发布环境的ID remark String 发布描述信息 publish_time Timestamp 发布时间 version_id String 版本号 表6 success参数说明（批量下线） 名称 类型 说明 api_id String 下线成功的API ID api_name String 下线成功的API名称 表7 failure参数说明 名称 类型 说明 api_id String 发布或下线失败的API ID api_name String 发布或下线失败的API名称 error_code String 发布或下线失败的错误码 error_msg String 发布或下线失败的错误信息 响应消息样例： {"success": [{"publish_id": "5b729aa252764739be2c37ef0d66dc63","api_id": "7addcd00cfab433984b1d8bf2fe08aaa", "api_name": "testApi","env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID","version_id": "3d9dcb733ba34352b0d02f85fd16b026","remark": "string","publish_time": "2018-07-26T13:18:04.1079916Z"}],"failure": [{"api_id": "81efcfd94b8747a0b21e8c04144a4e8c","error_code": "APIG.3002","error_msg": "api with id 81efcfd94b8747a0b21e8c04144a4e8c not found"}]}

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