cvm — Cloud Virtual Machine
cvm · 2017-03-12
CreateDisasterRecoverGroup
POST
Create a spread placement group. After you create one, you can specify it for an instance when you create the instance,.
Wire call
Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cvm/CreateDisasterRecoverGroup path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.
curl
curl -sS https://cvm.api3.convergecloud.com/ \
-H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'Host: cvm.api3.convergecloud.com' \
-H 'X-TC-Action: CreateDisasterRecoverGroup' \
-H 'X-TC-Version: 2017-03-12' \
-H 'X-TC-Timestamp: <unix-seconds>' \
-H 'X-TC-Region: luzon' \
-d '{"Name":"<Name>","Type":"<Type>"}'Request parameters
| Field | Type | Required | Description |
|---|---|---|---|
| Name | string | Yes | Name of the spread placement group. The name must be 1-60 characters long and can contain both Chinese characters and English letters. |
| Type | string | Yes | Type of a spread placement group. Valid values: HOST: physical machine. SW: switch. RACK: rack. |
| ClientToken | string | No | A string used to ensure the idempotency of the request, which is generated by the user and must be unique to each request. The maximum length is 64 ASCII characters. If this parameter is not specified, the idempotency of the request cannot be guaranteed. For more information, see 'How to ensure idempotency'. |
| Affinity | integer | No | The affinity of the placement group. Instances in the placement group are distributed according to this affinity. The affinity value range is: 1-10, and defaults to 1. |
| TagSpecification | TagSpecification[] | No | List of tag description. By specifying this parameter, the tag can be bound to the placement group. |
Response
Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.
| Field | Type | Description |
|---|---|---|
| DisasterRecoverGroupId | string | List of spread placement group IDs. |
| Type | string | Type of a spread placement group. Valid values: HOST: physical machine. SW: switch. RACK: rack. |
| Name | string | Name of the spread placement group. The name must be 1-60 characters long and can contain both Chinese characters and English letters. |
| CvmQuotaTotal | integer | The maximum number of CVMs in a placement group. |
| CurrentNum | integer | The current number of CVMs in a placement group. |
| CreateTime | string | Creation time of the placement group. |
| RequestId | string | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Success
{
"Response": {
"DisasterRecoverGroupId": …,
"Type": …,
"RequestId": "…"
}
}Error
{
"Response": {
"Error": { "Code": "…", "Message": "…" },
"RequestId": "…"
}
}Try it
CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/cvm.
Request bodyvalid JSONPOST cvm.api3.convergecloud.com · CreateDisasterRecoverGroup
Recorded example response — captured 2026-09-16
{
"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"
}
}