cwp — Cloud Workload Protection
cwp · 2018-02-28
DescribeMachines
POST
Obtain the list of hosts in a specific region.
Wire call
Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cwp/DescribeMachines 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: DescribeMachines' \
-H 'X-TC-Version: 2018-02-28' \
-H 'X-TC-Timestamp: <unix-seconds>' \
-H 'X-TC-Region: luzon' \
-d '{"MachineRegion":"<MachineRegion>","MachineType":"<MachineType>"}'Request parameters
| Field | Type | Required | Description |
|---|---|---|---|
| MachineType | string | Yes | Type of the machine's zone |
| MachineRegion | string | Yes | Machine region. For example, ap-guangzhou and ap-shanghai. |
| Limit | integer | No | Number of returns. It is 10 by default, and the maximum value is 100. |
| Offset | integer | No | Offset. Default value: 0. |
| Filters | Filter[] | No | Filter criteria |
| ProjectIds | string[] | No | ID List of Businesses to which machines belong |
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 |
|---|---|---|
| Machines | Machine[] | List of hosts |
| TotalCount | integer | Number of hosts |
| 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": {
"Machines": …,
"TotalCount": …,
"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 · DescribeMachines
Read-only. Creates nothing.