Tencent Cloud

search by keyword

Recent Pages

Documentation

DescribeDisasterRecoverGroups

Last updated: 2020-06-15 09:58:15

1. API Description

Domain name for API request: cvm.tencentcloudapi.com.

This API is used to query the information on spread placement groups.

A maximum of 10 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cvm.ap-shanghai-fsi.tencentcloudapi.com

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common parameter. The value used for this API: DescribeDisasterRecoverGroups.
Version	Yes	String	Common parameter. The value used for this API: 2017-03-12.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
DisasterRecoverGroupIds.N	No	Array of String	ID list of spread placement groups. You can operate up to 100 spread placement groups in each request.
Name	No	String	Name of a spread placement group. Fuzzy match is supported.
Offset	No	Integer	Offset; default value: 0. For more information on `Offset`, see the corresponding section in API Introduction.
Limit	No	Integer	Number of results returned; default value: 20; maximum: 100. For more information on `Limit`, see the corresponding section in API Introduction.

3. Output Parameters

Parameter Name	Type	Description
DisasterRecoverGroupSet	Array of DisasterRecoverGroup	Information on spread placement groups.
TotalCount	Integer	Total number of placement groups of the user.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying information on spread placement groups

This example shows you how to query the information of a spread placement group

Input Example

GET https://cvm.tencentcloudapi.com/?Action=DescribeDisasterRecoverGroups
&<common request parameters>

Output Example

{
  "Response": {
    "DisasterRecoverGroupSet": [
      {
        "DisasterRecoverGroupId": "ps-21q9ibvr",
        "Name": "Database service",
        "Type": "RACK",
        "CvmQuotaTotal": 30,
        "CurrentNum": 0,
        "InstanceIds": [],
        "CreateTime": "2018-04-19T02:47:12Z"
      }
    ],
    "TotalCount": 1,
    "RequestId": "c68ce193-be41-4d13-9a9b-2dc031db6477"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.