云服务器查询分散置放群组信息

1. 接口描述

接口请求域名： cvm.tencentcloudapi.com 。

本接口 (DescribeDisasterRecoverGroups)用于查询分散置放群组信息。

默认接口请求频率限制：10次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDisasterRecoverGroups。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
DisasterRecoverGroupIds.N	否	Array of String	分散置放群组ID列表。每次请求允许操作的分散置放群组数量上限是10。示例值：["ps-21q9ibvr"]
Name	否	String	分散置放群组名称，支持模糊匹配。示例值：myGroup
Offset	否	Integer	偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API 简介中的相关小节。示例值：1
Limit	否	Integer	返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API 简介中的相关小节。示例值：2
Filters.N	否	Array of Filter	tag-key 按照【标签键】进行过滤。类型：String 必选：否 tag-value 按照【标签值】进行过滤。类型：String 必选：否 tag:tag-key 按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。类型：String 必选：否每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。

3. 输出参数

参数名称	类型	描述
DisasterRecoverGroupSet	Array of DisasterRecoverGroup	分散置放群组信息列表。
TotalCount	Integer	用户置放群组总量。示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询分散置放群组信息

查询分散置放群组信息

输入示例

POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDisasterRecoverGroups
<公共请求参数>

{
    "Offset": 0,
    "Limit": 100,
    "Filters": [
        {
            "Name": "tag:myTagKey",
            "Values": [
                "myTagVlue"
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "DisasterRecoverGroupSet": [
            {
                "Affinity": 1,
                "CreateTime": "2024-08-28T10:04:56Z",
                "CurrentNum": 0,
                "CvmQuotaTotal": 60,
                "DisasterRecoverGroupId": "ps-0f03mwkn",
                "InstanceIds": [],
                "Name": "HostDisasterRecoverGroup",
                "Tags": [
                    {
                        "Key": "myTagKey",
                        "Value": "myTagVlue"
                    }
                ],
                "Type": "HOST"
            },
            {
                "Affinity": 1,
                "CreateTime": "2024-08-13T04:16:19Z",
                "CurrentNum": 0,
                "CvmQuotaTotal": 20,
                "DisasterRecoverGroupId": "ps-ali72vwj",
                "InstanceIds": [],
                "Name": "SWDisasterRecoverGroup",
                "Tags": [
                    {
                        "Key": "myTagKey",
                        "Value": "myTagVlue"
                    }
                ],
                "Type": "SW"
            }
        ],
        "RequestId": "52eca90d-08c8-4887-abf0-78d8155cfcfd",
        "TotalCount": 2
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidParameterValue.DisasterRecoverGroupIdMalformed	置放群组ID格式错误。
InvalidParameterValue.LimitExceeded	参数值数量超过限制。