检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
http_code 否 String 检查目标HTTP响应时,判断成功使用的HTTP响应码。取值范围为100到599之前的任意整数值,支持如下三种格式: 多个值,如:200,201,202 一系列值,如:200-299 组合值,如:201,202,210-299 protocol = http时必选
是 String 流控策略名称。 支持汉字,英文,数字,下划线,且只能以英文和汉字开头,3 ~ 64字符。 说明: 中文字符必须为UTF-8或者unicode编码。 api_call_limits 是 Integer API流量限制是指时长内一个API能够被访问的次数上限。该值不超
error 500 Lua脚本发生未知错误 联系技术支持。 APIG.0201 API request error. 400 请求格式不合法 检查请求格式是否合法。 APIG.0201 Request entity too large. 413 请求body过大(大于12M) 减小请求body大小。
ublic_key类型签名。 public_key_uri_prefix:获取public_key对应secret的uri前缀。具体uri格式为:https://{虚拟私有云访问地址}{public_key_uri_prefix}{public_key签名密钥名称}。 custom_auth_header
您可以通过调整请求参数与参数值,发送不同的请求,验证API服务。 后续操作 API调试成功后,您可以将API发布到环境,以便API调用者调用。或者出于API的安全性考虑,为API添加策略。 父主题: 开放API
支持英文,数字,下划线,且只能以英文字母开头,3 ~ 64字符。 remark 否 String 描述信息 字符长度不能大于255 说明: 中文字符必须为UTF-8或者unicode编码。 请求消息样例: { "name": "DEV", "remark": "开发环境" } 响应消息 表3 参数说明
环境的编号,即:API需要发布到哪个环境 remark 否 String 对本次发布动作的简述 字符长度不超过255 说明: 中文字符必须为UTF-8或者unicode编码。 请求消息样例: { "env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID", "remark":
目前API网关为APP认证提供了Java、Python、C、PHP、Go等多种语言的SDK与demo。 当您使用iOS系统(Objective-C语言)或者其他未包含在内的语言时,请参考APP认证工作原理的指导进行APP认证。 父主题: 调用API
在“标签”页签中,单击“添加标签”。 标签由键和值组成,值可以为空。 标签键:支持可用UTF-8格式表示的字母(包含中文)、数字和空格,以及: _ . : = + - @字符; _sys_开头属于系统标签,租户不能输入。 标签值:支持可用UTF-8格式表示的字母(包含中文)、数字和空格,以及: _ . : = +
、自定义认证等扩展定义 dev:开发定义,包括未发布的api的前后端定义 缺省值:spec type 否 String 导出的API定义的格式 缺省值:json version 否 String 导出的API定义版本,默认为当前时间 apis 否 Array of strings
规格变更时,出私网IP会发生变化,如有相关防火墙配置或者白名单配置需要提前放通,防止网络问题导致业务受损!期间请勿对实例进行任何操作! API 表2 API约束与限制 限制项 约束与限制 API分组 一个API只能属于一个API分组。 SSL证书 仅支持添加pem编码格式的SSL证书。 添加的SSL证书仅支持RSA、ECDSA加密算法。
证书名称。 长度为4 ~ 50位的字符串,字符串由中文、英文字母、数字、"_"组成,且只能以英文或中文开头。 说明: 中文字符必须为UTF-8或者unicode编码。 cert_content 是 String 证书内容。 private_key 是 String 私钥内容。 请求消息样例:
3 ~ 64字符。 说明: 中文字符必须为UTF-8或者unicode编码。 time_unit String 流控的时间单位 remark String 流控策略描述字符长度不超过255。 说明: 中文字符必须为UTF-8或者unicode编码。 api_call_limits
ENTERPRISE_IPV6:企业版IPV6实例 PLATINUM_IPV6:铂金版IPV6实例 create_time Long 实例创建时间。unix时间戳格式。 enterprise_project_id String 企业项目ID,企业账号必填 eip_address String 实例绑定的弹性IP地址
API可以绑定内网域名吗? 对于共享版,域名必须完成备案,并将其CNAME解析到API分组对应的子域名。不能将无法在公网访问的域名,或者将他人所有的域名绑定给API分组。 对于专享版,可以配置内网域名,域名不需要备案,并将A记录解析到实例的入口地址。 父主题: 开放API
支持英文,数字,下划线,且只能以英文字母开头,3 ~ 64字符。 remark 否 String 描述信息 字符长度不能大于255 说明: 中文字符必须为UTF-8或者unicode编码。 请求消息样例: { "name": "DEV", "remark": "开发环境" } 响应消息 表4 参数说明
、自定义认证等扩展定义 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
String 签名密钥的名称。 支持汉字,英文,数字,下划线,且只能以英文和汉字开头,3 ~ 64字符。 说明: 中文字符必须为UTF-8或者unicode编码。 sign_key 否 String 签名密钥的key。 支持英文,数字,下划线,中划线,且只能以数字或英文字母开头,8