API 网关
API 网关
API 网关
文档指南
请输入
产品动态
用户指南
Upstream 管理
最佳实践
常见问题
API 参考
网关管理
路由管理
后端管理
消费者管理
插件管理
- 文档首页
API 网关API 参考调用方式返回结构
复制全文
下载 pdf返回结构
文档反馈
问问助手调用 OpenAPI 后，所有返回结果都会携带RequestId、Action、Version、Service、Region等字段。
正常返回示例
接口调用成功后，会返回请求 ID 和接口返回参数。HTTP 状态码为2xx。示例如下：
HTTP/1.1 200 OK
Content-Type:application/json
{
"ResponseMetadata": {
"RequestId": "202211302208xxxx",
"Action": "CreateGateway",
"Version": "2021-03-03",
"Service": "apig",
"Region": "cn-beijing"
},
"Result": {
"Id": " e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"
}
}
异常返回示例
接口调用出错后，会返回请求 ID 和错误信息。HTTP 状态码为4xx或5xx。示例如下：
{
"ResponseMetadata": {
"RequestId": "202010201722300102****",
"Action": "DeleteGateway",
"Version": "2021-03-03",
"Service": "apig",
"Region": "cn-beijing",
"Error": {
"Code": "NotFound.Gateway",
"Message": "The specified Gateway demo is not found."
}
}
}
说明
最近更新时间：2026.07.22 17:47:47
这个页面对您有帮助吗？
有用
有用
无用
无用