检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
strategy_id String 流控策略编号 CR 是 instance_id String 生效的特殊对象的编号 CR 是 instance_type String 对象类型APP/USER CR 是 call_limits Integer 特殊对象在流控时间内能够访问API
删除ACL策略 功能介绍 删除指定的ACL策略, 如果存在api与该ACL策略的绑定关系,则无法删除 URI HTTP/HTTPS请求方法以及URI如下表所示。
绑定域名证书 功能介绍 如果创建API时,“定义API请求”使用HTTPS请求协议,那么在独立域名中需要添加SSL证书。 本章节主要介绍为特定域名绑定证书。
创建VPC通道 功能介绍 在API网关中创建连接私有VPC资源的通道,并在创建API时将后端节点配置为使用这些VPC通道,以便API网关直接访问私有VPC资源。 每个用户最多创建30个VPC通道。 URI HTTP/HTTPS请求方法以及URI如下表所示。
2:API网关内置支持负载均衡功能的快速通道类型 member_type type = 2时必选 String VPC通道的成员类型。 ip(暂不支持) instance 仅VPC通道类型为2时有效,缺省为instance。
表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/vpc-channels/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String VPC通道的编号。
查询API历史版本列表 功能介绍 查询某个API的历史版本。每个API在一个环境上最多存在10个历史版本。 URI HTTP/HTTPS请求方法以及URI如下表所示。
查询API概况 功能介绍 查询租户名下的API概况:已发布到RELEASE环境的API个数,未发布到RELEASE环境的API个数。 URI HTTP/HTTPS请求方法以及URI如下表所示。
表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/apps/{app_id}/app-codes URI中的参数说明如下表所示。
status Integer API的状态 type Integer API类型 version String API版本 req_protocol String API访问协议 req_method String API请求方式 req_uri String API访问地址 auth_type
删除App Code 功能介绍 删除App Code,App Code删除后,将无法再通过简易认证访问对应的API。 URI HTTP/HTTPS请求方法以及URI如下表所示。
修改API分组 功能介绍 修改API分组属性。其中name和remark可修改,其他属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。
否 Boolean 是否支持跨域 x-apigateway-match-mode 否 String API的匹配方式 x-apigateway-ratelimit 否 String API绑定的流量控制名称 x-apigateway-request-type 否 String API
表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/apps/{app_id}/app-codes URI中的参数说明如下表所示。
instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。
API的定义分为临时定义和运行时定义,分别代表如下含义: 临时定义:API在编辑中的定义,表示用户最后一次编辑后的API的状态 运行时定义:API在发布到某个环境时,对发布时的API的临时定义进行快照,固化出来的API的状态。
表1 环境变量对象模型 参数 类型 说明 操作类型 是否必选 id String 环境变量编号 R - env_id String 环境编号 CR 是 group_id String API分组编号 CR 是 variable_name String 变量名 CR 是 variable_value
用户可以定义不同的环境变量,用户在定义API时,在API的定义中使用这些变量,当调用API时,API网关会将这些变量替换成真实的变量值,以达到不同环境的区分效果。 环境变量定义在API分组上,该分组下的所有API都可以使用这些变量。
表1 HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/acls/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String ACL策略的编号。可通过查询ACL信息获取该ID。
解绑域名 功能介绍 如果API分组不再需要绑定某个自定义域名,则可以为此API分组解绑此域名。