1. Interface Description
Interface request domain name: monitor.api3.convergecloud.com.
This API is used to query the list of notification templates.
Default interface request rate limit: 20 times per second.
Interface update time: 2022-11-22 16:04:12.
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: DescribeAlarmNotices |
| 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 |
| OwnerUid | No | No | Int64 | Root account UID, which is used to create preset notifications. Example: 1234567 |
| Name | No | No | String | Alarm notification template name, which is used for fuzzy search. Example: template |
| ReceiverType | No | No | String | Filter by recipient. The type of notified users should be selected for the alarm notification template. Valid values: USER (user), GROUP (user group). If this parameter is left empty, no filter by recipient will be performed. Example: USER |
| UserIds | No | No | Array of Int64 | Recipient object list. Example: [1234567] |
| GroupIds | No | No | Array of Int64 | Recipient group list. Example: [1234567] |
| PageNumber | Yes | No | Int64 | Page number. Minimum value: 1. Example: 1 |
| PageSize | Yes | No | Int64 | Number of entries per page. Value range: 1–200. Example: 20 |
| Order | Yes | No | String | Sorts by update time. Valid values: ASC (ascending), DESC (descending). Example: DESC |
| AMPConsumerIds | No | No | Array of String | Filters by the background amp consumer ID list. If this parameter is left empty, the filter operation will not be performed. Example: ["Consumer-9gfn2g92hg92"] |
| NoticeIds | No | No | Array of String | Filters by notification template ID. If an empty array is passed in or if this parameter is left empty, the filter operation will not be performed. Example: ["notice-ah28cv9d"] |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| TotalCount | Int64 | Total number of alarm notification templates. Example: 1 |
| Notices | Array of AlarmNotice | List of alarm notification templates. Example:View |
| 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 |
|---|---|
| InternalError | Internal error. |
| InvalidParameter | Invalid parameter. |
| ResourceNotFound | The resource does not exist. |
| FailedOperation | Operation failed. |
| UnsupportedOperation | Unsupported operation. |
| AuthFailure.UnauthorizedOperation | The request is not authorized. Please refer to the CAM documentation for the description of authentication. |
| InvalidParameterValue | Invalid parameter value. |