创建消息通知配置 - CreateNotificationSetting
功能介绍
创建消息通知配置。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| AccessAnalyzer:notificationSetting:create | Write | notificationSetting * | - | - | - |
URI
POST /v5/notification-settings
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| analyzer_id | 是 | String | 参数解释: 分析器的唯一标识符。 您可以调用 ListAnalyzers API来获取分析器ID。该API的响应参数中会返回一个分析器列表,其中每个分析器对象的 id 字段即为分析器ID。 约束限制: 不涉及。 取值范围: 最小长度为1,最大长度为36。仅支持包含字母、数字、下划线(_)及中划线(-)。 默认取值: 不涉及。 |
| mc_switch | 是 | Boolean | 参数解释: 是否开启消息中心通知开关。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| smn_topic_urns | 是 | Array of strings | 参数解释: 消息通知配置的SMN主题URN列表。 约束限制: 不涉及。 取值范围: 数组长度为0到3。数组元素为字符串,最小长度为1,最大长度为1500。 默认取值: 不涉及。 |
响应参数
状态码:201
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 消息通知配置的唯一标识符。 取值范围: 最小长度为1,最大长度为36。仅支持包含字母、数字、下划线(_)和中划线(-)。 |
| urn | String | 参数解释: 消息通知配置的唯一资源标识符。 取值范围: 最小长度为1,最大长度为1500。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: 请求 ID。 取值范围: 不涉及。 |
| encoded_authorization_message | String | 参数解释: 鉴权信息。 取值范围: 不涉及。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: 请求 ID。 取值范围: 不涉及。 |
| encoded_authorization_message | String | 参数解释: 鉴权信息。 取值范围: 不涉及。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: 请求 ID。 取值范围: 不涉及。 |
| encoded_authorization_message | String | 参数解释: 鉴权信息。 取值范围: 不涉及。 |
请求示例
创建消息通知配置。
POST https://{hostname}/v5/notification-settings
{
"analyzer_id" : "3de500b3f6c74b0a8ef170656f8a6376",
"mc_switch" : true,
"smn_topic_urns" : [ "urn:smn:cn-north-7:******:test1" ]
} 响应示例
状态码:201
Created
{
"id" : "1c8b66cc466943ad9f6238a19f6f6679"
} 状态码
| 状态码 | 描述 |
|---|---|
| 201 | Created |
| 400 | Bad request |
| 403 | Forbidden |
| 404 | NotFound |
错误码
请参见错误码。