检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建API 操作场景 API提供者把API接口配置在API网关中，开放后端能力。 创建API主要分为四个步骤：设置基本信息、定义API请求、定义后端服务和定义返回结果。 API网关服务基于REST的API架构，API的开放和调用需要遵循RESTful相关规范。 前提条件 已创建A
HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/signs/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String 签名密钥的ID。
HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/acls 请求消息 表2 参数说明 参数 类型 说明 acl_name String ACL策略名称。 支持汉字，英文，数字，下划线，且只能以英文和汉字开头，3
HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/vpc-channels/{id} URI中的参数说明如下表所示。 表2 参数说明 名称
创建流控策略 功能介绍 当API上线后，系统会默认给每个API提供一个流控策略，API提供者可以根据自身API的服务能力及负载情况变更这个流控策略。 流控策略即限制API在一定长度的时间内，能够允许被访问的最大次数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1
对象模型 本节介绍签名密钥与API的绑定关系的对象模型，如下表所示。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 签名密钥与API绑定关系对象模型 参数
对象模型 本节介绍VPC通道的对象模型。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 VPC通道对象模型 参数 类型 说明 操作类型 是否必选
解除绑定 功能介绍 解除API与签名密钥的绑定关系。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/sign-bindings/{id} URI中的参数说明如下表所示。
String 解除绑定失败的错误码 error_msg String 解除绑定失败的错误信息 api_id String 解除绑定失败的API的ID api_name String 解除绑定失败的API的名称 响应消息样例： { "failure": [{ "bind_id": "
HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/env-variables[?page_size, page_no, env_id, group_id, variable_name]
发布APIG创建的API 创建完成的API，支持发布到不同的环境。API只有在发布到环境后，才支持被调用。API网关支持查看API发布历史（如版本、发布说明、发布时间和发布环境），并支持回滚到不同的API历史版本。 约束与限制 已发布的API，在修改信息后，需要重新发布才能将修改后的信息同步到环境中。
获取账号名和账号名ID 在调用接口的时候，部分URL中需要填入账号名和账号ID，所以需要先在管理控制台上获取到账号名和账号ID。账号名和账号ID获取步骤如下： 登录管理控制台。 将鼠标移至用户名，在下拉列表中单击“我的凭证”。 查看账号名和账号ID。 父主题： 附录
创建特殊设置 功能介绍 流控策略可以限制一段时间内可以访问API的最大次数，也可以限制一段时间内单个租户和单个APP可以访问API的最大次数。 如果想要对某个特定的APP进行特殊设置，例如设置所有APP每分钟的访问次数为500次，但想设置APP1每分钟的访问次数为800次，可以通
功能介绍 删除指定的ACL策略， 如果存在api与该ACL策略的绑定关系，则无法删除 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/acls/{id} URI中的参数说明如下表所示。
将API与ACL策略进行绑定 功能介绍 将API与ACL策略进行绑定。 同一个API发布到不同的环境可以绑定不同的ACL策略；一个API在发布到特定环境后只能绑定一个同一种类型的ACL策略。 URI HTTPS请求方法以及URI如下表所示。 表1 HTTPS请求方法以及URI 请求方法
功能介绍 删除指定的流控策略，以及该流控策略与API的所有绑定关系。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1/{project_id}/apigw/instances/{instan
Integer 绑定的API总数 size Integer 本次查询返回的API数量 apis 字典数据类型 本次查询返回的API列表 表4 apis参数说明 名称 类型 说明 api_id String API编号 api_name String API名称 group_name
HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id}/certificate/{id}
是 String 实例ID，可从API网关控制台的专享版实例信息中获取。 id 是 String 特殊配置的编号 请求消息 表3 参数说明 参数 是否必选 类型 说明 call_limits 是 Integer 特殊对象在流控时间内能够调用API的最大次数限制 请求消息样例： {
实例ID，可从API网关控制台的专享版实例信息中获取。 id 是 String 环境变量的编号 请求消息 无 响应消息 表3 参数说明 参数 类型 说明 id String 环境变量的编号 env_id String 环境编号 group_id String API分组编号 variable_name
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
