API reference
Converge Cloud exposes a JSON API over HTTPS. Every service is a separate host under https://<service>.api3.convergecloud.com, region luzon, signed with TC3-HMAC-SHA256.
Endpoints
How to sign a requestOne host per service, all on POST /. The action goes in the X-TC-Action header and the version below in X-TC-Version — sending the wrong version returns InvalidAction, which is indistinguishable from an action that does not exist.
| Service | Host | X-TC-Version | Actions |
|---|---|---|---|
| as | as.api3.convergecloud.com | 2018-04-19 | 23 |
| cam | cam.api3.convergecloud.com | 2019-01-16 | 18 |
| cbs | cbs.api3.convergecloud.com | 2017-03-12 | 31 |
| cdc | cdc.api3.convergecloud.com | 2020-12-14 | 6 |
| cfs | cfs.api3.convergecloud.com | 2019-07-19 | 7 |
| cfw | cfw.api3.convergecloud.com | 2019-09-04 | 4 |
| clb | clb.api3.convergecloud.com | 2018-03-17 | 23 |
| cvm | cvm.api3.convergecloud.com | 2017-03-12 | 38 |
| cwp | cwp.api3.convergecloud.com | 2018-02-28 | 46 |
| monitor | monitor.api3.convergecloud.com | 2018-07-24 | 31 |
| sts | sts.api3.convergecloud.com | 2018-08-13 | 2 |
| tag | tag.api3.convergecloud.com | 2018-08-13 | 12 |
| tke | tke.api3.convergecloud.com | 2018-05-25 | 22 |
| vpc | vpc.api3.convergecloud.com | 2017-03-12 | 55 |
Endpoints and region
The only region on Converge Cloud is luzon. DescribeRegions returns exactly one entry. A request with any X-TC-Region value other than luzon fails with InternalError.
- ncr-129 instance types
- clz-121 instance types
Instance types are not identical across zones. Converge Cloud recommends verifying instance-type availability in the target zone with DescribeZoneInstanceConfigInfos prior to resource allocation.
Regions and availability zonesServices
Full capability matrixObject storage
Object storage is not one of the services above. It answers on its own domain, takes REST requests rather than actions, and is signed a different way — so it has its own reference.
Cloud Object Storageconvergecloudcos.comOpen the referenceConverge Cloud answers HTTP 200 for errors, returns Chinese error messages on some services and English on others, rejects a missing or incorrect X-TC-Region with InternalError, and has a load balancer that reports success while doing nothing. All 21 documented traps.