Converge Studios
clb — Cloud Load Balancer
clb · 2018-03-17

DescribeTaskStatus

POST

Query the execution status of an async task. After non-query APIs (used to create/delete CLB instances, listeners, or rules or to bind/unbind real servers) are called successfully, this API needs to be used to query whether the task is successful.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /clb/DescribeTaskStatus 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://clb.api3.convergecloud.com/ \
  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/clb/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Host: clb.api3.convergecloud.com' \
  -H 'X-TC-Action: DescribeTaskStatus' \
  -H 'X-TC-Version: 2018-03-17' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{}'

Request parameters

FieldTypeRequiredDescription
TaskIdstring—Request ID, i.e., the RequestId parameter returned by the API.
DealNamestring—Order ID.

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.

FieldTypeDescription
StatusintegerCurrent status of a task. Value range: 0 (succeeded), 1 (failed), 2 (in progress).
LoadBalancerIdsstring[]Array of unique CLB instance IDs.
MessagestringAuxiliary description information, such as failure cause.
RequestIdstringThe 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": {
    "Status": …,
    "LoadBalancerIds": …,
    "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/clb.
Request bodyvalid JSONPOST clb.api3.convergecloud.com · DescribeTaskStatus
Read-only. Creates nothing.
Recorded example response
{
  "Response": {
    "Status": 0,
    "RequestId": "1c1a1061-d4dc-8656-7245-be6efc033e88"
  }
}