查询分散置放群组信息

最近更新时间:2024-03-12 01:19:17

我的收藏

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列表。每次请求允许操作的分散置放群组数量上限是100。
示例值:ps-21q9ibvr
Name String 分散置放群组名称,支持模糊匹配。
示例值:myGroup
Offset Integer 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
示例值:1
Limit Integer 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
示例值:2

3. 输出参数

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

4. 示例

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

查询分散置放群组信息

输入示例

GET https://cvm.tencentcloudapi.com/?Action=DescribeDisasterRecoverGroups
&<公共请求参数>

输出示例

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

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

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