cdc · 2020-12-14

DescribeDedicatedClusterOrders

POST

Query the list of CDC orders.

Wire call

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

Request parameters

Field	Type	Required	Description
DedicatedClusterIds	string[]	—	Filter by CDC id.
DedicatedClusterOrderIds	string	—	Filter by CDC order id.
Offset	integer	—	Offset, 0 by default For further information on Offset, please refer to relevant sections in API [Overview].
Limit	integer	—	Number of returned pieces, 20 by default and can be up to 100. For further information on Limit, please refer to relevant sections in API [Overview].
Status	string	—	The order status is the filter condition: PENDING INCONSTRUCTION DELIVERING DELIVERED EXPIRED CANCELLED OFFLINE
ActionType	string	—	The order type is the filter condition: CREATE EXTEND
OrderTypes	string[]	—	Order Type List

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
DedicatedClusterOrderSet	DedicatedClusterOrder[]	List of CDC orders
TotalCount	integer	Total number of CDC orders that meet the conditions
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": {
    "DedicatedClusterOrderSet": …,
    "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/cdc.

SecretIdSecretKey

Request bodyvalid JSONPOST cdc.api3.convergecloud.com · DescribeDedicatedClusterOrders

{}

Read-only. Creates nothing.

Recorded example response

{
  "DedicatedClusterOrderSet": [],
  "TotalCount": 0,
  "RequestId": "ce1789c4-3f14-4756-7dad-2fb98a0bc9e7"
}