1. Interface Description
Interface request domain name: monitor.api3.convergecloud.com.
This API is used to add a policy group.
Default interface request rate limit: 20 times per second.
Interface update time: 2020-12-01 11:34:23.
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: CreatePolicyGroup |
| 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 |
| GroupName | Yes | No | String | Group policy name. Example: test_group |
| ViewName | No | No | String | Name of the view to which the policy group belongs. If the policy group is created based on a template, this parameter can be left empty. Example: cvm_device |
| ProjectId | No | No | Int64 | ID of the project to which the policy group belongs, which will be used for authentication. Example: 0 |
| ConditionTempGroupId | No | No | Int64 | ID of a template-based policy group. This parameter is required only when the policy group is created based on a template. Example: 123 |
| IsShielded | No | No | Int64 | Whether the policy group is shielded. The value 0 indicates that the policy group is not shielded. The value 1 indicates that the policy group is shielded. The default value is 0. Example: 1 |
| Remark | No | No | String | Remarks of the policy group. Example: backup_group |
| InsertTime | No | No | Int64 | Insertion time in the format of Unix timestamp. If this parameter is not configured, the backend processing time is used. Example: 106648246 |
| Conditions | No | No | Array of CreatePolicyGroupCondition | Alarm threshold rules in the policy group. Example:View |
| EventConditions | No | No | Array of CreatePolicyGroupEventCondition | Event alarm rules in the policy group. Example:View |
| Module | Yes | No | String | The value is fixed to "monitor". Example: monitor |
| BackEndCall | No | No | Int64 | Whether it is a backend call. If the value is 1, rules from the policy template will be used to fill in the Conditions and EventConditions fields. Example: 0 |
| IsUnionRule | No | No | Int64 | The 'AND' and 'OR' rules for alarm metrics. The value 0 indicates 'OR', which means that an alarm will be triggered when any rule is met. The value 1 indicates 'AND', which means that an alarm will be triggered only when all rules are met. Example: 1 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| GroupId | Int64 | Created policy ID. Example: 1288099 |
| 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. |
| 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. |
| ResourcesSoldOut | The resources have been sold out. |