Tenant Cloud
Security
Cloud Workload Protection Platform
Advanced Defense APIs
DescribeProtectDirRelatedServer
1. Interface Description
Interface request domain name: cwp.api3.convergecloud.com.
This API is used to query the servers associated with a protected directory.
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: DescribeProtectDirRelatedServer |
| 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. |
| By | No | No | String | Field for sorting. Example: LatestProtectTime |
| Filters | No | No | Array of Filter | Filtering parameter. Valid value: ProtectStatus. Example:View |
| Id | Yes | No | String | Unique ID. Example: 1 |
| Limit | Yes | No | Uint64 | Maximum number of entries to return on each page. Maximum value: 100. Example: 10 |
| Offset | Yes | No | Uint64 | Offset. Example: 0 |
| Order | No | No | String | Sorting method. Example: asc |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| List | Array of ProtectDirRelatedServer | Information about servers associated with the website. Example:View |
| ProtectServerCount | Uint64 | Total number of protected servers. Example: 12 |
| TotalCount | Uint64 | Total number. Example: 12 |
| 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. |
| MissingParameter | Missing parameter. |
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue | The parameter value is invalid. |