1. 接口描述
接口请求域名: cmq.tencentcloudapi.com 。
查询订阅详情
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeSubscriptionDetail。 |
Version | 是 | String | 公共参数,本接口取值:2019-03-04。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
TopicName | 是 | String | 主题名字,在单个地域同一帐号下唯一。主题名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。 |
Offset | 否 | Integer | 分页时本页获取主题列表的起始位置。如果填写了该值,必须也要填写 limit 。该值缺省时,后台取默认值 0 |
Limit | 否 | Integer | 分页时本页获取主题的个数,如果不传递该参数,则该参数默认为20,最大值为50。 |
Filters.N | 否 | Array of Filter | 筛选参数,目前只支持SubscriptionName,且仅支持一个关键字。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 总数 |
SubscriptionSet | Array of Subscription | Subscription属性集合 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询订阅详情
输入示例
https://cmq.tencentcloudapi.com/?Action=DescribeSubscriptionDetail
&TopicName=Conn
&<公共请求参数>
输出示例
{
"Response": {
"TotalCount": 1,
"SubscriptionSet": [
{
"SubscriptionName": "ConnSub",
"SubscriptionId": "subsc-8y7fn4t2",
"TopicOwner": 0,
"MsgCount": 0,
"LastModifyTime": 1590632987,
"CreateTime": 1590632987,
"BindingKey": null,
"Endpoint": "test1",
"FilterTags": [],
"Protocol": "queue",
"NotifyStrategy": "EXPONENTIAL_DECAY_RETRY",
"NotifyContentFormat": "SIMPLIFIED"
}
],
"RequestId": "72cd2d9d-d666-45ad-963a-cf5065a1984c"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.TryLater | 操作进行中,请稍后重试。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue.NoTaskId | 任务Id不存在。 |
LimitExceeded | 超过配额限制。 |
ResourceInUse | 资源被占用。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |