消息队列 Pulsar 版获取某租户的虚拟集群列表

1. 接口描述

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

获取某个租户的虚拟集群列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeAllTenants。
Version	是	String	公共参数，本接口取值：2020-02-17。
Region	是	String	公共参数，详见产品支持的地域列表。
Offset	是	Integer	查询偏移量示例值：0
Limit	是	Integer	查询限制条数示例值：10
ClusterName	否	String	物理集群名称示例值：gz_cluster_1
TenantId	否	String	虚拟集群ID 示例值：pulsar-xk3ne8k2qkp8
TenantName	否	String	虚拟集群名称示例值：devName
Types.N	否	Array of String	协议类型数组示例值：pulsar
SortBy	否	String	排序字段名，支持createTime，updateTime 示例值：createTime
SortOrder	否	String	升序排列ASC，降序排列DESC 示例值：desc

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	总条数示例值：100
Tenants	Array of InternalTenant	虚拟集群列表
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 运营端获取虚拟集群列表

输入示例

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

{
    "ClusterName": "gz_cluster_1",
    "TenantName": "devName",
    "Limit": 0,
    "SortBy": "createTime",
    "Offset": 0,
    "TenantId": "pulsar-xk3ne8k2qkp8",
    "Types": [
        "http"
    ],
    "SortOrder": "desc"
}

输出示例

{
    "Response": {
        "TotalCount": 0,
        "Tenants": [
            {
                "MaxRetention": 1,
                "MaxDispatchTps": 1,
                "UpdateTime": 1,
                "MaxTopics": 0,
                "MaxRetentionSizeInMB": 1,
                "ClusterName": "cluster001",
                "MaxMsgBacklogSize": 1,
                "UsedTopics": 0,
                "CustomerUin": "712340148907",
                "UsedNamespaces": 0,
                "MaxPublishRateInBytes": 1,
                "CreateTime": 1,
                "MaxNamespaces": 0,
                "UsedPartitions": 0,
                "CustomerAppId": "25122936212a",
                "TenantName": "devTest",
                "MaxPartitions": 0,
                "TenantId": "pulsar-xk3ne8k2qkp8",
                "Type": "TDMQ",
                "MaxDispatchRateInBytes": 1,
                "MaxPublishTps": 1,
                "PublicAccessEnabled": true
            }
        ],
        "RequestId": "d4a162ca-0c45-4244-bc14-4463b72d5e13"
    }
}

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: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

获取某租户的虚拟集群列表

本页目录：