Tenant Cloud
Security
Cloud Workload Protection Platform
Baseline Management APIs
DescribeBaselineRule
1. Interface Description
Interface request domain name: cwp.api3.convergecloud.com.
This API is used to query the baseline check items based on a baseline ID.
Default interface request rate limit: 20 times per second.
Interface update time: 2022-05-20 15:13:13.
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: DescribeBaselineRule |
| Version | Yes | No | String | Public parameter, The value of this interface: 2018-02-28 |
| Region | No | No | String | Public parameter,Regional information This interface does not need to pass this parameter. |
| BaselineId | Yes | No | Uint64 | Baseline ID. Example: 1 |
| Level | No | No | Array of Uint64 | Baseline risk level. 0: low; 1: medium; 2: high; 3: critical. Example: [1,2,3] |
| Limit | Yes | No | Uint64 | Maximum number of entries to return on each page. Maximum value: 100. Example: 10 |
| Offset | Yes | No | Uint64 | The number of the page to be returned. Example: 0 |
| Quuid | No | No | String | QUUID of the server. Example: e5b4724c-49af-46ab-bd84-cdbae897e7e0 |
| Status | No | No | Uint64 | State. Example: 0 |
| Uuid | No | No | String | Host UUID. Example: e5b4724c-49af-46ab-bd84-cdbae897e7e0 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| BaselineRuleList | Array of BaselineRuleInfo | List of baseline check items. Example:View |
| ShowRuleRemark | Bool | Indicates whether to display the Description column. true: yes. false: no. Example: true |
| TotalCount | Uint64 | Total number of records returned for the paginated query. Example: 1 |
| 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.ParsingError | Parameter parsing error. |
| InvalidParameter.MissingParameter | Missing parameter. |
| MissingParameter | Missing parameter. |
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue | The parameter value is invalid. |