Converge Studios
cdc — Dedicated Cluster
cdc · 2020-12-14

DescribeDedicatedSupportedZones

POST

Query the list of AZs supported by the CDC.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cdc/DescribeDedicatedSupportedZones 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: DescribeDedicatedSupportedZones' \
  -H 'X-TC-Version: 2020-12-14' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{"Regions":"<Regions>"}'

Request parameters

FieldTypeRequiredDescription
Regionsstring[]YesList of input regions

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
ZoneSetRegionZoneInfo[]List of supported AZs
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": {
    "ZoneSet": …,
    "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.
Request bodyvalid JSONPOST cdc.api3.convergecloud.com · DescribeDedicatedSupportedZones
Read-only. Creates nothing.