获取集群详情-消息队列 Pulsar 版-文档中心-腾讯云

1. 接口描述

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

获取集群的详细信息

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeClusterDetail。
Version	是	String	公共参数，本接口取值：2020-02-17。
Region	是	String	公共参数，详见产品支持的地域列表。
ClusterId	是	String	集群的ID 示例值：pulsar-ge3n43v3wj

3. 输出参数

参数名称	类型	描述
ClusterSet	Cluster	集群的详细信息示例值：NULL
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取集群的详细信息

输入示例

https://tdmq.tencentcloudapi.com/?Action=DescribeClusterDetail
&ClusterId=pulsar-xxxxxxxx
&<公共请求参数>

输出示例

{
    "Response": {
        "ClusterSet": {
            "ClusterId": "abc",
            "ClusterName": "abc",
            "Remark": "abc",
            "EndPointNum": 0,
            "CreateTime": "abc",
            "Healthy": 0,
            "HealthyInfo": "abc",
            "Status": 0,
            "MaxNamespaceNum": 0,
            "MaxTopicNum": 0,
            "MaxQps": 0,
            "MessageRetentionTime": 0,
            "MaxStorageCapacity": 0,
            "Version": "abc",
            "PublicEndPoint": "abc",
            "VpcEndPoint": "abc",
            "NamespaceNum": 0,
            "UsedStorageBudget": 0,
            "MaxPublishRateInMessages": 0,
            "MaxDispatchRateInMessages": 0,
            "MaxPublishRateInBytes": 0,
            "MaxDispatchRateInBytes": 0,
            "TopicNum": 0,
            "MaxMessageDelayInSeconds": 0,
            "PublicAccessEnabled": true,
            "Tags": [
                {
                    "TagKey": "abc",
                    "TagValue": "abc"
                }
            ],
            "PayMode": 0,
            "ProjectId": 0,
            "ProjectName": "abc"
        },
        "RequestId": "abc"
    }
}

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. 错误码

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

错误码	描述
ResourceNotFound.Cluster	集群不存在。

获取集群详情

本页目录：