1. Interface Description
Interface request domain name: monitor.api3.convergecloud.com.
This API is used to get the list of basic policy alarm groups.
Default interface request rate limit: 20 times per second.
Interface update time: 2022-10-24 10:18:55.
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: DescribePolicyGroupList |
| 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 | The value is fixed to "monitor". Example: monitor |
| Limit | Yes | No | Int64 | Pagination parameter, the number of entries per page. Value range: 1-1000. Example: 10 |
| Offset | Yes | No | Int64 | Pagination parameter. Page offset. It starts from 0. Example: 0 |
| Like | No | No | String | Searches by policy name. Example: test |
| InstanceGroupId | No | No | Int64 | Instance group ID. Example: 12345 |
| UpdateTimeOrder | No | No | String | Sorts by update time. Valid values: asc, desc. Example: asc |
| ProjectIds | No | No | Array of Int64 | List of project IDs. Example: [1] |
| ViewNames | No | No | Array of String | List of alarm policy types. Example: [cvm_device] |
| FilterUnuseReceiver | No | No | Int64 | Whether to filter policy groups that have no recipients. 1: yes. 0: no. Example: 0 |
| Receivers | No | No | Array of String | Filters by recipient group list. Example: [123] |
| ReceiverUserList | No | No | Array of String | Filters by recipient list. Example: [12345] |
| Dimensions | No | No | String | Dimension set field (JSON string), for example, [[{"name":"unInstanceId","value":"ins-6e4b2aaa"}]]. Example: {} |
| ConditionTempGroupId | No | No | String | Template-based policy group ID. Multiple IDs are separated by commas. Example: 123,345 |
| ReceiverType | No | No | String | Filters by recipient or recipient group. The value 'user' indicates by recipient. The value 'group' indicates by recipient group. Example: user |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| GroupList | Array of DescribePolicyGroupListGroup | Policy group list. Example:View |
| Total | Int64 | Total number of policy groups. Example: 142 |
| 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 |
|---|---|
| InvalidParameterValue | Invalid parameter value. |
| InternalError | Internal error. |
| InvalidParameter.InvalidParameterParam | Invalid parameter. |
| InvalidParameter.InvalidParameter | Invalid parameter. |
| InvalidParameter | Invalid parameter. |
| InternalError.ExeTimeout | Execution timed out. |
| FailedOperation | Operation failed. |
| MissingParameter | Missing parameter. |
| UnknownParameter | Unknown parameter error. |
| UnauthorizedOperation | Unauthorized operation. |
| UnsupportedOperation | Unsupported operation. |
| ResourceNotFound | The resource does not exist. |
| LimitExceeded | The quota limit has been reached. |
| ResourceUnavailable | The resource is unavailable. |
| ResourceInsufficient | Insufficient resource. |
| FailedOperation | Operation failed. |
| ResourceInUse | The resource is in use. |
| DryRunOperation | DryRun operation, which means the DryRun parameter is passed in yet the request will still be successful. |
| ResourcesSoldOut | The resources have been sold out. |
| LimitExceeded.MetricQuotaExceeded | Quota limit on metrics is reached. Requests containing unregistered metrics are prohibited. |
| FailedOperation.ServiceNotEnabled | The service is not enabled and can be used only after being enabled. |
| FailedOperation.AlertPolicyCreateFailed | Failed to create the alarm policy. |
| FailedOperation.DbRecordCreateFailed | Failed to create the database record. |
| FailedOperation.DbTransactionBeginFailed | Failed to start the database transaction. |
| FailedOperation.DbRecordDeleteFailed | Failed to delete the database record. |
| FailedOperation.DbQueryFailed | Failed to query the database. |
| FailedOperation.DbTransactionCommitFailed | Failed to submit the database transaction. |
| FailedOperation.DbRecordUpdateFailed | Failed to update the database record. |
| AuthFailure.UnauthorizedOperation | The request is not authorized. Please refer to the CAM documentation for the description of authentication. |
| FailedOperation.DuplicateName | The name already exists. |
| FailedOperation.DruidQueryFailed | Failed to query analysis data. |
| FailedOperation.DimQueryRequestFailed | Failed to query the service in the request dimension. |
| FailedOperation.AlertPolicyDescribeFailed | Failed to query the alarm policy. |
| FailedOperation.AlertPolicyDeleteFailed | Failed to delete the alarm policy. |
| FailedOperation.AlertPolicyModifyFailed | Failed to modify the alarm policy. |
| FailedOperation.AlertTriggerRuleDeleteFailed | Failed to delete the trigger condition. |
| FailedOperation.AlertFilterRuleDeleteFailed | Failed to delete the filter rule. |