检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
APIG最佳实践汇总 本文汇总了基于API网关服务（APIG，APIGateway）常见应用场景的操作实践，为每个实践提供详细的方案描述和操作指导，帮助用户轻松构建基于APIG的业务。 表1 APIG最佳实践一览表 最佳实践 说明 使用APIG专享版开放云容器引擎CCE工作负载 云容器引擎（Cloud
校验APP是否存在，非APP所有者可以调用该接口校验APP是否真实存在。这个接口只展示app的基本信息id 、name、 remark，其他信息不显示。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apps/validation/{id}
云商店订购信息查询 查询已购买的API分组列表 查询分组详情 查询已购买的API列表 父主题： 共享版API（仅存量用户使用）
新建变量 功能介绍 将API发布到不同的环境后，对于不同的环境，可能会有不同的环境变量，比如，API的服务部署地址，请求的版本号等。 用户可以定义不同的环境变量，用户在定义API时，在API的定义中使用这些变量，当调用API时，API网关会将这些变量替换成真实的变量值，以达到不同环境的区分效果。
功能介绍 查询API分组列表。 如果是租户操作，则查询该租户下所有的分组；如果是管理租户操作，则查询的是所有租户的分组。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/api-groups[
Integer 满足查询条件的API总数 size Integer 本次查询返回的API个数 apis 字典数据类型 本次查询返回的API列表 表4 apis参数说明 参数 类型 说明 id String API编号 name String API名称 purchase_id String
String API分组编号 R - NAME String API分组名称 CRU 是 STATUS Integer API分组状态 1 正常状态 2 禁用状态 3 已删除 默认值1 该字段暂时废弃 R - SL_DOMAIN String API分组的子域名，由API网关分配，用户不可填写和修改
将API与ACL策略进行绑定 功能介绍 将API与ACL策略进行绑定。 同一个API发布到不同的环境可以绑定不同的ACL策略；一个API在发布到特定环境后只能绑定一个同一种类型的ACL策略。 URI HTTPS请求方法以及URI如下表所示。 表1 HTTPS请求方法以及URI 请求方法
API调用对请求的响应消息体限制 API调用对请求的响应体大小没有限制。 API调用对请求的请求体大小有限制。详细指导请参考request_body_size。 父主题： 调用API
String 解除绑定失败的错误码 error_msg String 解除绑定失败的错误信息 api_id String 解除绑定失败的API的ID api_name String 解除绑定失败的API的名称 响应消息样例： { "failure": [{ "bind_id": "
创建VPC通道 功能介绍 在API网关中创建连接私有VPC资源的通道，并在创建API时将后端节点配置为使用这些VPC通道，以便API网关直接访问私有VPC资源。 每个用户最多创建30个VPC通道。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
启/关闭客户端校验会对相同域名的不同端口同时生效。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id} 表1
过滤查询结果 查询资源列表时（例如，查询API列表），系统支持按照查询对象的属性过滤查询结果。 示例： GET /v1.0/apigw/apis?id=xxxx 父主题： 附录
删除指定的APP。 APP删除后，将无法再调用任何API；其中，云商店自动创建的APP无法被删除。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/apps/{id} URI中的参数说明如下表所示。
请求方法 URI POST /v1.0/apigw/app-auths 请求消息 表2 参数说明 名称 是否必选 类型 说明 api_ids 是 Array of strings API的编号列表 可以选择租户自己的API，也可以选择从云商店上购买的API。 app_ids 是 Array
HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/apps/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String APP的编号，可通过查询APP列表获取。
解除授权 功能介绍 解除API对APP的授权关系。解除授权后，APP将不再能够调用该API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/app-auths/{id}
Integer 绑定的API总数 size Integer 本次查询返回的API数量 apis 字典数据类型 本次查询返回的API列表 表4 apis参数说明 名称 类型 说明 api_id String API编号 api_name String API名称 group_name
APP即应用，是一个可以访问API的身份标识。将API授权给APP后，APP即可调用API。 创建一个APP。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/apps 请求消息
校验APP 功能介绍 校验APP是否存在，非APP所有者可以调用该接口校验APP是否真实存在。这个接口只展示app的基本信息id 、name、 remark，其他信息不显示。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
