{"openapi":"3.1.0","info":{"title":"Converge Cloud — Dedicated Cluster (cdc)","version":"2020-12-14","summary":"6 actions.","description":"Endpoint `https://cdc.api3.convergecloud.com`, region `luzon`, `X-TC-Version: 2020-12-14`.\n\nA wrong `X-TC-Version` returns `InvalidAction`, which is indistinguishable from a missing action — this was the single largest source of false “absent” verdicts in our own measurements."},"servers":[{"url":"https://cdc.api3.convergecloud.com","description":"Converge Cloud production (luzon — the only region)"}],"x-cc-wire-protocol":{"style":"RPC over HTTP POST","realPath":"/","actionHeader":"X-TC-Action","versionHeader":"X-TC-Version","version":"2020-12-14","note":"Every operation in this document is really `POST /` to the server above with `X-TC-Action: <Action>`. Paths of the form `/cdc/<Action>` exist so the actions are individually addressable, linkable and renderable; they are not routes on the server.","signing":"TC3-HMAC-SHA256","region":"luzon","clockSkewSeconds":300},"security":[{"TC3":[]}],"tags":[{"name":"cdc","description":"Dedicated Cluster"}],"paths":{"/cdc/DescribeDedicatedClusterOrders":{"post":{"operationId":"cdc_DescribeDedicatedClusterOrders","summary":"DescribeDedicatedClusterOrders","description":"Query the list of CDC orders.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cdc.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cdc.api3.convergecloud.com/ \\\n  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/cdc/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \\\n  -H 'Content-Type: application/json; charset=utf-8' \\\n  -H 'Host: cdc.api3.convergecloud.com' \\\n  -H 'X-TC-Action: DescribeDedicatedClusterOrders' \\\n  -H 'X-TC-Version: 2020-12-14' \\\n  -H 'X-TC-Timestamp: <unix-seconds>' \\\n  -H 'X-TC-Region: luzon' \\\n  -d '{}'\n```","tags":["cdc"],"deprecated":false,"x-cc-service":"cdc","x-cc-action":"DescribeDedicatedClusterOrders","x-cc-version":"2020-12-14","x-cc-mutating":false,"x-cc-required-params":[],"x-cc-notable-params":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."}}}},"responses":{"200":{"description":"Converge Cloud answers 200 for both success and error. Read `Response.Error` to tell them apart — never the HTTP status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"},"examples":{"recorded1":{"summary":"Example response","value":{"DedicatedClusterOrderSet":[],"TotalCount":0,"RequestId":"ce1789c4-3f14-4756-7dad-2fb98a0bc9e7"}}}}}}}}},"/cdc/DescribeDedicatedClusterTypes":{"post":{"operationId":"cdc_DescribeDedicatedClusterTypes","summary":"DescribeDedicatedClusterTypes","description":"Query the configuration list of the CDC.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cdc.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cdc.api3.convergecloud.com/ \\\n  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/cdc/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \\\n  -H 'Content-Type: application/json; charset=utf-8' \\\n  -H 'Host: cdc.api3.convergecloud.com' \\\n  -H 'X-TC-Action: DescribeDedicatedClusterTypes' \\\n  -H 'X-TC-Version: 2020-12-14' \\\n  -H 'X-TC-Timestamp: <unix-seconds>' \\\n  -H 'X-TC-Region: luzon' \\\n  -d '{}'\n```","tags":["cdc"],"deprecated":false,"x-cc-service":"cdc","x-cc-action":"DescribeDedicatedClusterTypes","x-cc-version":"2020-12-14","x-cc-mutating":false,"x-cc-required-params":[],"x-cc-notable-params":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."}}}},"responses":{"200":{"description":"Converge Cloud answers 200 for both success and error. Read `Response.Error` to tell them apart — never the HTTP status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}}}}},"/cdc/DescribeDedicatedClusters":{"post":{"operationId":"cdc_DescribeDedicatedClusters","summary":"DescribeDedicatedClusters","description":"Query the CDC list.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cdc.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cdc.api3.convergecloud.com/ \\\n  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/cdc/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \\\n  -H 'Content-Type: application/json; charset=utf-8' \\\n  -H 'Host: cdc.api3.convergecloud.com' \\\n  -H 'X-TC-Action: DescribeDedicatedClusters' \\\n  -H 'X-TC-Version: 2020-12-14' \\\n  -H 'X-TC-Timestamp: <unix-seconds>' \\\n  -H 'X-TC-Region: luzon' \\\n  -d '{}'\n```","tags":["cdc"],"deprecated":false,"x-cc-service":"cdc","x-cc-action":"DescribeDedicatedClusters","x-cc-version":"2020-12-14","x-cc-mutating":false,"x-cc-required-params":[],"x-cc-notable-params":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."}}}},"responses":{"200":{"description":"Converge Cloud answers 200 for both success and error. Read `Response.Error` to tell them apart — never the HTTP status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"},"examples":{"recorded1":{"summary":"Example response","value":{"DedicatedClusterSet":[],"TotalCount":0,"RequestId":"4c783b01-554c-e378-93da-36b6c28e2ed9"}}}}}}}}},"/cdc/DescribeDedicatedSupportedZones":{"post":{"operationId":"cdc_DescribeDedicatedSupportedZones","summary":"DescribeDedicatedSupportedZones","description":"Query the list of AZs supported by the CDC.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cdc.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cdc.api3.convergecloud.com/ \\\n  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/cdc/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \\\n  -H 'Content-Type: application/json; charset=utf-8' \\\n  -H 'Host: cdc.api3.convergecloud.com' \\\n  -H 'X-TC-Action: DescribeDedicatedSupportedZones' \\\n  -H 'X-TC-Version: 2020-12-14' \\\n  -H 'X-TC-Timestamp: <unix-seconds>' \\\n  -H 'X-TC-Region: luzon' \\\n  -d '{\"Regions\":\"<Regions>\"}'\n```","tags":["cdc"],"deprecated":false,"x-cc-service":"cdc","x-cc-action":"DescribeDedicatedSupportedZones","x-cc-version":"2020-12-14","x-cc-mutating":false,"x-cc-required-params":["Regions"],"x-cc-notable-params":["Regions"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"Regions":{"type":"array","items":{"type":"string"}}},"required":["Regions"],"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."},"example":{"Regions":"<Regions>"}}}},"responses":{"200":{"description":"Converge Cloud answers 200 for both success and error. Read `Response.Error` to tell them apart — never the HTTP status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}}}}},"/cdc/DescribeSites":{"post":{"operationId":"cdc_DescribeSites","summary":"DescribeSites","description":"Query the site list.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cdc.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cdc.api3.convergecloud.com/ \\\n  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/cdc/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \\\n  -H 'Content-Type: application/json; charset=utf-8' \\\n  -H 'Host: cdc.api3.convergecloud.com' \\\n  -H 'X-TC-Action: DescribeSites' \\\n  -H 'X-TC-Version: 2020-12-14' \\\n  -H 'X-TC-Timestamp: <unix-seconds>' \\\n  -H 'X-TC-Region: luzon' \\\n  -d '{}'\n```","tags":["cdc"],"deprecated":false,"x-cc-service":"cdc","x-cc-action":"DescribeSites","x-cc-version":"2020-12-14","x-cc-mutating":false,"x-cc-required-params":[],"x-cc-notable-params":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."}}}},"responses":{"200":{"description":"Converge Cloud answers 200 for both success and error. Read `Response.Error` to tell them apart — never the HTTP status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"},"examples":{"recorded1":{"summary":"Example response","value":{"SiteSet":[],"TotalCount":0,"RequestId":"7ad2e7e8-7989-2054-99be-a28325d92a4e"}}}}}}}}},"/cdc/DescribeSitesDetail":{"post":{"operationId":"cdc_DescribeSitesDetail","summary":"DescribeSitesDetail","description":"Query site details.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cdc.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cdc.api3.convergecloud.com/ \\\n  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/cdc/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \\\n  -H 'Content-Type: application/json; charset=utf-8' \\\n  -H 'Host: cdc.api3.convergecloud.com' \\\n  -H 'X-TC-Action: DescribeSitesDetail' \\\n  -H 'X-TC-Version: 2020-12-14' \\\n  -H 'X-TC-Timestamp: <unix-seconds>' \\\n  -H 'X-TC-Region: luzon' \\\n  -d '{}'\n```","tags":["cdc"],"deprecated":false,"x-cc-service":"cdc","x-cc-action":"DescribeSitesDetail","x-cc-version":"2020-12-14","x-cc-mutating":false,"x-cc-required-params":[],"x-cc-notable-params":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."}}}},"responses":{"200":{"description":"Converge Cloud answers 200 for both success and error. Read `Response.Error` to tell them apart — never the HTTP status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"},"examples":{"recorded1":{"summary":"Example response","value":{"SiteDetailSet":[],"TotalCount":0,"RequestId":"93a90134-5894-63f1-8fad-60ae0b5d8f6c"}}}}}}}}}},"components":{"securitySchemes":{"TC3":{"type":"apiKey","in":"header","name":"Authorization","description":"TC3-HMAC-SHA256. Credential scope is `<YYYY-MM-DD>/cdc/tc3_request`. The signing service name is a separate input from the hostname — deriving it from the host works until it does not, and the failure looks like an auth bug. Timestamps outside a 300-second window are rejected."}},"schemas":{"Envelope":{"type":"object","description":"Every Converge Cloud response is wrapped in `Response`, success or failure.","properties":{"Response":{"type":"object","properties":{"RequestId":{"type":"string","description":"Always present, including on errors. Quote it to Converge support."},"Error":{"$ref":"#/components/schemas/Error"}},"required":["RequestId"],"additionalProperties":true}},"required":["Response"]},"Error":{"type":"object","description":"Present only on failure. Error messages are Chinese on vpc and dc and English elsewhere — parse `Code`, never `Message`.","properties":{"Code":{"type":"string","examples":["InvalidAction","UnauthorizedOperation","AuthFailure.SignatureFailure","ResourceNotFound","InvalidParameterValue.LimitExceeded"]},"Message":{"type":"string"}},"required":["Code","Message"]}}}}