检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API格式的API文档定义。 全量定义:包括API前端请求定义、后端服务定义和响应定义。适用于将API定义备份为Swagger或OpenAPI文件。 扩展定义:包括API前端请求定义、后端服务定义和响应定义,还包括API关联的流量控制、访问控制等策略对象的定义。 导出格式 选择JSON、YAML或YML。
后端服务调用失败“Backend unavailable”或超时“Backend timeout”原因分析 以下原因可能导致后端服务调用失败或者超时,请逐一排查。 原因 解决方案 后端服务地址错误。 在编辑API中修改后端服务地址。 如果是域名,请确认域名能正确解析到后端服务IP地址。
x-apigateway-auth-type 含义:基于Swagger的apiKey认证格式,定义API网关支持的特有认证方式。 作用域:Security Scheme Object(2.0)/Security Scheme Object(3.0) Swagger: securityDefinitions:
req_count_error Integer 错误次数 R register_time String 记录时间(格式为:yyyy-MM-dd HH:mm:ss) R req_time String 请求时间(格式为:yyyy-MM-dd HH:mm:ss) R 响应消息样例: { "code": "000000"
Url=https://c967a237-cd6c-470e-906f-a8655461897e.apigw.exampleRegion.com 填入json格式的Query和Headers,填入Body。 单击“Send request”,生成curl命令。将curl命令复制到命令行,访问API。
升级到“专业版”或者铂金版,并且对现有业务没有影响。 实例版本单价,请参考价格详情中的包年/包月计费价格。 包年/包月计费。 版本实例价格x购买个数+公网带宽单价x实际使用时长x实例个数 购买时长(月或年) 使用API网关实例的时间长度,支持使用1~9个月,或者1~3年。 购买个数(个)
果没有可选的负载通道,您也可以单击“新建负载通道”创建。 后端服务地址(可选) 仅在不使用负载通道时,需要设置。 填写鉴权服务的访问地址,格式:“主机:端口”。主机为鉴权服务的访问IP地址/域名,未指定端口时,HTTP协议默认使用80端口,HTTPS协议默认使用443端口。 说明:
error_msg String 实例创建失败错误信息 start_time Long 实例创建开始时间。unix时间戳格式。 end_time Long 实例创建结束时间。unix时间戳格式。 状态码: 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码
导出API 操作场景 导出JSON或YAML格式的API。API网关支持单个API导出和批量API导出。 云商店购买的API不支持导出。 前提条件 已创建API分组和API。 操作步骤 进入共享版控制台。 单击“导出API”,进入“导出API”界面。 设置如表1所示参数。 图1 导出API
Integer 连接报文标识 created_at String 连接创建时间。UTC时间,格式:YYYY-MM-DDTHH:MM:SSZ updated_at String 连接更新时间。UTC时间,格式:YYYY-MM-DDTHH:MM:SSZ domain_id String 用户的Domain
动续费3个月。 在实例到期前均可开通自动续费,到期前7日凌晨3:00首次尝试自动续费,如果扣款失败,每天凌晨3:00尝试一次,直至实例到期或者续费成功。 开通自动续费后,还可以手动续费该实例。手动续费后,自动续费仍然有效,在新的到期时间前的第7天开始扣款。 自动续费的到期前7日自
提供默认的网关响应(default),如果您需要自定义响应状态码或网关响应内容,可在API分组管理中新增网关响应,其中响应内容符合JSON格式即可。 例如,“default”网关的响应内容为: {"error_code": "$context.error.code", "error_msg":
请求Body参数 参数 是否必选 参数类型 描述 permissions 是 Array of strings 白名单记录列表。每个白名单记录的格式为iam:domain::授权账号ID。 其中,授权账号ID是长度为32的字符串,只包含英文字母(a-f)或数字;也可为*,表示允许全部用户连接。
请求Body参数 参数 是否必选 参数类型 描述 permissions 是 Array of strings 白名单记录列表。每个白名单记录的格式为iam:domain::授权账号ID。 其中,授权账号ID是长度为32的字符串,只包含英文字母(a-f)或数字;也可为*,表示允许全部用户连接。
字、“_”组成,且只能以中文或英文开头。 说明: 中文字符必须为UTF-8或者unicode编码。 remark 否 String 描述。 字符串长度最大不超过255。 说明: 中文字符必须为UTF-8或者unicode编码。 请求消息样例: { "name": "api_group_001"
_”组成,且只能以英文或中文开头。 说明: 中文字符必须为UTF-8或者unicode编码。 remark 否 String API分组描述。 长度最大不超过255个字符。 说明: 中文字符必须为UTF-8或者unicode编码。 请求消息样例: { "name": "api_group_001"
_”组成,且只能以英文或中文开头。 说明: 中文字符必须为UTF-8或者unicode编码。 remark 否 String API分组描述。 长度最大不超过255个字符。 说明: 中文字符必须为UTF-8或者unicode编码。 请求消息样例: { "name": "api_group_001"
支持汉字,英文,数字,“_”,且只能以英文和汉字开头,3 ~ 64个字符。 说明: 中文字符必须为UTF-8或者unicode编码。 remark 否 String APP描述。 字符长度不能大于255 说明: 中文字符必须为UTF-8或者unicode编码。 app_key 否 String APP的key 支持英文,数字,“_”
Integer 连接报文标识 created_at String 连接创建时间。UTC时间,格式:YYYY-MM-DDTHH:MM:SSZ updated_at String 连接更新时间。UTC时间,格式:YYYY-MM-DDTHH:MM:SSZ domain_id String 用户的Domain
label_name 是 String 标签名称。 以字母或者数字开头和结尾,由字母、数字、连接符('-')、下划线('_')、点号('.')组成且63个字符之内。 最小长度:1 最大长度:63 label_value 是 String 标签值。 以字母或者数字开头和结尾,由字母、数字、连接符('-')、下划线('_')、点号('