cwp — Cloud Workload Protection
cwp · 2018-02-28
DescribeGeneralStat
POST
Obtain the statistics data of hosts.
Wire call
Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cwp/DescribeGeneralStat path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.
curl
curl -sS https://cwp.api3.convergecloud.com/ \
-H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/cwp/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'Host: cwp.api3.convergecloud.com' \
-H 'X-TC-Action: DescribeGeneralStat' \
-H 'X-TC-Version: 2018-02-28' \
-H 'X-TC-Timestamp: <unix-seconds>' \
-H 'X-TC-Region: luzon' \
-d '{}'Request parameters
| Field | Type | Required | Description |
|---|---|---|---|
| MachineType | string | — | CVM type |
| MachineRegion | string | — | Machine region. Example: ap-guangzhou, ap-shanghai |
Response
Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.
| Field | Type | Description |
|---|---|---|
| MachinesAll | integer | Total number of hosts |
| MachinesUninstalled | integer | Total number of hosts not installed with the CWPP client |
| AgentsAll | integer | Total number of CWPP clients |
| AgentsOnline | integer | Total number of online CWPP clients |
| AgentsOffline | integer | Total number of CWPP clients that are offline and shut down |
| AgentsPro | integer | Total number of Pro Edition CWPP clients |
| AgentsBasic | integer | Total number of Basic Edition CWPP clients |
| AgentsProExpireWithInSevenDays | integer | Total number of prepaid Pro Edition CWPP clients that will expire in 7 days |
| RiskMachine | integer | Total number of risky hosts |
| Shutdown | integer | Total number of hosts that are shut down |
| Offline | integer | Total number of offline hosts |
| FlagshipMachineCnt | integer | Number of Ultimate Edition hosts |
| ProtectDays | integer | Protection duration, in days |
| AddedOnTheFifteen | integer | Number of hosts added in the last 15 days |
| RequestId | string | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Success
{
"Response": {
"MachinesAll": …,
"MachinesUninstalled": …,
"RequestId": "…"
}
}Error
{
"Response": {
"Error": { "Code": "…", "Message": "…" },
"RequestId": "…"
}
}Try it
CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/cwp.
Request bodyvalid JSONPOST cwp.api3.convergecloud.com · DescribeGeneralStat
Read-only. Creates nothing.
Recorded example response
{
"AddedOnTheFifteen": 0,
"AgentsAll": 0,
"AgentsBasic": 0,
"AgentsOffline": 0,
"AgentsOnline": 0,
"AgentsPro": 0,
"AgentsProExpireWithInSevenDays": 0,
"FlagshipMachineCnt": 0,
"MachinesAll": 0,
"MachinesUninstalled": 0,
"Offline": 0,
"ProtectDays": 0,
"RiskMachine": 0,
"Shutdown": 0
}Behaviour
Read this before interpreting vulnerability counts: a count of zero means nothing has been scanned rather than that nothing was found.