cwp · 2018-02-28

DescribeVulCountByDates

POST

Obtain the number of vulnerabilities of specified types in recent days and the number 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/DescribeVulCountByDates 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: DescribeVulCountByDates' \
  -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
LastDays	string[]	—	Number of past days for data query. Subtract 1 from the actual number of days and fill in the value.
VulCategory	integer	—	Vulnerability category. 1: web CMS vulnerability; 2: application vulnerability; 4: Linux software vulnerability; 5: Windows system vulnerability.
IfEmergency	string	—	Whether the vulnerabilities are emergency vulnerabilities. yes: yes.

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
VulCount	string[]	Obtain the number of vulnerabilities for corresponding days in batch
HostCount	string[]	Obtain the number of hosts for corresponding days in batch
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": {
    "VulCount": …,
    "HostCount": …,
    "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.

SecretIdSecretKey

Request bodyvalid JSONPOST cwp.api3.convergecloud.com · DescribeVulCountByDates

{}

Read-only. Creates nothing.