{"openapi":"3.1.0","info":{"title":"Converge Cloud — Cloud Virtual Machine (cvm)","version":"2017-03-12","summary":"38 actions.","description":"Endpoint `https://cvm.api3.convergecloud.com`, region `luzon`, `X-TC-Version: 2017-03-12`.\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://cvm.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":"2017-03-12","note":"Every operation in this document is really `POST /` to the server above with `X-TC-Action: `. Paths of the form `/cvm/` 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":"cvm","description":"Cloud Virtual Machine"}],"paths":{"/cvm/DescribeRegions":{"post":{"operationId":"cvm_DescribeRegions","summary":"DescribeRegions","description":"Query the list of regions.\nConverge Cloud has a single region, luzon. DescribeRegions is available and responds normally.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: DescribeRegions' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"DescribeRegions","x-cc-version":"2017-03-12","x-cc-mutating":false,"x-cc-required-params":[],"x-cc-notable-params":["RegionSet"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"RegionSet":{"type":"array","items":{"type":"string"},"description":"Optional."}},"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":{"Response":{"TotalCount":1,"RegionSet":[{"Region":"luzon","RegionName":"luzon","RegionState":"AVAILABLE"}],"RequestId":"9f922714-da45-d0f3-19e4-f1e89d33fe06"}}}}}}}}}},"/cvm/DescribeZones":{"post":{"operationId":"cvm_DescribeZones","summary":"DescribeZones","description":"Query availability zones.\nZoneId is returned as a string. tke:DescribeRegions returns RegionId as an integer; the two are not interchangeable.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: DescribeZones' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"DescribeZones","x-cc-version":"2017-03-12","x-cc-mutating":false,"x-cc-required-params":[],"x-cc-notable-params":["ZoneSet"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"ZoneSet":{"type":"array","items":{"type":"string"},"description":"Optional."}},"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":{"Response":{"TotalCount":1,"RegionSet":[{"Region":"luzon","RegionName":"luzon","RegionState":"AVAILABLE"}],"RequestId":"9f922714-da45-d0f3-19e4-f1e89d33fe06"}}}}}}}}}},"/cvm/DescribeInstances":{"post":{"operationId":"cvm_DescribeInstances","summary":"DescribeInstances","description":"Query the details of instances.\nInstance ids that do not exist return TotalCount 0 rather than an error. While an instance is PENDING, ImageId, SecurityGroupIds, PrivateIpAddresses and SystemDisk.DiskId are null, and CreatedTime is rewritten when the instance reaches RUNNING, so it is not a stable launch timestamp.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: DescribeInstances' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{\"Offset\":0,\"Limit\":20}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"DescribeInstances","x-cc-version":"2017-03-12","x-cc-mutating":false,"x-cc-required-params":[],"x-cc-notable-params":["InstanceIds","Filters","Offset","Limit"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"InstanceIds":{"type":"array","items":{"type":"string"},"description":"Optional."},"Filters":{"type":"array","description":"Server-side filters. Unknown filter names are rejected rather than ignored. Optional.","items":{"type":"object","properties":{"Name":{"type":"string"},"Values":{"type":"array","items":{"type":"string"}}},"required":["Name","Values"]}},"Offset":{"type":"integer","minimum":0,"description":"Zero-based pagination offset. Optional."},"Limit":{"type":"integer","minimum":0,"maximum":100,"description":"Page size. Maximum is 100. Optional."}},"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."},"example":{"Offset":0,"Limit":20}}}},"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":{"Response":{"TotalCount":1,"InstanceSet":[{"Placement":{"Zone":"clz-1","HostId":null,"ProjectId":0,"ProjectName":"Default Project"},"InstanceId":"ins-6l9ee4b2","Uuid":"f82652be-ff33-49d8-b888-7f61306ca5be","OperatorUin":"100000000001","InstanceState":"RUNNING","RestrictState":"NORMAL","InstanceType":"M8A.SMALL4","CPU":1,"Memory":4,"InstanceName":"example-instance","InstanceChargeType":"POSTPAID_BY_HOUR","SystemDisk":{"DiskType":"CLOUD_PREMIUM","DiskId":"disk-95nee2g8","DiskSize":50,"Encrypt":false,"KmsKeyId":null,"ThroughputPerformance":0,"CdcId":null},"DataDisks":[],"PrivateIpAddresses":["10.210.1.11"],"PublicIpAddresses":null,"IPv6Addresses":null,"InternetAccessible":{"InternetMaxBandwidthOut":0,"InternetChargeType":null},"VirtualPrivateCloud":{"VpcId":"vpc-0ze6h3yh","SubnetId":"subnet-dshw3oc6","AsVpcGateway":false,"VpcName":"example-instance","SubnetName":"example-instance"},"SecurityGroupIds":["sg-7timlyva"],"LoginSettings":{"KeyIds":null},"ImageId":"img-0utrf2fb","DefaultLoginUser":"ubuntu","DefaultLoginPort":22,"RenewFlag":null,"CreatedTime":"2026-09-16T11:30:26Z","ExpiredTime":null,"UnderwriteExpiredTime":null,"Tags":[],"PlatformProjectId":null,"DisasterRecoverGroupId":"","DedicatedClusterId":"","CamRoleName":"","LatestOperation":"TerminateInstances","LatestOperationState":"OPERATING","LatestOperationRequestId":"935bd5d6-2088-7f33-1263-fdf1c2dbbca2","IsolatedSource":"NOTISOLATED","ChcInstanceType":"","HpcClusterId":"","DisableApiTermination":false,"RdmaIpAddresses":null,"HibernationOptions":{"Configured":false},"VmEniTrunking":"off","OsName":"Ubuntu 24.04 LTS","DisasterRecoverGroupIds":[],"RemainTime":null,"StopChargingMode":"NOT_APPLICABLE","ImageType":"PUBLIC_IMAGE","InstanceFamily":"M8A","GPU":0,"InnerVpcId":67340,"DeviceId":72095001,"Architecture":"x86","IsolatedTime":null,"IsSafeIsolated":false,"SafeIsolatedInfo":null,"NewCreationIdentify":false,"ErrorCode":0,"ErrorKey":null,"InstanceClass":"M","KeyPairIds":null,"OperationMask":14092784333819,"RunFlag":2,"Hypervisor":0,"SwapDisks":{},"LatestOperationErrorMsg":null,"BootMode":"Legacy BIOS","EnableGridLicence":""}],"RequestId":"bd9ec745-c68f-bd99-1d9b-8b6a9a55d822"}}},"recorded2":{"summary":"Example response 2","value":{"Response":{"TotalCount":1,"InstanceSet":[{"Placement":{"Zone":"clz-1","HostId":null,"ProjectId":0,"ProjectName":"Default Project"},"InstanceId":"ins-6l9ee4b2","Uuid":"f82652be-ff33-49d8-b888-7f61306ca5be","OperatorUin":"100000000001","InstanceState":"RUNNING","RestrictState":"NORMAL","InstanceType":"M8A.SMALL4","CPU":1,"Memory":4,"InstanceName":"example-instance","InstanceChargeType":"POSTPAID_BY_HOUR","SystemDisk":{"DiskType":"CLOUD_PREMIUM","DiskId":"disk-95nee2g8","DiskSize":50,"Encrypt":false,"KmsKeyId":null,"ThroughputPerformance":0,"CdcId":null},"DataDisks":[],"PrivateIpAddresses":["10.210.1.11"],"PublicIpAddresses":null,"IPv6Addresses":null,"InternetAccessible":{"InternetMaxBandwidthOut":0,"InternetChargeType":null},"VirtualPrivateCloud":{"VpcId":"vpc-0ze6h3yh","SubnetId":"subnet-dshw3oc6","AsVpcGateway":false,"VpcName":"example-instance","SubnetName":"example-instance"},"SecurityGroupIds":["sg-7timlyva"],"LoginSettings":{"KeyIds":null},"ImageId":"img-0utrf2fb","DefaultLoginUser":"ubuntu","DefaultLoginPort":22,"RenewFlag":null,"CreatedTime":"2026-09-16T11:30:26Z","ExpiredTime":null,"UnderwriteExpiredTime":null,"Tags":[],"PlatformProjectId":null,"DisasterRecoverGroupId":"","DedicatedClusterId":"","CamRoleName":"","LatestOperation":"TerminateInstances","LatestOperationState":"OPERATING","LatestOperationRequestId":"935bd5d6-2088-7f33-1263-fdf1c2dbbca2","IsolatedSource":"NOTISOLATED","ChcInstanceType":"","HpcClusterId":"","DisableApiTermination":false,"RdmaIpAddresses":null,"HibernationOptions":{"Configured":false},"VmEniTrunking":"off","OsName":"Ubuntu 24.04 LTS","DisasterRecoverGroupIds":[],"RemainTime":null,"StopChargingMode":"NOT_APPLICABLE","ImageType":"PUBLIC_IMAGE","InstanceFamily":"M8A","GPU":0,"InnerVpcId":67340,"DeviceId":72095001,"Architecture":"x86","IsolatedTime":null,"IsSafeIsolated":false,"SafeIsolatedInfo":null,"NewCreationIdentify":false,"ErrorCode":0,"ErrorKey":null,"InstanceClass":"M","KeyPairIds":null,"OperationMask":14092784333819,"RunFlag":2,"Hypervisor":0,"SwapDisks":{},"LatestOperationErrorMsg":null,"BootMode":"Legacy BIOS","EnableGridLicence":""}],"RequestId":"a90c8b05-70b2-d882-20b8-f261998c58fa"}}}}}}}}}},"/cvm/DescribeInstancesStatus":{"post":{"operationId":"cvm_DescribeInstancesStatus","summary":"DescribeInstancesStatus","description":"Query the status of instances.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: DescribeInstancesStatus' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{\"Offset\":0,\"Limit\":20}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"DescribeInstancesStatus","x-cc-version":"2017-03-12","x-cc-mutating":false,"x-cc-required-params":[],"x-cc-notable-params":["InstanceIds","Offset","Limit"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"InstanceIds":{"type":"array","items":{"type":"string"},"description":"Optional."},"Offset":{"type":"integer","minimum":0,"description":"Zero-based pagination offset. Optional."},"Limit":{"type":"integer","minimum":0,"maximum":100,"description":"Page size. Maximum is 100. Optional."}},"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."},"example":{"Offset":0,"Limit":20}}}},"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":{"Response":{"TotalCount":1,"InstanceStatusSet":[{"InstanceId":"ins-6l9ee4b2","InstanceState":"STOPPED"}],"RequestId":"d6deda5e-dac5-1b49-d3d1-69577df31988"}}},"recorded2":{"summary":"Example response 2","value":{"Response":{"TotalCount":1,"InstanceStatusSet":[{"InstanceId":"ins-6l9ee4b2","InstanceState":"RUNNING"}],"RequestId":"82b2e193-f471-a80f-5df3-fc608aa4e24e"}}}}}}}}}},"/cvm/DescribeImages":{"post":{"operationId":"cvm_DescribeImages","summary":"DescribeImages","description":"View the list of images.\nRecords carry both IsSupportCloudinit and a lowercase isSupportCloudinit; a case-sensitive parser will match only one.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: DescribeImages' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{\"Offset\":0,\"Limit\":20}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"DescribeImages","x-cc-version":"2017-03-12","x-cc-mutating":false,"x-cc-required-params":[],"x-cc-notable-params":["ImageIds","Filters","Offset","Limit"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"ImageIds":{"type":"array","items":{"type":"string"},"description":"Optional."},"Filters":{"type":"array","description":"Server-side filters. Unknown filter names are rejected rather than ignored. Optional.","items":{"type":"object","properties":{"Name":{"type":"string"},"Values":{"type":"array","items":{"type":"string"}}},"required":["Name","Values"]}},"Offset":{"type":"integer","minimum":0,"description":"Zero-based pagination offset. Optional."},"Limit":{"type":"integer","minimum":0,"maximum":100,"description":"Page size. Maximum is 100. Optional."}},"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."},"example":{"Offset":0,"Limit":20}}}},"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"}}}}}}},"/cvm/DescribeInstanceTypeConfigs":{"post":{"operationId":"cvm_DescribeInstanceTypeConfigs","summary":"DescribeInstanceTypeConfigs","description":"Query the instance type catalogue, returning the CPU, memory and family of every type known to the region.\nReturns the type catalogue, which is a superset of what can be purchased. Memory in a DR3 type name does not match its allocated memory; use the Memory field.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: DescribeInstanceTypeConfigs' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"DescribeInstanceTypeConfigs","x-cc-version":"2017-03-12","x-cc-mutating":false,"x-cc-required-params":[],"x-cc-notable-params":["Filters"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"Filters":{"type":"array","description":"Server-side filters. Unknown filter names are rejected rather than ignored. Optional.","items":{"type":"object","properties":{"Name":{"type":"string"},"Values":{"type":"array","items":{"type":"string"}}},"required":["Name","Values"]}}},"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"}}}}}}},"/cvm/DescribeZoneInstanceConfigInfos":{"post":{"operationId":"cvm_DescribeZoneInstanceConfigInfos","summary":"DescribeZoneInstanceConfigInfos","description":"Query the configurations of models in an availability zone.\nReturns purchasable configurations with Price inline and a Status of SELL or SOLD_OUT per row. Use this rather than the type catalogue to determine what can be launched.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: DescribeZoneInstanceConfigInfos' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"DescribeZoneInstanceConfigInfos","x-cc-version":"2017-03-12","x-cc-mutating":false,"x-cc-required-params":[],"x-cc-notable-params":["Filters"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"Filters":{"type":"array","description":"Server-side filters. Unknown filter names are rejected rather than ignored. Optional.","items":{"type":"object","properties":{"Name":{"type":"string"},"Values":{"type":"array","items":{"type":"string"}}},"required":["Name","Values"]}}},"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"}}}}}}},"/cvm/DescribeInstanceFamilyConfigs":{"post":{"operationId":"cvm_DescribeInstanceFamilyConfigs","summary":"DescribeInstanceFamilyConfigs","description":"Query a list of model families available to the current user in the current region.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: DescribeInstanceFamilyConfigs' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"DescribeInstanceFamilyConfigs","x-cc-version":"2017-03-12","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"}}}}}}},"/cvm/DescribeInternetChargeTypeConfigs":{"post":{"operationId":"cvm_DescribeInternetChargeTypeConfigs","summary":"DescribeInternetChargeTypeConfigs","description":"Query the network billing methods.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: DescribeInternetChargeTypeConfigs' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"DescribeInternetChargeTypeConfigs","x-cc-version":"2017-03-12","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":{"InternetChargeTypeConfigSet":[{"InternetChargeType":"BANDWIDTH_PREPAID"},{"InternetChargeType":"TRAFFIC_POSTPAID_BY_HOUR"},{"InternetChargeType":"BANDWIDTH_POSTPAID_BY_HOUR"},{"InternetChargeType":"BANDWIDTH_PACKAGE"}]}}}}}}}}},"/cvm/DescribeKeyPairs":{"post":{"operationId":"cvm_DescribeKeyPairs","summary":"DescribeKeyPairs","description":"Query key pairs.\nDoes not return private key material. Key pair ids are prefixed skey-.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: DescribeKeyPairs' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{\"Offset\":0,\"Limit\":20}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"DescribeKeyPairs","x-cc-version":"2017-03-12","x-cc-mutating":false,"x-cc-required-params":[],"x-cc-notable-params":["Offset","Limit"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"Offset":{"type":"integer","minimum":0,"description":"Zero-based pagination offset. Optional."},"Limit":{"type":"integer","minimum":0,"maximum":100,"description":"Page size. Maximum is 100. Optional."}},"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."},"example":{"Offset":0,"Limit":20}}}},"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":{"Response":{"TotalCount":1,"KeyPairSet":[{"KeyId":"skey-mcwiow7k","KeyName":"example_key","Description":"","PublicKey":"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDKqAxreoL9jsQdy4pBp/gXUeRUKPVQPNNuDfLeoGxDT37cxYp71wlZjww+zmC61aDYjUlVGg8RfK3i+AS6G7p00eJsJAwAThVZHJUOVw1TDMG95Rf9W6kqxCaUGw7t3x65ZOVobVYEGMGzjCI3/a0F+M1L3f0ZT+W1hEi8KIIBOFhXy/zzUgZaIDmF+Xx0xVDa/8sdKlNtcrXhjjiIoxY+26LxFwqI1lP3QMe0eh4x1QH81Mt69OHY62nsPRi13bPIyQzsR6O9CYROgshoZ8a/BF8K1t+BM8kYdDSAnEitM4icTey30ayqDDYx1vrMVgaeV4G50qe4Y6ClQOc1/sKb skey-mcwiow7k","AssociatedInstanceIds":[],"AssociatedInstanceCount":0,"AssociatedImageCount":0,"ProjectId":0,"CreatedTime":"2026-09-16T11:38:51Z","Tags":[]}],"RequestId":"0e5b5c23-8370-af54-36da-f2d6934980b6"}}},"recorded2":{"summary":"Example response 2","value":{"Response":{"TotalCount":1,"KeyPairSet":[{"KeyId":"skey-fmrp3we4","KeyName":"example_key","Description":"","PublicKey":"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDnr6cJPDQtO7rGCp9YTOhM3ih7ObatFN7NETAvKaE0J/uRPLyIpAZUn/GKCxiVd3H7x1q7BR2G6GFBXAumonhBAkE3CmYwzxBcdl+PeH5eskDqs9GizmBSRL95SdiDob+zAuutSqPcnAQgyPq6uEll5o5cJGPNJBfv+v1NVX9Nz5xNiaRjOYfRXHj72+VXD1kpoj8Er/y1ylS6Pvi+Xmx27mUyIizMY73xst7cVGfGIUcljYzvV45A5svHQD2d1M3TU9r1ooEZny5JTaWO5sRyk7nOEVKHcywgDaEk6dHHrOwQ/6iSaUA8TA/M0uxUq8oAq+SqHRfU1LaIIZWFXY8j skey-fmrp3we4","AssociatedInstanceIds":[],"AssociatedInstanceCount":0,"AssociatedImageCount":0,"ProjectId":0,"CreatedTime":"2026-09-16T11:38:48Z","Tags":[]}],"RequestId":"c5c1662f-baed-308c-9a89-067962676c5b"}}}}}}}}}},"/cvm/DescribeDisasterRecoverGroups":{"post":{"operationId":"cvm_DescribeDisasterRecoverGroups","summary":"DescribeDisasterRecoverGroups","description":"Query the information on spread placement groups.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: DescribeDisasterRecoverGroups' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"DescribeDisasterRecoverGroups","x-cc-version":"2017-03-12","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":{"Response":{"DisasterRecoverGroupSet":[{"DisasterRecoverGroupId":"ps-7icllaix","Name":"example-instance","Type":"HOST","CvmQuotaTotal":50,"CurrentNum":0,"InstanceIds":[],"CreateTime":"2026-09-16T11:30:01Z","Tags":[],"Strategy":"SPREAD","Affinity":1}],"TotalCount":1,"RequestId":"2efe54f2-3ea9-b5ad-741f-5a8e467f0291"}}}}}}}}}},"/cvm/DescribeHosts":{"post":{"operationId":"cvm_DescribeHosts","summary":"DescribeHosts","description":"Query the details of CDH instances.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: DescribeHosts' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"DescribeHosts","x-cc-version":"2017-03-12","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":{"TotalCount":0,"HostSet":[]}}}}}}}}},"/cvm/DescribeImageQuota":{"post":{"operationId":"cvm_DescribeImageQuota","summary":"DescribeImageQuota","description":"Query the image quota of an user account.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: DescribeImageQuota' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"DescribeImageQuota","x-cc-version":"2017-03-12","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":{"ImageNumQuota":50}}}}}}}}},"/cvm/DescribeInstancesOperationLimit":{"post":{"operationId":"cvm_DescribeInstancesOperationLimit","summary":"DescribeInstancesOperationLimit","description":"Query limitations on operations on an instance.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: DescribeInstancesOperationLimit' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{\"InstanceIds\":[\"\"]}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"DescribeInstancesOperationLimit","x-cc-version":"2017-03-12","x-cc-mutating":false,"x-cc-required-params":["InstanceIds"],"x-cc-notable-params":["Operation"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"InstanceIds":{"type":"array","items":{"type":"string"}},"Operation":{"type":"string","description":"Optional."}},"required":["InstanceIds"],"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."},"example":{"InstanceIds":[""]}}}},"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":{"Response":{"InstanceOperationLimitSet":[{"Operation":"INSTANCE_DEGRADE","InstanceId":"ins-6l9ee4b2","CurrentCount":-1,"LimitCount":-1}],"RequestId":"f6725837-3317-7575-a819-51842b1f0ba8"}}}}}}}}}},"/cvm/DescribeInstanceVncUrl":{"post":{"operationId":"cvm_DescribeInstanceVncUrl","summary":"DescribeInstanceVncUrl","description":"Query the VNC console URL for an instance, providing browser-based access to its display.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: DescribeInstanceVncUrl' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{\"InstanceId\":\"\"}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"DescribeInstanceVncUrl","x-cc-version":"2017-03-12","x-cc-mutating":false,"x-cc-required-params":["InstanceId"],"x-cc-notable-params":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"InstanceId":{"type":"string"}},"required":["InstanceId"],"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."},"example":{"InstanceId":""}}}},"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":{"Response":{"InstanceVncUrl":"","RequestId":"747530bf-d565-18cc-68a5-bbc0be14a910"}}}}}}}}}},"/cvm/DescribeImageSharePermission":{"post":{"operationId":"cvm_DescribeImageSharePermission","summary":"DescribeImageSharePermission","description":"Query image sharing information.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: DescribeImageSharePermission' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{\"ImageId\":\"\"}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"DescribeImageSharePermission","x-cc-version":"2017-03-12","x-cc-mutating":false,"x-cc-required-params":["ImageId"],"x-cc-notable-params":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ImageId":{"type":"string"}},"required":["ImageId"],"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."},"example":{"ImageId":""}}}},"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"}}}}}}},"/cvm/InquiryPriceRunInstances":{"post":{"operationId":"cvm_InquiryPriceRunInstances","summary":"InquiryPriceRunInstances","description":"Query the price of creating instances. You can only use this API for instances whose configuration is within the purchase limit. For more information, see RunInstances.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: InquiryPriceRunInstances' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{\"Placement\":\"\",\"ImageId\":\"\"}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"InquiryPriceRunInstances","x-cc-version":"2017-03-12","x-cc-mutating":false,"x-cc-required-params":["Placement","ImageId"],"x-cc-notable-params":["InstanceType","InstanceChargeType","InstanceCount"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"Placement":{"type":"string"},"ImageId":{"type":"string"},"InstanceType":{"type":"string","description":"Optional."},"InstanceChargeType":{"type":"string","description":"Optional."},"InstanceCount":{"type":"integer","description":"Optional."}},"required":["Placement","ImageId"],"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."},"example":{"Placement":"","ImageId":""}}}},"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":{"Placement":{"Zone":"ncr-1"},"ImageId":"img-mjx5nesp","InstanceType":"M8A.SMALL4","InstanceChargeType":"POSTPAID_BY_HOUR","InstanceCount":1}}}}}}}}},"/cvm/RunInstances":{"post":{"operationId":"cvm_RunInstances","summary":"RunInstances","description":"Create one or more instances with a specified configuration.\nReturns InstanceIdSet immediately; the instances are PENDING and reach RUNNING shortly afterwards. Most parameters have defaults, so an under-specified request will still launch billable instances.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: RunInstances' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{\"Placement\":\"\",\"ImageId\":\"\"}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"RunInstances","x-cc-version":"2017-03-12","x-cc-mutating":true,"x-cc-required-params":["Placement","ImageId"],"x-cc-notable-params":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"Placement":{"type":"string"},"ImageId":{"type":"string"}},"required":["Placement","ImageId"],"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."},"example":{"Placement":"","ImageId":""}}}},"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":{"Response":{"InstanceIdSet":["ins-6l9ee4b2"],"RequestId":"607e66ca-d045-933e-fc68-69fa2e51a88c"}}},"error1":{"summary":"Example error response 1","value":{"Response":{"Error":{"Code":"InvalidImageId.NotFound","Message":"ImageId img-00000000 is not found"},"RequestId":"9b8cfed8-afba-00aa-7b2e-d3785b64bbac"}}}}}}}}}},"/cvm/TerminateInstances":{"post":{"operationId":"cvm_TerminateInstances","summary":"TerminateInstances","description":"Return instances.\nReturns only a RequestId. The instance disappears from DescribeInstances within a few seconds; there is no TERMINATED state to observe. The system disk is deleted with the instance. Rejected with UnsupportedOperation.InstanceStateRebooting while the instance is rebooting.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: TerminateInstances' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{\"InstanceIds\":[\"\"]}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"TerminateInstances","x-cc-version":"2017-03-12","x-cc-mutating":true,"x-cc-required-params":["InstanceIds"],"x-cc-notable-params":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"InstanceIds":{"type":"array","items":{"type":"string"}}},"required":["InstanceIds"],"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."},"example":{"InstanceIds":[""]}}}},"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":{"Response":{"RequestId":"935bd5d6-2088-7f33-1263-fdf1c2dbbca2"}}},"error1":{"summary":"Example error response 1","value":{"Response":{"Error":{"Code":"InvalidInstanceId.NotFound","Message":"The specified instance ID `['ins-00000000']` is not found."},"RequestId":"9f03054d-3430-7088-0d60-1698faae9216"}}},"error2":{"summary":"Example error response 2","value":{"Response":{"Error":{"Code":"UnsupportedOperation.InstanceStateRebooting","Message":"The request does not support the instance `ins-6l9ee4b2` which is in the state of `REBOOTING`."},"RequestId":"d47b3760-6deb-b5d2-6162-1a01d7018a3f"}}}}}}}}}},"/cvm/StartInstances":{"post":{"operationId":"cvm_StartInstances","summary":"StartInstances","description":"Start instances.\nRejected with UnsupportedOperation.InstanceStateRunning if the instance is already running.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: StartInstances' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{\"InstanceIds\":[\"\"]}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"StartInstances","x-cc-version":"2017-03-12","x-cc-mutating":true,"x-cc-required-params":["InstanceIds"],"x-cc-notable-params":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"InstanceIds":{"type":"array","items":{"type":"string"}}},"required":["InstanceIds"],"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."},"example":{"InstanceIds":[""]}}}},"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":{"Response":{"RequestId":"dfbcacd1-75af-ff2c-f435-37aeeabdaa1f"}}},"error1":{"summary":"Example error response 1","value":{"Response":{"Error":{"Code":"UnsupportedOperation.InstanceStateRunning","Message":"The request does not support the instance `ins-6l9ee4b2` which is in the state of `RUNNING`."},"RequestId":"e99255fa-689f-5faf-94c6-d6bd36e48c34"}}}}}}}}}},"/cvm/StopInstances":{"post":{"operationId":"cvm_StopInstances","summary":"StopInstances","description":"Shut down instances.\nStoppedMode STOP_CHARGING is honoured: StopChargingMode changes to STOP_CHARGING once the instance is STOPPED.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: StopInstances' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{\"InstanceIds\":[\"\"]}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"StopInstances","x-cc-version":"2017-03-12","x-cc-mutating":true,"x-cc-required-params":["InstanceIds"],"x-cc-notable-params":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"InstanceIds":{"type":"array","items":{"type":"string"}}},"required":["InstanceIds"],"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."},"example":{"InstanceIds":[""]}}}},"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":{"Response":{"RequestId":"f7a37619-7ebb-bf7f-a03f-69ff828992d5"}}}}}}}}}},"/cvm/RebootInstances":{"post":{"operationId":"cvm_RebootInstances","summary":"RebootInstances","description":"Restart instances.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: RebootInstances' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{\"InstanceIds\":[\"\"]}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"RebootInstances","x-cc-version":"2017-03-12","x-cc-mutating":true,"x-cc-required-params":["InstanceIds"],"x-cc-notable-params":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"InstanceIds":{"type":"array","items":{"type":"string"}}},"required":["InstanceIds"],"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."},"example":{"InstanceIds":[""]}}}},"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":{"Response":{"RequestId":"42cc64f6-f154-7abe-11a8-c472040482bb"}}}}}}}}}},"/cvm/ResetInstance":{"post":{"operationId":"cvm_ResetInstance","summary":"ResetInstance","description":"Reinstall the operating system on a specified instance.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: ResetInstance' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{\"InstanceId\":\"\"}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"ResetInstance","x-cc-version":"2017-03-12","x-cc-mutating":true,"x-cc-required-params":["InstanceId"],"x-cc-notable-params":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"InstanceId":{"type":"string"}},"required":["InstanceId"],"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."},"example":{"InstanceId":""}}}},"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"}}}}}}},"/cvm/ResetInstancesType":{"post":{"operationId":"cvm_ResetInstancesType","summary":"ResetInstancesType","description":"Change the model of an instance.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: ResetInstancesType' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{\"InstanceIds\":[\"\"],\"InstanceType\":\"\"}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"ResetInstancesType","x-cc-version":"2017-03-12","x-cc-mutating":true,"x-cc-required-params":["InstanceIds","InstanceType"],"x-cc-notable-params":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"InstanceIds":{"type":"array","items":{"type":"string"}},"InstanceType":{"type":"string"}},"required":["InstanceIds","InstanceType"],"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."},"example":{"InstanceIds":[""],"InstanceType":""}}}},"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"}}}}}}},"/cvm/ModifyInstancesAttribute":{"post":{"operationId":"cvm_ModifyInstancesAttribute","summary":"ModifyInstancesAttribute","description":"Modify instance attributes.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: ModifyInstancesAttribute' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{\"InstanceIds\":[\"\"]}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"ModifyInstancesAttribute","x-cc-version":"2017-03-12","x-cc-mutating":true,"x-cc-required-params":["InstanceIds"],"x-cc-notable-params":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"InstanceIds":{"type":"array","items":{"type":"string"}}},"required":["InstanceIds"],"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."},"example":{"InstanceIds":[""]}}}},"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":{"Response":{"RequestId":"5ea47dd2-caa3-260f-25ed-d506554a288c"}}}}}}}}}},"/cvm/ModifyInstancesProject":{"post":{"operationId":"cvm_ModifyInstancesProject","summary":"ModifyInstancesProject","description":"Change the project to which an instance is assigned.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: ModifyInstancesProject' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{\"InstanceIds\":[\"\"],\"ProjectId\":\"\"}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"ModifyInstancesProject","x-cc-version":"2017-03-12","x-cc-mutating":true,"x-cc-required-params":["InstanceIds","ProjectId"],"x-cc-notable-params":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"InstanceIds":{"type":"array","items":{"type":"string"}},"ProjectId":{"type":"string"}},"required":["InstanceIds","ProjectId"],"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."},"example":{"InstanceIds":[""],"ProjectId":""}}}},"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"}}}}}}},"/cvm/ModifyInstancesRenewFlag":{"post":{"operationId":"cvm_ModifyInstancesRenewFlag","summary":"ModifyInstancesRenewFlag","description":"Modify the renewal flag of monthly subscription instances.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: ModifyInstancesRenewFlag' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{\"InstanceIds\":[\"\"],\"RenewFlag\":\"\"}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"ModifyInstancesRenewFlag","x-cc-version":"2017-03-12","x-cc-mutating":true,"x-cc-required-params":["InstanceIds","RenewFlag"],"x-cc-notable-params":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"InstanceIds":{"type":"array","items":{"type":"string"}},"RenewFlag":{"type":"string"}},"required":["InstanceIds","RenewFlag"],"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."},"example":{"InstanceIds":[""],"RenewFlag":""}}}},"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"}}}}}}},"/cvm/ModifyInstancesVpcAttribute":{"post":{"operationId":"cvm_ModifyInstancesVpcAttribute","summary":"ModifyInstancesVpcAttribute","description":"Modify the VPC attributes of an instance, such as the VPC IP address.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: ModifyInstancesVpcAttribute' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{\"InstanceIds\":[\"\"],\"VirtualPrivateCloud\":\"\"}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"ModifyInstancesVpcAttribute","x-cc-version":"2017-03-12","x-cc-mutating":true,"x-cc-required-params":["InstanceIds","VirtualPrivateCloud"],"x-cc-notable-params":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"InstanceIds":{"type":"array","items":{"type":"string"}},"VirtualPrivateCloud":{"type":"string"}},"required":["InstanceIds","VirtualPrivateCloud"],"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."},"example":{"InstanceIds":[""],"VirtualPrivateCloud":""}}}},"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"}}}}}}},"/cvm/ResizeInstanceDisks":{"post":{"operationId":"cvm_ResizeInstanceDisks","summary":"ResizeInstanceDisks","description":"Expand the data disks of an instance.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: ResizeInstanceDisks' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{\"InstanceId\":\"\",\"DataDisks\":\"\"}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"ResizeInstanceDisks","x-cc-version":"2017-03-12","x-cc-mutating":true,"x-cc-required-params":["InstanceId","DataDisks"],"x-cc-notable-params":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"InstanceId":{"type":"string"},"DataDisks":{"type":"string"}},"required":["InstanceId","DataDisks"],"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."},"example":{"InstanceId":"","DataDisks":""}}}},"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"}}}}}}},"/cvm/CreateImage":{"post":{"operationId":"cvm_CreateImage","summary":"CreateImage","description":"Create a new image with the system disk of an instance. The image can be used to create new instances.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: CreateImage' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{\"ImageName\":\"\"}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"CreateImage","x-cc-version":"2017-03-12","x-cc-mutating":true,"x-cc-required-params":["ImageName"],"x-cc-notable-params":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ImageName":{"type":"string"}},"required":["ImageName"],"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."},"example":{"ImageName":""}}}},"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"}}}}}}},"/cvm/DeleteImages":{"post":{"operationId":"cvm_DeleteImages","summary":"DeleteImages","description":"Delete one or more images.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: DeleteImages' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{\"ImageIds\":[\"\"]}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"DeleteImages","x-cc-version":"2017-03-12","x-cc-mutating":true,"x-cc-required-params":["ImageIds"],"x-cc-notable-params":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ImageIds":{"type":"array","items":{"type":"string"}}},"required":["ImageIds"],"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."},"example":{"ImageIds":[""]}}}},"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"}}}}}}},"/cvm/CreateKeyPair":{"post":{"operationId":"cvm_CreateKeyPair","summary":"CreateKeyPair","description":"Create an `OpenSSH RSA` key pair, which you can use to log in to a `Linux` instance.\nKey pair names accept letters, digits and underscores; a hyphen is rejected. The private key is returned once in this response and cannot be retrieved afterwards.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: CreateKeyPair' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{\"KeyName\":\"\",\"ProjectId\":\"\"}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"CreateKeyPair","x-cc-version":"2017-03-12","x-cc-mutating":true,"x-cc-required-params":["KeyName","ProjectId"],"x-cc-notable-params":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"KeyName":{"type":"string"},"ProjectId":{"type":"string"}},"required":["KeyName","ProjectId"],"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."},"example":{"KeyName":"","ProjectId":""}}}},"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":{"Response":{"KeyPair":{"KeyId":"skey-fmrp3we4","KeyName":"example_key","ProjectId":0,"PublicKey":"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDnr6cJPDQtO7rGCp9YTOhM3ih7ObatFN7NETAvKaE0J/uRPLyIpAZUn/GKCxiVd3H7x1q7BR2G6GFBXAumonhBAkE3CmYwzxBcdl+PeH5eskDqs9GizmBSRL95SdiDob+zAuutSqPcnAQgyPq6uEll5o5cJGPNJBfv+v1NVX9Nz5xNiaRjOYfRXHj72+VXD1kpoj8Er/y1ylS6Pvi+Xmx27mUyIizMY73xst7cVGfGIUcljYzvV45A5svHQD2d1M3TU9r1ooEZny5JTaWO5sRyk7nOEVKHcywgDaEk6dHHrOwQ/6iSaUA8TA/M0uxUq8oAq+SqHRfU1LaIIZWFXY8j skey-fmrp3we4","PrivateKey":"[redacted]","AssociatedInstanceCount":0,"AssociatedImageCount":0},"RequestId":"6d2f6565-3df8-e684-5544-7d6cb5a64c3d"}}},"error1":{"summary":"Example error response 1","value":{"Response":{"Error":{"Code":"InvalidParameterValue","Message":"The specified key pair name `example-instance` is include illegal character `-`."},"RequestId":"3bc14f3b-f7c0-8a5f-f446-c247680f5473"}}},"error2":{"summary":"Example error response 2","value":{"Response":{"Error":{"Code":"InvalidParameterValue","Message":"The specified key pair name `example-instance` is include illegal character `-`."},"RequestId":"4035ca6c-3564-917e-a41b-366a91bafdb3"}}}}}}}}}},"/cvm/ImportKeyPair":{"post":{"operationId":"cvm_ImportKeyPair","summary":"ImportKeyPair","description":"Import key pairs.\nThe public key comment is replaced with the assigned key id.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: ImportKeyPair' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{\"KeyName\":\"\",\"PublicKey\":\"\"}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"ImportKeyPair","x-cc-version":"2017-03-12","x-cc-mutating":true,"x-cc-required-params":["KeyName","PublicKey"],"x-cc-notable-params":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"KeyName":{"type":"string"},"PublicKey":{"type":"string"}},"required":["KeyName","PublicKey"],"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."},"example":{"KeyName":"","PublicKey":""}}}},"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":{"Response":{"KeyId":"skey-mcwiow7k","RequestId":"5b3b46be-93eb-07e3-4262-3fad0bcebc2b"}}},"error1":{"summary":"Example error response 1","value":{"Response":{"Error":{"Code":"InvalidParameterValue","Message":"The specified key pair name `example-instance` is include illegal character `-`."},"RequestId":"4843a470-5a5c-e5a6-1b2e-66ab3ba83bab"}}}}}}}}}},"/cvm/DeleteKeyPairs":{"post":{"operationId":"cvm_DeleteKeyPairs","summary":"DeleteKeyPairs","description":"Delete hosted key pairs.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: DeleteKeyPairs' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{\"KeyIds\":[\"\"]}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"DeleteKeyPairs","x-cc-version":"2017-03-12","x-cc-mutating":true,"x-cc-required-params":["KeyIds"],"x-cc-notable-params":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"KeyIds":{"type":"array","items":{"type":"string"}}},"required":["KeyIds"],"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."},"example":{"KeyIds":[""]}}}},"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":{"Response":{"RequestId":"ebdf46f8-1f8e-ee71-e2e9-55dcb4984253"}}},"recorded2":{"summary":"Example response 2","value":{"Response":{"RequestId":"db234976-e6dc-96c0-68bc-49b6070a3827"}}},"error1":{"summary":"Example error response 1","value":{"Response":{"Error":{"Code":"InvalidKeyPairId.Malformed","Message":"The specified key pair ID `.KeyIds` `skp-00000000` is malformed. Ensure that you provide the full key pair ID in the request, in the form skey-xxxxxxxx.The letter `x` stands for lowercase letter or number."},"RequestId":"d25778aa-b246-c43a-dd65-ffe16bef00ab"}}},"error2":{"summary":"Example error response 2","value":{"Response":{"Error":{"Code":"InvalidKeyPairId.Malformed","Message":"The specified key pair ID `.KeyIds` `skp-00000000` is malformed. Ensure that you provide the full key pair ID in the request, in the form skey-xxxxxxxx.The letter `x` stands for lowercase letter or number."},"RequestId":"11fc5c41-6b0e-45e9-9084-9e0ec93f15d6"}}}}}}}}}},"/cvm/AssociateInstancesKeyPairs":{"post":{"operationId":"cvm_AssociateInstancesKeyPairs","summary":"AssociateInstancesKeyPairs","description":"Associate key pairs with instances.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: AssociateInstancesKeyPairs' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{\"KeyIds\":[\"\"],\"InstanceIds\":[\"\"]}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"AssociateInstancesKeyPairs","x-cc-version":"2017-03-12","x-cc-mutating":true,"x-cc-required-params":["KeyIds","InstanceIds"],"x-cc-notable-params":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"KeyIds":{"type":"array","items":{"type":"string"}},"InstanceIds":{"type":"array","items":{"type":"string"}}},"required":["KeyIds","InstanceIds"],"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."},"example":{"KeyIds":[""],"InstanceIds":[""]}}}},"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"}}}}}}},"/cvm/CreateDisasterRecoverGroup":{"post":{"operationId":"cvm_CreateDisasterRecoverGroup","summary":"CreateDisasterRecoverGroup","description":"Create a spread placement group. After you create one, you can specify it for an instance when you create the instance,.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: CreateDisasterRecoverGroup' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{\"Name\":\"\",\"Type\":\"\"}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"CreateDisasterRecoverGroup","x-cc-version":"2017-03-12","x-cc-mutating":true,"x-cc-required-params":["Name","Type"],"x-cc-notable-params":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"Name":{"type":"string"},"Type":{"type":"string"}},"required":["Name","Type"],"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."},"example":{"Name":"","Type":""}}}},"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":{"Response":{"owner":"1250000000","Type":"HOST","DisasterRecoverGroupId":"ps-7icllaix","Name":"example-instance","CvmQuotaTotal":50,"CurrentNum":0,"CreateTime":"2026-09-16T11:30:01Z","Affinity":1,"Strategy":"SPREAD","RequestId":"770e64aa-f848-c89d-d0b9-3f42a4b6ae1e"}}}}}}}}}},"/cvm/DeleteDisasterRecoverGroups":{"post":{"operationId":"cvm_DeleteDisasterRecoverGroups","summary":"DeleteDisasterRecoverGroups","description":"Delete a spread placement group. Only empty placement groups can be deleted. To delete a non-empty group, you need to terminate all the CVM instances in it first. Otherwise, the deletion will fail.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: DeleteDisasterRecoverGroups' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{\"DisasterRecoverGroupIds\":[\"\"]}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"DeleteDisasterRecoverGroups","x-cc-version":"2017-03-12","x-cc-mutating":true,"x-cc-required-params":["DisasterRecoverGroupIds"],"x-cc-notable-params":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"DisasterRecoverGroupIds":{"type":"array","items":{"type":"string"}}},"required":["DisasterRecoverGroupIds"],"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."},"example":{"DisasterRecoverGroupIds":[""]}}}},"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":{"Response":{"RequestId":"59ced55e-3c2f-0b25-eb9f-bd150f437ff9"}}},"error1":{"summary":"Example error response 1","value":{"Response":{"Error":{"Code":"ResourceNotFound.InvalidPlacementSet","Message":"Invalid placement set `ps-00000000`."},"RequestId":"5a53fae1-b629-ae94-7c11-507cdf1f3ac9"}}}}}}}}}},"/cvm/AllocateHosts":{"post":{"operationId":"cvm_AllocateHosts","summary":"AllocateHosts","description":"Create CDH instances with specified configuration.\n**Wire call.** This path is a documentation convenience. Converge Cloud is RPC-over-HTTP: every action is a single `POST /` to `cvm.api3.convergecloud.com` with the action name in the `X-TC-Action` header. The real request is:\n```bash\ncurl -sS https://cvm.api3.convergecloud.com/ \\\n -H 'Authorization: TC3-HMAC-SHA256 Credential=//cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=' \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -H 'Host: cvm.api3.convergecloud.com' \\\n -H 'X-TC-Action: AllocateHosts' \\\n -H 'X-TC-Version: 2017-03-12' \\\n -H 'X-TC-Timestamp: ' \\\n -H 'X-TC-Region: luzon' \\\n -d '{\"Placement\":\"\",\"HostType\":\"\",\"HostChargePrepaid\":\"\"}'\n```","tags":["cvm"],"deprecated":false,"x-cc-service":"cvm","x-cc-action":"AllocateHosts","x-cc-version":"2017-03-12","x-cc-mutating":true,"x-cc-required-params":["Placement","HostType","HostChargePrepaid"],"x-cc-notable-params":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"Placement":{"type":"string"},"HostType":{"type":"string"},"HostChargePrepaid":{"type":"string"}},"required":["Placement","HostType","HostChargePrepaid"],"additionalProperties":true,"description":"The fields listed here are the ones in common use. Additional parameters are also accepted."},"example":{"Placement":"","HostType":"","HostChargePrepaid":""}}}},"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"}}}}}}}},"components":{"securitySchemes":{"TC3":{"type":"apiKey","in":"header","name":"Authorization","description":"TC3-HMAC-SHA256. Credential scope is `/cvm/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"]}}}}