cwp — Cloud Workload Protection
cwp · 2018-02-28
DescribeAgentInstallCommand
POST
Obtain the agent installation command.
Wire call
Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cwp/DescribeAgentInstallCommand 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: DescribeAgentInstallCommand' \
-H 'X-TC-Version: 2018-02-28' \
-H 'X-TC-Timestamp: <unix-seconds>' \
-H 'X-TC-Region: luzon' \
-d '{"IsCloud":false,"NetType":"<NetType>"}'Request parameters
| Field | Type | Required | Description |
|---|---|---|---|
| IsCloud | boolean | Yes | Whether Converge Cloud |
| NetType | string | Yes | Network type: basic - basic network; private - VPC; public - public network; direct - direct connect |
| RegionCode | string | No | Region identifier, required when NetType=direct |
| VpcId | string | No | VpcId, required when NetType=direct |
| TagIds | string[] | No | Tag ID list, effective only when IsCloud=false |
| ExpireDate | string | No | Command validity period, required for non-Converge Cloud instances |
| Vip | string | No | VIP Accessed via Proxy Mode |
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 |
|---|---|---|
| LinuxCommand | string | Linux installation command |
| WindowsCommand | string | Windows installation command (Windows 2008 or later) |
| WindowsStepOne | string | Step 1 of Window installation command (Windows 2003) |
| WindowsStepTwo | string | Step 2 of Window installation command (Windows 2003) |
| WindowsDownloadUrl | string | Download URL of the agent for Windows |
| ARMCommand | string | Arm installation command |
| 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": {
"LinuxCommand": …,
"WindowsCommand": …,
"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 · DescribeAgentInstallCommand
Read-only. Creates nothing.