调用Subscribe接口,为主题创建Subscription。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
mns:Subscribe |
update |
*Subscription
|
|
无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| TopicName |
string |
是 |
主题的名称。 |
topic****1 |
| SubscriptionName |
string |
是 |
订阅名称。 |
testSubscription |
| PushType |
string |
是 |
订阅的推送类型取值:
说明: 以下值已废弃,仅用于兼容旧订阅:
|
queue |
| Endpoint |
string |
是 |
接收消息的终端地址格式根据
|
http://*****.com/uri1/xxx |
| NotifyStrategy |
string |
否 |
向 Endpoint 推送消息错误时的重试策略。取值说明如下:
|
BACKOFF_RETRY |
| NotifyContentFormat |
string |
否 |
推送的消息内容格式取值:
|
XML |
| MessageTag |
string |
否 |
该订阅中消息过滤的标签(标签一致的消息才会被推送)。 取值范围:不超过 16 个字符的字符串。 默认不进行消息过滤。 |
important |
| DlqPolicy |
object |
否 |
死信队列策略。 |
|
| Enabled |
boolean |
否 |
是否开启死信消息投递。 |
true |
| DeadLetterTargetQueue |
string |
否 |
死信消息投递目标队列。 |
deadLetterTargetQueue |
| TenantRateLimitPolicy |
object |
否 |
限流策略 |
|
| Enabled |
boolean |
否 |
是否启用限流策略,true 启用,false 关闭 |
|
| MaxReceivesPerSecond |
integer |
否 |
每秒最大推送/消费次数 |
50 |
| StsRoleArn |
string |
否 |
服务扮演的 RAM 角色 ARN。格式为 acs:ram::{主账号 UID}:role/{RoleName},其中 {主账号 UID} 必须替换为调用 OpenAPI 的阿里云主账号 UID。 |
acs:ram::1234567890:role/AliyunMNSNotificationRole |
| DmAttributes |
object |
否 |
邮箱推送相关属性,当 PushType=dm 时必填。JSON 格式,包含以下字段:
|
|
| AccountName |
string |
否 |
发信地址 |
notify@example.com |
| Subject |
string |
否 |
邮件主题 |
notify |
| DysmsAttributes |
object |
否 |
短信推送相关属性,当 PushType=alisms 时必填。JSON 格式,包含以下字段:
|
|
| TemplateCode |
string |
否 |
短信模板 Code |
123456 |
| SignName |
string |
否 |
短信签名名称 |
阿里云短信测试专用 |
| KafkaAttributes |
object |
否 |
Kafka 推送类型已废弃 |
|
| BusinessMode |
string |
否 |
Kafka 推送类型已废弃 |
Default empty string |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求的 ID。 |
06273500-249F-5863-121D-74D51123**** |
| Code |
integer |
响应 code。 |
200 |
| Status |
string |
响应的状态。 |
Success |
| Message |
string |
响应信息。 |
operation success |
| Success |
boolean |
请求是否成功。 |
true |
| Data |
string |
响应数据。 |
{'Code': 200, 'Success': True} |
示例
正常返回示例
JSON格式
{
"RequestId": "06273500-249F-5863-121D-74D51123****",
"Code": 200,
"Status": "Success",
"Message": "operation success",
"Success": true,
"Data": "{'Code': 200, 'Success': True}"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。