cvm · 2017-03-12

DescribeDisasterRecoverGroups

POST

Query the information on spread placement groups.

Wire call

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

Request parameters

Field	Type	Required	Description
DisasterRecoverGroupIds	string[]	—	ID list of spread placement groups. You can operate up to 10 spread placement groups in each request.
Name	string	—	Name of a spread placement group. Fuzzy match is supported.
Offset	integer	—	Offset; default value: 0. For more information on `Offset`, see the corresponding section in API Introduction.
Limit	integer	—	Number of results returned; default value: 20; maximum: 100. For more information on `Limit`, see the corresponding section in API Introduction.
Filters	Filter[]	—	`tag-key` - String - Optional - Filter by the tag key.

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
DisasterRecoverGroupSet	DisasterRecoverGroup[]	Information on spread placement groups.
TotalCount	integer	Total number of placement groups of the user.
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": {
    "DisasterRecoverGroupSet": …,
    "TotalCount": …,
    "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.

SecretIdSecretKey

Request bodyvalid JSONPOST cvm.api3.convergecloud.com · DescribeDisasterRecoverGroups

{}

Read-only. Creates nothing.

Recorded example response — captured 2026-09-16

{
  "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"
  }
}