Subscribe - 为主题创建Subscription

调用Subscribe接口,为主题创建Subscription。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mns:Subscribeupdate
  • 全部资源
    *

请求参数

名称类型必填描述示例值
TopicNamestring

主题的名称。

topic****1
SubscriptionNamestring

订阅名称。

testSubscription
PushTypestring

终端类型。

  • http:HTTP 推送类型。

  • queue:队列推送类型。

  • mpush:移动推送类型。

  • alisms:阿里短信推送类型。

  • email:邮箱推送类型。

queue
Endpointstring

此次订阅中接收消息的终端地址,不同终端类型的格式如下:

  • HTTP 格式为: http(s)://{实际 url 地址}
  • 队列格式为: {QueueName}
  • 移动推送格式为: {AppKey}
  • 阿里短信格式为: {phoneNumber}
  • 邮箱格式为: {emailAddress}
http://*****.com/uri1/xxx
NotifyStrategystring

向 Endpoint 推送消息错误时的重试策略。取值说明如下:

  • BACKOFF_RETRY:退避重试。

  • EXPONENTIAL_DECAY_RETRY:指数衰减重试。

BACKOFF_RETRY
NotifyContentFormatstring

用于定义向 Endpoint 推送的消息格式。 取值说明如下:

  • XML

  • JSON

  • SIMPLIFIED

XML
MessageTagstring

该订阅中消息过滤的标签(标签一致的消息才会被推送)。 取值范围:不超过 16 个字符的字符串。

默认不进行消息过滤。

important

返回参数

名称类型描述示例值
object
RequestIdstring

请求的 ID。

06273500-249F-5863-121D-74D51123****
Codelong

响应 code。

200
Statusstring

响应的状态。

Success
Messagestring

响应信息。

operation success
Successboolean

请求是否成功。

true
Datastring

响应数据。

{'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}"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-04-24API 内部配置变更,不影响调用查看变更详情