Retrieves the configuration of a message queue subscription.
Try it now
You can call this API directly in OpenAPI Explorer, which saves you the trouble of calculating signatures. After a successful call, OpenAPI Explorer can automatically generate SDK code examples.
RAM authorization
The following table describes the authorization information of this API. You can use the Action element in a RAM policy statement to grant a RAM user or RAM role the permission to call this API. The details are as follows:
- Operation: the specific permission.
- Access level: the access level of each operation. Valid values: Write, Read, and List.
- Resource type: the resource types that can be authorized in the operation. The details are as follows:
- An asterisk (*) before a resource type indicates that the resource type is required.
- For operations that do not support resource-level authorization,
All resourcesis used.
- Condition keyword: the condition keywords defined by the cloud service itself.
- Related operation: other permissions required to successfully perform the operation. The caller must also have the permissions of the related operations.
Operation | Access level | Resource type | Condition keyword | Related operation |
|---|---|---|---|---|
bailianvoicebot:GetSubscription | get | *All resources
| None | None |
Request syntax
Request parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| BusinessUnitId | string | No | The ID of the Model Studio business space. | llm-3pptowd2olrctsvc |
Response elements
Element | Type | Description | Example |
|---|---|---|---|
object | Schema of Response | ||
| Code | string | The status code returned for the request. | OK |
| HttpStatusCode | integer | The HTTP status code. | 200 |
| Message | string | The error message. | Instance llm-zzu528i29ecnprcl does not exist. |
| RequestId | string | The request ID. | D771A1B6-3D5F-174A-BEE1-98CE1000D337 |
| Data | object | The subscription details. | |
| InstanceId | string | The ID of the Model Studio business space. | llm-3pptowd2olrctsvc |
| Disabled | boolean | Indicates whether the subscription is disabled. 0 indicates enabled, and 1 indicates disabled. | 0 |
| MqType | string | The message push type. | ROCKET_MQ_4 |
| Endpoint | string | The endpoint. This parameter is required if | rmq-cn-l4p89zajz67.cn-hangzhou.rmq.aliyuncs.com:8080 |
| Topic | string | The topic of the queue. This parameter is required if | test |
| UserName | string | The username. This parameter is required if | username |
| Password | string | The password. This parameter is required if | pwd |
| MqInstanceId | string | The ID of the MQ instance. This parameter is required if | rmq-cn-l4p89zajz67.cn |
| ProducerId | string | The producer ID. This parameter is required if | PID_Webhook |
| EventList | array<object> | The list of subscribed events. | |
object | The subscribed event object. | ||
| Name | string | The subscribed content. | Released |
| DisplayName | string | The display name of the subscribed content. | Call ended |
| Disabled | boolean | Indicates whether to push the event. | false |
| Params | array | The list of dynamic error parameters. | |
string | A dynamic error parameter. | llm-zop7ukgtksltamo4 |
Examples
Success response
JSON format