1. Interface Description
Interface request domain name: monitor.api3.convergecloud.com.
This API is used to edit an alarm notification template.
Default interface request rate limit: 20 times per second.
Interface update time: 2021-02-24 20:11:26.
The interface is both signature verification and authentication.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: ModifyAlarmNotice |
| Version | Yes | No | String | Public parameter, The value of this interface: 2018-07-24 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| Module | Yes | No | String | Module name. Enter "monitor" here. Example: monitor |
| Name | Yes | No | String | Name of the alarm notification rule, which can contain up to 60 characters. Example: Default notification template |
| NoticeType | Yes | No | String | Notification type. Valid values: ALARM (for unresolved alarms), OK (for resolved alarms), ALL (for all alarms) Example: ALL |
| NoticeLanguage | Yes | No | String | Notification language. Example: zh-CN |
| UserNotices | No | No | Array of UserNotice | Number of user notifications (up to 5). Example:View |
| URLNotices | No | No | Array of URLNotice | Number of callback notifications (up to 3). Example:View |
| NoticeId | Yes | No | String | ID of the alarm notification template. Example: notice-qwer |
| ExtraChannels | No | No | Array of String | List of other non-public notification channels. Example: ["TSS"] |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue | Invalid parameter value. |
| AuthFailure.UnauthorizedOperation | The request is not authorized. Please refer to the CAM documentation for the description of authentication. |
| InternalError | Internal error. |
| ResourceNotFound | The resource does not exist. |
| FailedOperation | Operation failed. |