GetSubscription

更新时间:
复制 MD 格式

获取MQ配置

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

bailianvoicebot:GetSubscription

get

*全部资源

*

无无

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

BusinessUnitId

string

否

百炼业务空间 ID

llm-3pptowd2olrctsvc

返回参数

名称

类型

描述

示例值

object

Schema of Response

Code

string

接口状态码

OK

HttpStatusCode

integer

http 状态码

200

Message

string

错误信息

Instance llm-zzu528i29ecnprcl does not exist.

RequestId

string

请求 ID

D771A1B6-3D5F-174A-BEE1-98CE1000D337

Data

object

订阅信息

InstanceId

string

百炼业务空间 ID

llm-3pptowd2olrctsvc

Disabled

boolean

是否禁用:0-启用,1-禁用

0

MqType

string

消息推送类型

ROCKET_MQ_4

Endpoint

string

接入点(使用 ROCKET_MQ_4、ROCKET_MQ_5 时必填)

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

Topic

string

队列 topic(使用 ROCKET_MQ_4、ROCKET_MQ_5 时必填)

test

UserName

string

用户名(使用 ROCKET_MQ_5 时必填)

username

Password

string

密码(使用 ROCKET_MQ_5 时必填)

pwd

MqInstanceId

string

MQ 实例 ID(使用 ROCKET_MQ_5 时必填)

rmq-cn-l4p89zajz67.cn

ProducerId

string

生产者标识(使用 ROCKET_MQ_4 时必填)

PID_Webhook

EventList

array<object>

订阅事件列表

object

订阅事件对象

Name

string

订阅内容

Released

DisplayName

string

订阅内容显示名称

通话结束

Disabled

boolean

是否推送

false

Params

array

动态错误参数列表

string

动态错误参数

llm-zop7ukgtksltamo4

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "Instance llm-zzu528i29ecnprcl does not exist.",
  "RequestId": "D771A1B6-3D5F-174A-BEE1-98CE1000D337",
  "Data": {
    "InstanceId": "llm-3pptowd2olrctsvc",
    "Disabled": true,
    "MqType": "ROCKET_MQ_4",
    "Endpoint": "rmq-cn-l4p89zajz67.cn-hangzhou.rmq.aliyuncs.com:8080",
    "Topic": "test",
    "UserName": "username",
    "Password": "pwd",
    "MqInstanceId": "rmq-cn-l4p89zajz67.cn",
    "ProducerId": "PID_Webhook",
    "EventList": [
      {
        "Name": "Released",
        "DisplayName": "通话结束",
        "Disabled": false
      }
    ]
  },
  "Params": [
    "llm-zop7ukgtksltamo4"
  ]
}

错误码

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

变更历史

更多信息,参考变更详情。