文档中心>API 中心

查询置放群组列表

最近更新时间:2024-03-12 01:13:34

我的收藏

1. 接口描述

接口请求域名: cdb.tencentcloudapi.com 。

本接口(DescribeDeployGroupList)用于查询用户的置放群组列表,可以指定置放群组 ID 或置放群组名称。

默认接口请求频率限制:20次/秒。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDeployGroupList。
Version String 公共参数,本接口取值:2017-03-20。
Region String 公共参数,详见产品支持的 地域列表
DeployGroupId String 置放群组 ID。
示例值:test
DeployGroupName String 置放群组名称。
示例值:test
Limit Integer 返回数量,默认为20,最大值为100。
示例值:10
Offset Integer 偏移量,默认为0。
示例值:0

3. 输出参数

参数名称 类型 描述
Total Integer 符合条件的记录总数。
示例值:100
Items Array of DeployGroupInfo 返回列表。
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询置放群组列表

输入示例

https://cdb.tencentcloudapi.com/?Action=DescribeDeployGroupList
&DeployGroupId=test
&DeployGroupName=test
&Limit=10
&Offset=0
&<公共请求参数>

输出示例

{
    "Response": {
        "Total": 100,
        "Items": [
            {
                "DeployGroupId": "test",
                "DeployGroupName": "test",
                "Description": "test",
                "Quota": 50,
                "CreateTime": "2019-09-10 13:14:15"
            }
        ],
        "RequestId": "b4a719b5-ffb34ab6-816c43c1-8c6a23eb"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.CdbError 系统错误。
InvalidParameter 参数错误。
InvalidParameter.DeployGroupNotEmpty 置放群组下存在资源。
InvalidParameter.OverDeployGroupQuota 超出置放群组资源数量配额。
InvalidParameter.ResourceExists 资源已存在。
InvalidParameter.ResourceNotFound 未找到相关资源。
OperationDenied.ActionNotSupport 不支持的操作。