Tenant Cloud
Security
Cloud Workload Protection Platform
Baseline Management APIs
DescribeBaselineStrategyDetail
1. Interface Description
Interface request domain name: cwp.api3.convergecloud.com.
This API is used to query the details of a baseline policy based on a policy ID.
Default interface request rate limit: 20 times per second.
Interface update time: 2022-05-20 15:12:33.
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: DescribeBaselineStrategyDetail |
| 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. |
| StrategyId | Yes | No | Uint64 | ID of the custom baseline policy. Example: 1 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| CategoryIds | Array of String | IDs of all baselines associated with this policy. Example: ["10021"] |
| IfScanned | Uint64 | 1: scanned. 0: not scanned. Example: 1 |
| IsGlobal | Uint64 | Specifies whether all servers will be scanned. 1: yes. 0: no. If you set this parameter to 1, all servers with CWP Pro are scanned. Example: 1 |
| MachineType | String | CVM type. Example: CVM |
| PassRate | Uint64 | Pass rate of the scans based on the policy. Example: 1 |
| Quuids | Array of String | QUUIDs of all servers associated with this policy. Example: ["0096440e-9a9f-4e80-a82d-0b018637ayay"] |
| Region | String | Region of the server. Example: ap-bj |
| ScanAt | String | Time to deliver the regular scan. Example: 00:00:00 |
| ScanCycle | String | Scan cycle. Unit: days. Example: 1 |
| StrategyName | String | Policy name. Example: Weak password |
| 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. |
| ResourceNotFound | The resource does not exist. |
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue | The parameter value is invalid. |