接口描述
本接口(GetSubscriptionAttributes)用于获取某个已创建订阅的属性。
- 外网接口请求域名:
https://cmq-topic-{$region}.api.qcloud.com
- 内网接口请求域名:
http://cmq-topic-{$region}.api.tencentyun.com
上述域名中的{$region}需用具体地域替换:gz(广州),sh(上海),bj(北京),shjr(上海金融),szjr(深圳金融),hk(中国香港),cd(成都),ca(北美),usw(美西),sg(新加坡)。公共参数中的 region 值要与域名的 region 值保持一致,如果出现不一致的情况,以域名的 region 值为准,将请求发往域名 region 所指定的地域。
任何时候(包括内测期间),如果使用外网域名产生公网下行流量,都会收取流量费用。 所以强烈建议服务在腾讯云上的用户使用内网域名,内网不会产生流量费用。
输入参数
以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数 页面。
参数名称 | 是否必选 | 类型 | 描述 |
---|---|---|---|
topicName | 是 | String | 主题名字,在单个地域同一账号下唯一。 主题名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。 |
subscriptionName | 是 | String | 订阅名字,在单个地域同一账号的同一主题下唯一。订阅名称是一个不超过64个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)。 |
输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 0:表示成功,其他返回值的含义可以参考 错误码。 |
message | String | 错误提示信息。 |
requestId | String | 服务器生成的请求 ID。出现服务器内部错误时,用户可提交此 ID 给后台定位问题。 |
topicOwner | String | 订阅拥有者的 APPID。 |
msgCount | Int | 该订阅待投递的消息数。 |
protocol | String | 订阅的协议,目前支持两种协议:HTTP、queue。使用 HTTP 协议,用户需自己搭建接受消息的 Web Server。使用 queue,消息会自动推送到 CMQ queue,用户可以并发地拉取消息。 |
endpoint | String | 接收通知的 endpoint,根据协议 protocol 区分:对于 HTTP,endpoint 必须以 “http://” 开头,host 可以是域名或 IP;对于 queue,则填 queueName。 |
notifyStrategy | String | 向 endpoint 推送消息出现错误时,CMQ 推送服务器的重试策略。取值有: (1)BACKOFF_RETRY,退避重试。每隔一定时间重试一次,重试够一定次数后,就把该消息丢弃,继续推送下一条消息; (2)EXPONENTIAL_DECAY_RETRY,指数衰退重试。每次重试的间隔是指数递增的,例如开始 1s,后面是 2s,4s,8s...由于 Topic 消息的周期是一天,所以最多重试一天就把消息丢弃。默认值是 EXPONENTIAL_DECAY_RETRY。 |
notifyContentFormat | String | 推送内容的格式。取值:(1)JSON;(2)SIMPLIFIED,即 raw 格式。如果 protocol 是 queue,则取值必须为 SIMPLIFIED。如果 protocol 是 HTTP,两个值均可以,默认值是 JSON。 |
createTime | Int | 订阅的创建时间。返回 Unix 时间戳,精确到秒。 |
lastModifyTime | Int | 最后一次修改订阅属性的时间。返回 Unix 时间戳,精确到秒。 |
bindingKey | String 数组 | 表示订阅接收消息的过滤策略。 |
示例
输入:
https://domain/v2/index.php?Action=GetSubscriptionAttributes
&topicName=test-topic-123
&subscriptionName=test-subscription-123
&<公共请求参数>
输出:
{
"code" : 0,
"message" : "",
"requestId":"14534664555",
"topicOwner":"1231884",
"msgCount":234,
"protocol":"http",
"endpoint":"http://testhost/testpath",
"notifyStrategy":"EXPONENTIAL_DECAY_RETRY",
"notifyContentFormat":"SIMPLIFIED",
"createTime":1462268960,
"lastModifyTime": 1462269960
}