检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
删除环境 功能介绍 删除指定的环境。 该操作将导致此API在指定的环境无法被访问，可能会影响相当一部分应用和用户。请确保已经告知用户，或者确认需要强制下线。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI
查询API概况 功能介绍 查询租户名下的API概况：已发布到RELEASE环境的API个数，未发布到RELEASE环境的API个数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/a
查询APP概况 功能介绍 查询租户名下的APP概况：已进行API访问授权的APP个数，未进行API访问授权的APP个数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/r
绑定域名 功能介绍 用户自定义的域名，需要CNAME到API分组的子域名上才能生效，具体方法请参见增加CNAME类型记录集。 每个API分组下最多可绑定5个域名。绑定域名后，用户可通过自定义域名调用API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
创建App Code 功能介绍 App Code为APP应用下的子模块，创建App Code之后，可以实现简易的APP认证。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apig
查看API详情 功能介绍 查看指定的API的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apis/{id} URI中的参数说明如下表所示。 表2 参数说明 名称
查看APP详情 功能介绍 查看指定APP的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apps/{id} URI中的参数说明如下表所示。 表2 参数说明 名称
对象模型 本节介绍APP与API之间的授权关系的对象模型，如下表所示。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 APP授权关系对象模型 参数
解除授权 功能介绍 解除API对APP的授权关系。解除授权后，APP将不再能够调用该API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/app-auths/{id}
修改环境 功能介绍 修改指定环境的信息。其中可修改的属性为：name、remark，其它属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/envs/{id} URI中的参数说明如下表所示。
对象模型 API发布后，如果不想API被某些IP地址访问到，可以将这些IP地址加入黑名单，或者想API被某些特性的IP地址访问到，也可以将这些IP地址加入白名单。这样可以提高API的访问安全性，保护API免受攻击。本节介绍API的黑白名单（ACL策略）管理的对象模型，如表1 ACL策略对象模型所示。
对象模型 管理系统的默认配置，管理租户可以根据系统的实际运行情况对这些配置的值进行修改。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 系统配置对象模型
分页显示查询结果 查询资源列表时（例如，查询API列表），系统支持分页显示查询结果。 在url后面拼接如下参数： page_size：每页查询多少条数据，如果不指定，默认20，最大值500。 page_no：需要查询的页码。 示例： GET /v1.0/apigw/apis?pa
删除App Code 功能介绍 删除App Code，App Code删除后，将无法再通过简易认证访问对应的API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/
API概览 API网关专享版接口的分类与说明如表1所示，API网关共享版接口的分类与说明如表2所示。 表1 专享版API概览 类型 说明 API分组管理 包括API分组的创建、修改、删除、查询详情和列表等接口。 环境管理 包括环境的创建、修改、删除和查询列表等接口。 环境变量管理
创建环境和环境变量 操作场景 API可以同时提供给不同的环境调用，如生产、测试或开发。RELEASE是默认存在的环境，无需创建。且API网关提供环境变量功能，通过创建环境变量，实现在不同的环境定义不同的API调用路径。 环境变量是指在环境上创建可管理的一种变量，该变量固定在环境上
绑定域名证书 功能介绍 如果创建API时，“定义API请求”使用HTTPS请求协议，那么在独立域名中需要添加SSL证书。 本章节主要介绍为特定域名绑定证书。 URI HTTP/HTTPS请求方法以及URI如下表所示 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST
创建VPC通道 功能介绍 在API网关中创建连接私有VPC资源的通道，并在创建API时将后端节点配置为使用这些VPC通道，以便API网关直接访问私有VPC资源。 每个用户最多创建30个VPC通道。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
更新VPC通道 功能介绍 更新指定VPC通道的参数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/vpc-channels/{id} URI中的参数说明如下表所示。 表2
删除VPC通道 功能介绍 删除指定的VPC通道。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/vpc-channels/{id} URI中的参数说明如下表所示。 表2
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
