华为云用户手册

URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/vpc-channels[?page_size, page_no, id, name, vpc_type] o 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值：id、name、vpc_type、page_size、page_no。

请求消息 表2 参数说明 参数 是否必选 类型 说明 env_id/env 是 String API分组发布的环境ID，目前支持env_id和env，两个均存在时以env_id为准，建议使用env_id group_id/group 是 String API分组ID，目前支持group_id和group，两个均存在时以group_id为准，建议使用group_id define 否 String 导出API的定义范围： base：基础定义 full：全量定义 all：扩展定义 默认为base version 否 String 导出的API定义版本，默认为当前时间 type 否 String 导出的API定义的格式：json/yaml，默认为json

请求消息 表3 参数说明 参数 是否必选 类型 说明 vpc_instances 是 字典数据类型 后端实例列表。 表4 后端实例详情 参数 是否必选 类型 说明 instance_name 是 String 云服务器的名称。 支持汉字，英文，数字，“-”,“_”,“.”，1~ 64字符。 说明： 中文字符必须为UTF-8或者unicode编码。 instance_id 是 String 云服务器的ID。 支持英文，数字，“-”,“_”，1 ~ 64字符。 weight 是 Integer 权重值。 权重值越大，转发到该云服务器的请求数量越多。 取值范围1 ~ 100。 请求消息样例： { "vpc_instances": [ { "instance_id": "instance02", "instance_name": "instance_name02", "weight": 10 } ]}

响应消息 表5 参数说明 名称 类型 说明 total Integer 该VPC通道下的云服务器总数。 size Integer 本次返回的云服务器总数。 vpc_instances 字典数据类型 云服务器列表。 表6 后端实例详情 名称 类型 说明 id String 后端实例对象的编号。 vpc_id String VPC通道的编号。 status Integer 后端实例对象的状态。 instance_name String 云服务器的名称。 instance_id String 云服务器的ID。 host String 云服务器的主机地址 weight Integer 权重值。 权重值越大，转发到该云服务器的请求数量越多。 取值范围1 ~ 100。 create_time Timestamp 云服务器增加到VPC通道的时间。 响应消息样例： { "total": 2, "size": 2, "vpc_instances": [ { "instance_id": "instance02", "instance_name": "instance_name02", "host": "127.0.0.2", "weight": 10, "id": "680e42fab429447ca23b9623107523d9", "vpc_id": "c3e6a7d85d9e47be89dfcc3cd37405d7", "status": 1, "create_time": "2018-07-27T12:42:32Z" }, { "instance_id": "instance01", "instance_name": "instance_name01", "host": "127.0.0.1", "weight": 10, "id": "c3bc73605a8b400793363c87574fbad7", "vpc_id": "c3e6a7d85d9e47be89dfcc3cd37405d7", "status": 1, "create_time": "2018-07-27T12:30:48Z" } ]}

响应消息 表4 参数说明 名称 类型 说明 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 创建时间

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

请求消息 表3 参数说明 名称 是否必选 类型 说明 name 是 String API分组的名称。 长度为3 ~ 64位的字符串，字符串由中文、英文字母、数字、“_”组成，且只能以英文或中文开头。 说明： 中文字符必须为UTF-8或者unicode编码。 remark 否 String API分组描述。 长度最大不超过255个字符。 说明： 中文字符必须为UTF-8或者unicode编码。 请求消息样例： {"name": "api_group_001","remark": "分组1"}

响应消息 表4 参数说明 名称 类型 说明 id String 编号 name String 名称 status Integer 状态 sl_domain String 系统默认分配的子 域名 register_time Timestamp 创建时间 update_time Timestamp 最近修改时间 remark String 描述 on_sell_status Integer 是否已上架云商店： 1：已上架 2：未上架 3：审核中 call_limits Integer 流控时长内分组下的API的总访问次数限制，默认不限，请根据服务的负载能力自行设置 time_interval Integer 流控时长 time_unit String 流控的时间单位 url_domains 字典数据类型 分组上绑定的独立域名列表 is_default Integer 是否为默认分组，默认为非默认分组： 1：默认分组 2：非默认分组 响应消息样例： {"id": "7efb2b91-155a-4f6a-9f45-c5c95a6e4950","name": "api_group_001","status": 1,"sl_domain": "0e91b83b-0774-4e8e-b187-2d695ed4743b.apigw.example.com","remark": "分组1","register_time": "2017-12-28T11:44:53.831282304Z","update_time": "2017-12-28T11:44:53.831283436Z","on_sell_status": 2, "is_default": 2}

请求消息 表3 参数说明 参数 类型 说明 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"}

响应消息 表4 参数说明 名称 类型 说明 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"}

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

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

响应消息 表3 参数说明 名称 类型 说明 total Integer 满足条件的API总数 size Integer 本次返回的API列表长度 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","throttle_apply_id": "90f05978-06a3-4096-8bea-b5e2fa12b843","throttle_name": "throttle1","apply_time": "2017-12-29T03:01:11.138456Z","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","throttle_apply_id": "507c6a9f-8322-4dc2-8ba5-b4d74e3690d3","throttle_name": "throttle1","apply_time": "2017-12-29T03:01:11.138456Z","auth_type": "APP","req_uri": "/test"}]}

URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/throttle-bindings/binded-apis[?page_size, page_no, throttle_id, env_id, group_id, api_id,api_name] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值：group_id、env_id、throttle_id、api_id、api_name、page_size、page_no。 URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID，管理员权限可查询。 instance_id 是 String 实例ID，可从API网关控制台的专享版实例信息中获取。 throttle_id 是 String 流控策略编号 env_id 否 String 环境的ID 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 本次查询返回的列表长度 api_versions 字典数据类型 本次查询返回的API历史版本列表 表4 api_versions参数说明 参数 类型 说明 version_id String API历史版本的ID version_no String API的版本号 api_id String API编号 env_id String 发布的环境编号 env_name String 发布的环境名称 remark String 发布描述 publish_time Timestamp 发布时间 status Integer 版本状态： 1、当前生效中的版本 2、未生效的版本 响应消息样例： { "total": 1, "size": 1, "api_versions": [ { "version_id": "04c194dc7b5340ed942f2451702060da", "version_no": "20180722102526", "api_id": "acf141aa6279415088b593a4bbb55eed", "env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID", "env_name": "RELEASE", "publish_time": "2018-04-14T07:32:23Z", "status": 2 } ]}

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

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

URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1/{project_id}/apigw/instances/{instance_id}/throttle-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}/app-auths/unbinded-apis[?page_size, page_no, app_id, env_id, api_id, api_name, group_id] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值：app_id、api_id、api_name、group_id、env_id、page_size、page_no。 URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID，管理员权限可查询。 instance_id 是 String 实例ID，可从API网关控制台的专享版实例信息中获取。 app_id 是 String 应用id env_id 是 String 环境id 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所属分组的名称 remark String API描述 run_env_name String 发布的环境名 run_env_id String 发布的环境id publish_id String 发布记录的编号 auth_type String API的认证方式 req_uri String API的访问地址 响应消息样例： {"total": 1,"size": 1,"apis": [{"id": "5bbc47e2-95b0-4a56-904e-a3cdc422f8e9","name": "查询分组列表","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"}]}

URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /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策略的编号

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

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

对象模型 本节介绍环境的对象模型。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 环境管理对象模型 参数 类型 说明 操作类型 是否必选 id String 环境ID R - name String 环境名称 CUR 是 alias String 环境别名 RU - project_id String 创建环境的租户编号 - - create_time String 创建环境时间 R - remark String 描述信息 CUR 否 父主题： 环境管理（待下线）

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

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