- 文档首页
消息队列 RabbitMQ版
API 参考
V2(2022-01-01)
如何调用 API
返回结果
返回结果
发送请求消息以后,您会收到消息队列服务端的响应,返回结果中包含状态码、响应消息头和消息体。
状态码
状态码是一组从 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": "********",
"Action": "DescribeOperationEvents",
"Version": "2022-01-01",
"Result": {/* 具体业务的返回信息 */
"OperationName": "ModifyPlugin",
"EventSource": "OpenAPI",
"StartTime": 1645523741,
"OperationDetail": "开启rabbitmq_web_mqtt",
"InstanceId": "rbtmq-*******",
"OperationType": "ModifyPlugin",
请求失败示例
"RequestId": "********",
"Action": "CreateInstance",
"Version": "2022-01-01",
"Code": "InternalError",
"Message": "The request processing has failed due to some unknown error, exception or failure."
最近更新时间:2025.07.08 15:56:56