GetSubscription - 获取事件推送配置

更新时间:
复制 MD 格式

获取MQ配置。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

实例 ID

4f9a8e2b-6c1d-4a7e-9b3f-2d5c8a1e7b04

返回参数

名称

类型

描述

示例值

object

Schema of Response

Code

string

返回码

OK

HttpStatusCode

integer

HTTP 状态码

200

Message

string

错误信息

Instance does not exist. Instance=ob-1234567890

RequestId

string

请求 ID

019FDAC7-13C5-1B64-A853-999DF105B9EF

Data

object

返回数据

InstanceId

string

实例 ID

4f9a8e2b-6c1d-4a7e-9b3f-2d5c8a1e7b04

Disabled

boolean

true 表示禁用,false 表示启用

true

MqType

string

消息队列类型

枚举值:

  • ROCKET_MQ_4 :

    ROCKET_MQ_4

  • ROCKET_MQ_5 :

    ROCKET_MQ_5

ROCKET_MQ_4

Endpoint

string

接入点

rmq-cn-h964u01wh12.cn-hangzhou.rmq.aliyuncs.com:8080

Topic

string

主题

OUTBOUND_BOT_TOPIC

UserName

string

用户名

admin

Password

string

密码

pa44w0rd

MqInstanceId

string

MQ 的实例 ID

rmq-cn-3g84vpf3712

ProducerId

string

生产者标识

GID_123456

EventList

array<object>

推送内容列表

object

Name

string

名称

Ringing

DisplayName

string

显示名称

振铃

Disabled

boolean

true 表示禁用,false 表示启用

true

Params

array

错误信息中的变量值列表

string

错误信息中的变量值

4f9a8e2b-6c1d-4a7e-9b3f-2d5c8a1e7b04

Success

boolean

是否调用成功

true

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "Instance does not exist. Instance=ob-1234567890",
  "RequestId": "019FDAC7-13C5-1B64-A853-999DF105B9EF",
  "Data": {
    "InstanceId": "4f9a8e2b-6c1d-4a7e-9b3f-2d5c8a1e7b04",
    "Disabled": true,
    "MqType": "ROCKET_MQ_4",
    "Endpoint": "rmq-cn-h964u01wh12.cn-hangzhou.rmq.aliyuncs.com:8080",
    "Topic": "OUTBOUND_BOT_TOPIC",
    "UserName": "admin",
    "Password": "pa44w0rd",
    "MqInstanceId": "rmq-cn-3g84vpf3712",
    "ProducerId": "GID_123456",
    "EventList": [
      {
        "Name": "Ringing",
        "DisplayName": "振铃",
        "Disabled": true
      }
    ]
  },
  "Params": [
    "4f9a8e2b-6c1d-4a7e-9b3f-2d5c8a1e7b04"
  ],
  "Success": true
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情