- 产品简介
- 购买指南
- 快速入门
- 操作指南
- 实践教程
- 消息队列（Queue）模型
- 消息主题（Topic）模型
- 迁移说明
- 案例分享
- API 文档
- SDK 文档
- 服务等级协议
- 词汇表
- 产品简介
- 购买指南
- 快速入门
- 操作指南
- 实践教程
- 消息队列（Queue）模型
- 消息主题（Topic）模型
- 迁移说明
- 案例分享
- API 文档
- SDK 文档
- 服务等级协议
- 词汇表
1. API Description
Domain name for API request: cmq.tencentcloudapi.com.
This API is used to query subscription details.
A maximum of 20 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cmq.ap-shanghai-fsi.tencentcloudapi.com
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common parameter. The value used for this API: DescribeSubscriptionDetail. |
| Version | Yes | String | Common parameter. The value used for this API: 2019-03-04. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| TopicName | Yes | String | Topic name, which is unique under the same account in an individual region. It is a string of up to 64 characters, which must begin with a letter and can contain letters, digits, and dashes (-). |
| Offset | No | Integer | Starting position of topic list to be returned on the current page in case of paginated return. If a value is entered, limit is required. If this parameter is left empty, 0 will be used by default |
| Limit | No | Integer | Number of topics to be returned per page in case of paginated return. If this parameter is not passed in, 20 will be used by default. Maximum value: 50. |
| Filters.N | No | Array of Filter | Filter parameter. Currently, only filtering by SubscriptionName is supported, and only one keyword is allowed. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number |
| SubscriptionSet | Array of Subscription | Subscription attribute set Note: this field may return null, indicating that no valid values can be obtained. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Querying subscription details
Input Example
https://cmq.tencentcloudapi.com/?Action=DescribeSubscriptionDetail
&TopicName=ConnTopic
&<Common request parameters>Output Example
{
"Response": {
"TotalCount": 0,
"SubscriptionSet": [],
"RequestId": "c67d0d56-2406-49b2-8e82-320b9beab46c"
}
}5. Developer Resources
API Explorer
This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| FailedOperation.TryLater | The operation is in progress. Please try again later. |
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue.NoTaskId | The task ID does not exist. |
| LimitExceeded | The quota limit is exceeded. |
| ResourceInUse | The resource is in use. |
| ResourceNotFound | The resource does not exist. |
| ResourceUnavailable | The resource is unavailable. |
| ResourcesSoldOut | The resources have been sold out. |
| UnauthorizedOperation | Unauthorized operation. |
是
否
本页内容是否解决了您的问题？