检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
息体类型的请求头“Content-Type”,请求鉴权信息等。 如下公共消息头需要添加到请求中。 Content-Type:消息体的类型(格式),必选,默认取值为“application/json”,有其他取值时会在具体接口中专门说明。 X-Sdk-Date:请求发送的时间,可选
响应Body参数 参数 参数类型 描述 name String API名称。 支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号,且只能以英文、汉字和数字开头,3-255个字符。 说明: 中文字符必须为UTF-8或者unicode编码。 type
http_code 否 String 检查目标HTTP响应时,判断成功使用的HTTP响应码。取值范围为100到599之前的任意整数值,支持如下三种格式: 多个值,如:200,201,202 一系列值,如:200-299 组合值,如:201,202,210-299 protocol = http时必选
、自定义认证等扩展定义 dev:开发定义,包括未发布的api的前后端定义 缺省值:spec type 否 String 导出的API定义的格式 缺省值:json version 否 String 导出的API定义版本,默认为当前时间 apis 否 Array of strings
是否必选 参数类型 描述 name 是 String API分组的名称。 支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号,且只能以英文、汉字和数字开头,3-255个字符。 说明: 中文字符必须为UTF-8或者unicode编码。 最小长度:3
、自定义认证等扩展定义 dev:开发定义,包括未发布的api的前后端定义 缺省值:spec type 否 String 导出的API定义的格式 缺省值:json version 否 String 导出的API定义版本,默认为当前时间 apis 否 Array of strings
override:当API信息定义冲突时,override会覆盖原有API信息 缺省值:merge file_name 是 File 导入Api的请求体,json或yaml格式的文件 响应参数 状态码: 202 表4 响应Body参数 参数 参数类型 描述 task_id String 任务id 状态码: 400
条目数量大于500时,自动转换为500 最小值:1 最大值:500 缺省值:20 permission 否 String 权限账号ID,格式为“iam:domain::domain_id”,支持模糊搜索 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
同,使用时请注意。 客户端必须注意本地时间与时钟服务器的同步,避免请求消息头X-Sdk-Date的值出现较大误差。 API网关除了校验时间格式外,还会校验该时间值与网关收到请求的时间差,如果时间差大于15分钟,API网关将拒绝请求。 您也可以通过这个视频教程了解AK/SK认证的使用:https://bbs
是否必选 参数类型 描述 name 是 String API分组的名称。 支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号,且只能以英文、汉字和数字开头,3-255个字符。 说明: 中文字符必须为UTF-8或者unicode编码。 最小长度:3
ENTERPRISE_IPV6:企业版IPV6实例 PLATINUM_IPV6:铂金版IPV6实例 create_time Long 实例创建时间。unix时间戳格式。 enterprise_project_id String 企业项目ID,企业账号必填 eip_address String 实例绑定的弹性IP地址
ocol buffers)作为其接口定义语言(Interface Definition Language,缩写IDL),同时底层的消息交换格式也是使用protobuf。下表列出了GRPC API与REST API的区别: 表1 GRPC VS REST 参数 GRPC REST 消息编码
访问控制 API网关提供实例级的访问控制策略,您可以通过设置IP地址的黑白名单来禁止/允许某个IP地址访问实例。IP地址说明如下: 常规IP格式,如:127.0.0.1、::1 IP加掩码,如:192.145.0.0/16、2407:c080:17ef:ffff::3104:703a/64
提供默认的网关响应(default),如果您需要自定义响应状态码或网关响应内容,可在API分组管理中新增网关响应,其中响应内容符合JSON格式即可。
镜像请求协议。指定的镜像服务协议须与用户的镜像业务协议保持一致。 镜像地址 镜像服务的地址。由IP/域名和端口号组成,总长度不超过255。格式为主机:端口(如:xxx.xxx.xxx:7443)。如果不写端口号,那么HTTPS默认端口号为443,HTTP默认端口号为80。 镜像请求路径
参数 是否必选 参数类型 描述 name 是 String API名称。 支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号,且只能以英文、汉字和数字开头,3-255个字符。 说明: 中文字符必须为UTF-8或者unicode编码。 type
ApiInfoPerPage 参数 参数类型 描述 name String API名称。 支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号,且只能以英文、汉字和数字开头,3-255个字符。 说明: 中文字符必须为UTF-8或者unicode编码。 type
http_code String 检查目标HTTP响应时,判断成功使用的HTTP响应码。 取值范围为100到599之前的任意整数值,支持如下三种格式: 多个值,如:200,201,202 一系列值,如:200-299 组合值,如:201,202,210-299 create_time Timestamp
响应Body参数 参数 参数类型 描述 name String API名称。 支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号,且只能以英文、汉字和数字开头,3-255个字符。 说明: 中文字符必须为UTF-8或者unicode编码。 type
CONSUMER API分组的子域名 path 是 String API的请求路径,需以"/"开头,最大长度1024 说明: 须符合路径规范,百分号编码格式可被正确解码 query 否 字典数据类型 查询参数,每个参数值为字符串数组,每个参数名称有如下约束: 英文字母、数字、点、下划线、中连线组成