Tenant Cloud
Security
Cloud Workload Protection Platform
Advanced Defense APIs
DescribeWebPageServiceInfo
1. Interface Description
Interface request domain name: cwp.api3.convergecloud.com.
This API is used to query the purchase information about the web page anti-tampering service and the relevant server information.
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: DescribeWebPageServiceInfo |
| 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. |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| AllAuthorizedMachines | Array of ProtectMachineInfo | Information about all licensed servers. Example:View |
| BuyNum | Uint64 | Number of purchased licenses. Example: 1 |
| ExpireAuthorizedMachines | Array of ProtectMachine | Information about servers with licenses that are about to expire. Example:View |
| ExpireNum | Uint64 | Number of licenses that is about to expire. Example: 1 |
| ExpiredNum | Uint64 | Number of expired licenses. Example: 1 |
| ProtectDirNum | Uint64 | Number of protected directories. Example: 1 |
| ResidueNum | Uint64 | Number of available licenses. Example: 1 |
| Status | Bool | Indicates whether the service is purchased. true: yes. false: no. Example: true |
| UsedNum | Uint64 | Number of used licenses. 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. |