检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API的编号 请求消息 表3 参数说明 参数 是否必选 类型 说明 env_id 是 String 环境的编号,即:API需要发布到哪个环境 remark 否 String 对本次发布动作的简述 字符长度不超过255 说明: 中文字符必须为UTF-8或者unicode编码。 请求消息样例: {
已购买API 操作场景 API网关共享版支持查看已购买的API,明确已购买服务的详情。并通过调试API,验证服务是否正常。 已购买的API,需要通过APP认证方式调用。 前提条件 已从云商店购买了API。 操作步骤 进入共享版控制台。 单击“调用API > 已购买API”,进入到已购买API分组信息页面。
x-apigateway-backend.mockEndpoints 含义:API网关定义的MOCK类型API后端服务定义。 作用域:x-apigateway-backend 示例: paths: '/users/{userId}': get: produces:
type" 表1 参数说明 参数 是否必选 类型 说明 x-apigateway-backend 是 String API后端服务定义 type 是 String 后端服务类型,支持HTTP、HTTP-VPC、FUNCTION、MOCK parameters 否 x-apigateway-backend
charset=utf-8。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于创建API分组接口,您可以从接口的请求部分看到所需的请求参数及参数说明,将消息体加入后的请求如下所示,其中加粗的字段需要根据实际值填写。
长度最大不超过255个字符。 说明: 中文字符必须为UTF-8或者unicode编码。 请求消息样例: { "name": "api_group_001", "remark": "分组1" } 响应消息 表3 参数说明 名称 类型 说明 id String 编号 name String
创建流控策略 功能介绍 当API上线后,系统会默认给每个API提供一个流控策略,API提供者可以根据自身API的服务能力及负载情况变更这个流控策略。 流控策略即限制API在一定长度的时间内,能够允许被访问的最大次数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1
x-apigateway-backend.httpVpcEndpoints 含义:API网关定义的HTTP VPC类型API后端服务定义。 作用域:x-apigateway-backend 示例: paths: '/users/{userId}': get:
只支持部分region自定义。 请求消息样例: { "name": "app_001", "remark": "第一个APP", "app_key": "app_key_sample", "app_secret": "app_secret_sample" } 响应消息 表4
只支持部分region自定义。 请求消息样例: { "name": "app_001", "remark": "第一个APP", "app_key": "app_key_sample", "app_secret": "app_secret_sample" } 响应消息 表4
中获取。 action 是 String 必须为delete 请求消息 表3 参数说明 参数 是否必选 类型 说明 acl_bindings 否 String Array 需要解除绑定的ACL策略ID列表 请求消息样例: { "acl_bindings": ["81efc
String 实例ID,可从API网关控制台的专享版实例信息中获取。 请求消息 表3 参数说明 参数 类型 说明 acl_id String ACL策略编号 publish_ids []String API发布记录编号 请求消息样例: { "acl_id": "206bb985d8a04
private_key 是 String 私钥内容。 请求消息样例: { "cert_content": "example", "name": "test_ssl", "private_key": "example" } 响应消息 表4 参数说明 名称 类型 说明 id String
private_key 是 String 私钥内容。 请求消息样例: { "cert_content": "example", "name": "test_ssl", "private_key": "example" } 响应消息 表4 参数说明 名称 类型 说明 id String
开启后对应后端服务为备用节点,仅当非备用节点全部故障时工作。 实例需要升级到对应版本才支持此功能,如果不支持请联系技术支持。 缺省值:false member_group_name 否 String 后端服务器组名称。为后端服务地址选择服务器组,便于统一修改对应服务器组的后端地址。
分组的编号 请求消息 表3 参数说明 参数 是否必选 类型 说明 url_domain 是 String 自定义域名。 长度为0-255位的字符串,需要符合域名规范。 请求消息样例: { "url_domain": "www.MyCompany.com" } 响应消息 表4 参数说明
on下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 请求消息 表3 参数说明 参数 是否必选 类型 说明 name 是 String VPC通道的名称。 长度为3 ~ 64位的字符串,字符串由中文、
HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/acls 请求消息 表2 参数说明 参数 类型 说明 acl_name String ACL策略名称。 支持汉字,英文,数字,下划线,且只能以英文和汉字开头,3
创建流控策略 功能介绍 当API上线后,系统会默认给每个API提供一个流控策略,API提供者可以根据自身API的服务能力及负载情况变更这个流控策略。 流控策略即限制API在一定长度的时间内,能够允许被访问的最大次数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1
分组的编号 请求消息 表3 参数说明 参数 是否必选 类型 说明 url_domain 是 String 自定义域名。 长度为0-255位的字符串,需要符合域名规范。 请求消息样例: { "url_domain": "www.MyCompany.com" } 响应消息 表4 参数说明