You need to enable JavaScript to run this app.
文档中心
消息队列 RabbitMQ版

消息队列 RabbitMQ版

复制全文
下载 pdf
如何调用 API
返回结果
复制全文
下载 pdf
返回结果
发送请求消息以后,您会收到消息队列服务端的响应,返回结果中包含状态码、响应消息头和消息体。​
状态码​
状态码是一组从 1xx 到 5xx 的数字代码,状态码表示了请求响应的状态,例如响应的HTTP状态码为 2xx,表示调用成功;返回的HTTP状态码为 4xx 或 5xx,表示调用失败。​
响应消息头​
对应请求消息头,响应同样也有消息头,如 Content-type。​
响应消息体​
响应消息体通常以 JSON 结构化格式返回,与响应消息头中 Content-Type 对应,传递除响应消息头之外的内容。当接口调用出错时,会返回错误码及错误信息说明。​
  • HTTP 状态码为 200,表示请求成功。此时服务端返回结果中会包含 ResponseMetadata 和 Result 两部分。​
  • 所有非 200 的状态码,表示请求失败。失败的详细信息以 JSON 的形式返回,返回内容中仅包含 ResponseMetadata,不包含 Result 字段。​
  • ResponseMetadata 中各字段说明如下,除了以下固定字段外,API 返回的其他字段均为某个 API 独立定义的业务字段,不同的API所返回的业务相关字段请参考各个 API 文档中的定义。​
​
字段​
​
说明​
RequestID​
​
每次 API 请求的唯一标识。​
如果调用 API 时发生未知异常,请通过工单系统联系技术支持,提供请求的 RequestID,技术支持会根据 RequestID 定位有问题的请求,协助您排查故障。​
Action​
​
接口名,属于请求的公共参数。​
Version​
​
版本号,属于请求的公共参数。​
Service​
​
服务名称,属于请求的公共参数。​
Region​
​
地域,属于请求的公共参数。​
Error​
  • ​
Error 出现表示本次请求失败。​
​
Code​
具体的错误码,您可根据错误码查询文档自助解决问题。​
​
CodeN​
标识错误码的数字 ID,方便查找问题,仅部分接口会提供 CodeN。​
​
Message​
错误信息,描述了错误发生的具体原因,供您排查问题参考。​
随着业务发展或体验优化,此文本可能会经常保持变更或更新,用户不应依赖这个返回值。​
​
请求成功示例​
​
{​
"ResponseMetadata": {​
"RequestId": "********",​
"Action": "DescribeOperationEvents",​
"Version": "2022-01-01",​
"Service": "rabbitmq",​
"Region": "cn-beijing"​
},​
"Result": {/* 具体业务的返回信息 */​
"OperationEvents": [​
{​
"OperationName": "ModifyPlugin",​
"EventSource": "OpenAPI",​
"StartTime": 1645523741,​
"Status": "Executing",​
"EndTime": 1645523741,​
"Duration": 10,​
"OperationDetail": "开启rabbitmq_web_mqtt",​
"InstanceId": "rbtmq-*******",​
"OperationType": "ModifyPlugin",​
"EventID": "1"​
}​
],​
"Total": 1​
}​
}​
​
请求失败示例​
​
{​
"ResponseMetadata": {​
"RequestId": "********",​
"Action": "CreateInstance",​
"Version": "2022-01-01",​
"Service": "rabbitmq",​
"Region": "cn-beijing",​
"Error": {​
"Code": "InternalError",​
"Message": "The request processing has failed due to some unknown error, exception or failure."​
}​
},​
"Result": null​
}​
​
​
最近更新时间:2025.07.08 15:56:56
这个页面对您有帮助吗?
有用
有用
无用
无用