检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
请求Body参数 参数 是否必选 参数类型 描述 name 是 String API分组的名称。 支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号,且只能以英文、汉字和数字开头,3-255个字符。 说明: 中文字符必须为UTF-8或者unicode编码。
path String 健康检查时的目标路径。protocol = http或https时必选 method String 健康检查时的请求方法 缺省值:GET port Integer 健康检查的目标端口,缺少或port = 0时为VPC中主机的端口号。 如果此端口存在非0值,则使用此端口进行健康检查。
实例ID,可从API网关控制台的专享版实例信息中获取。 env_id/env 是 String API分组发布的环境ID,目前支持env_id和env,两个均存在时以env_id为准,建议使用env_id group_id/group 是 String API分组ID,目前支持group_id和grou
define 否 String 导出API的定义范围: base:基础定义 full:全量定义 all:扩展定义 默认为base version 否 String 导出的API定义版本,默认为当前时间 type 否 String 导出的API定义的格式:json/yaml,默认为json
domain has been bound. url中的分组id和url中的域名绑定的分组id不匹配 URL中的分组与域名绑定的分组修改为一致 404 APIC.7301 Instance spec not found 实例规格不存在 使用存在的实例规格 404 APIC.7302 Instance
E操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于创建API分组接口,您可以从接口的请求部分看到所需的请求参数及参数说明,将消息体加入后的请求如下所示,其中加粗的字段需要根据实际值填写。 name为API分组的名称。 remark为API分组的描述。 POST
获取方法如下: 方法1:登录虚拟私有云服务的控制台界面,在虚拟私有云的详情页面查找VPC ID。 方法2:通过虚拟私有云服务的API接口查询,具体方法请参见《虚拟私有云服务API参考》的“查询VPC列表”章节。 subnet_id 是 String 子网的网络ID。 获取方法如下: 方法1
method参数说明 名称 是否必选 参数类型 说明 operationId 否 String API的名称 description 否 String API的描述信息 schemes 否 Object API的请求协议对象数组定义,支持http、https tags 否 Object API标签对象数组定义
将签名密钥绑定到API后,则API网关请求后端服务时就会使用这个签名密钥进行加密签名,后端服务可以校验这个签名来验证请求来源。 将指定的签名密钥绑定到一个或多个已发布的API上。同一个API发布到不同的环境可以绑定不同的签名密钥;一个API在发布到特定环境后只能绑定一个签名密钥。 调用方法 请参见如何调用API。 URI
call_limits Integer 流控时长内分组下的API的总访问次数限制,默认不限,请根据服务的负载能力自行设置 暂不支持 time_interval Integer 流控时长 暂不支持 time_unit String 流控的时间单位 暂不支持 is_default Integer
method参数说明 名称 是否必选 参数类型 说明 operationId 否 String API的名称 description 否 String API的描述信息 schemes 否 Object API的请求协议对象数组定义,支持http、https tags 否 Object API标签对象数组定义
是否必选 参数类型 描述 key 否 String 分组自定义响应的响应头的key,支持英文字母、数字和中划线,长度为1到128位 value 否 String 分组自定义响应的响应头的value,为长度为1到1024位的字符串 最小长度:1 最大长度:1024 响应参数 状态码: 201
获取方法如下: 方法1:登录虚拟私有云服务的控制台界面,在虚拟私有云的详情页面查找VPC ID。 方法2:通过虚拟私有云服务的API接口查询,具体方法请参见《虚拟私有云服务API参考》的“查询VPC列表”章节。 subnet_id 是 String 子网的网络ID。 获取方法如下: 方法1
方法1:登录虚拟私有云服务的控制台界面,在虚拟私有云的详情页面查找VPC ID。 方法2:通过虚拟私有云服务的API接口查询,具体方法请参见《虚拟私有云服务API参考》的“查询VPC列表”章节。 subnet_id String 子网的网络ID。 获取方法如下: 方法1:登录虚拟私有云服务的控制台界
API分组发布的环境ID,目前支持env_id和env,两个均存在时以env_id为准,建议使用env_id define 否 String 导出API的定义范围: base:基础定义 full:全量定义 all:扩展定义 默认为base version 否 String 导出的API定义版本,默认为当前时间
URI中的参数说明如下表所示。 表2 参数说明 参数 是否必选 类型 说明 env_id/env 是 String API分组发布的环境ID,目前支持env_id和env,两个均存在时以env_id为准,建议使用env_id define 否 String 导出API的定义范围:
是否必选 参数类型 描述 key 否 String 分组自定义响应的响应头的key,支持英文字母、数字和中划线,长度为1到128位 value 否 String 分组自定义响应的响应头的value,为长度为1到1024位的字符串 最小长度:1 最大长度:1024 响应参数 状态码: 200
call_limits Integer 流控时长内分组下的API的总访问次数限制,默认不限,请根据服务的负载能力自行设置 暂不支持 time_interval Integer 流控时长 暂不支持 time_unit String 流控的时间单位 暂不支持 is_default Integer
实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数
ResponseInfoHeader 参数 参数类型 描述 key String 分组自定义响应的响应头的key,支持英文字母、数字和中划线,长度为1到128位 value String 分组自定义响应的响应头的value,为长度为1到1024位的字符串 最小长度:1 最大长度:1024 状态码: 400 表8