调用CreateSubscription创建通知订阅-阿里云帮助中心

调试

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

请求头

该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。

请求语法

POST /notify/subscription/create HTTP/1.1

请求参数


名称	类型	位置	是否必选	示例值	描述
	Object	Body	否		A short description of struct
subscriptionTitle	String	Body	是	testSubscription	通知订阅名称
scope	Long	Body	是	SERVICE	订阅范围类型
notifyObjectType	Long	Body	是	USER	通知对象类型
expiredType	Long	Body	是	LONG_TERM	订阅时效
period	String	Body	否	20天	短期时间段
scopeObjectList	Array	Body	是		订阅范围列表
scopeObjectId	Long	Body	是	1	订阅范围对象id
notifyObjectList	Array	Body	是		通知对象列表
notifyObjectId	Long	Body	是	2	通知对象id
notifyStrategyList	Array	Body	是		通知策略列表
instanceType	Long	Body	是	INCIDENT	订阅实例类型，事件、报警、故障
strategies	Array	Body	是		条件。json格式，包含多个条件，比如级别、影响程度 kv格式
conditions	Array	Body	否		通知策略条件
effection	String	Body	否	HIGH	影响范围
problemNotifyType	String	Body	否	PROBLEM_UPDATE	故障通知类型
level	String	Body	否	P1	等级
action	String	Body	否	INCIDENT_TRIGGER	动作
channels	String	Body	是	SMS,PHONE	渠道，多个逗号分隔
periodChannel	Object	Body	否		分时段通知订阅渠道
workday	String	Body	否	SMS,PHONE	工作日通知订阅渠道
nonWorkday	String	Body	否	SMS,PHONE	非工作日通知订阅渠道
clientToken	String	Body	否	601FA6A2-AC5C-4B59-BE11-378FTOKENA11	幂等参数
startTime	String	Body	否	2021-02-03 10:10:10	生效开始时间
endTime	String	Body	否	2021-11-03 10:10:10	失效时间

返回数据


名称	类型	示例值	描述
requestId	String	10REQUES-AC5C-4B59-BE11-378F117A6A88	request id
data	Object		data
subscriptionId	Long	101	订阅id

示例

请求示例

POST /notify/subscription/create HTTP/1.1
Host:gemp.cn-shanghai.aliyuncs.com
Content-Type:application/json

{
  "subscriptionTitle": "newSubs242",
  "scope": "SERVICE",
  "notifyObjectType": "USER",
  "expiredType": "LONG_TERM",
  "scopeObjectList": [
    {
      "scopeObjectId": 1
    }
  ],
  "notifyObjectList": [
    {
      "notifyObjectId": 79
    }
  ],
    "notifyStrategyList": [
        {
            "instanceType": "PROBLEM",
            "strategies": [
                {
                     "channels": "SMS,WEIXIN_GROUP",
                    "conditions": [
                        {
                            "level":"P1",
                            "effection": "HIGH",
                            "problemNotifyType": "PROBLEM_NOTIFY"
                        }
                    ]
                }
            ]
        }
    ],
    "clientToken": "123"
}

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateSubscriptionResponse>
    <data>
        <subscriptionId>70002030</subscriptionId>
    </data>
    <requestId>366D5476-734A-4DA5-963E-9724F87470BC</requestId>
</CreateSubscriptionResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "data" : {
    "subscriptionId" : 70002030
  },
  "requestId" : "366D5476-734A-4DA5-963E-9724F87470BC"
}

错误码


HttpCode	错误码	错误信息	描述
403	NotifySubsAlreadyExists	The specified subscription already exists.	通知订阅已存在

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