1. 接口描述
接口请求域名: tdmq.tencentcloudapi.com 。
获取Pulsar专业版集群实例信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribePulsarProInstanceDetail。 |
Version | 是 | String | 公共参数,本接口取值:2020-02-17。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ClusterId | 是 | String | 集群ID 示例值:pulsar-x4r939zkwmm2 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ClusterInfo | PulsarProClusterInfo | 集群信息 |
NetworkAccessPointInfos | Array of PulsarNetworkAccessPointInfo | 集群网络接入点信息 注意:此字段可能返回 null,表示取不到有效值。 |
ClusterSpecInfo | PulsarProClusterSpecInfo | 集群规格信息 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取Pulsar专业版集群实例详情
输入示例
POST / HTTP/1.1
Host: tdmq.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePulsarProInstanceDetail
<公共请求参数>
{
"ClusterId": "pulsar-x4r939zkwmm2"
}
输出示例
{
"Response": {
"ClusterInfo": {
"ClusterId": "pulsar-x4r939zkwmm2",
"ClusterName": "devTest",
"Remark": "devTest",
"CreateTime": "2023-07-20 10:35:17",
"Status": 0,
"Version": "2.9.2",
"NodeDistribution": [
{
"ZoneName": "ap-beijing-4",
"ZoneId": "800004",
"NodeCount": 1
}
],
"MaxStorage": 1,
"CanEditRoute": true,
"BillingLabelVersion": "PULSAR.P1"
},
"NetworkAccessPointInfos": [
{
"VpcId": "vpc-8jjua83u",
"SubnetId": "subnet-1iia83y2",
"Endpoint": "http://pulsar-x4r939zkwmm2.tdmq.ap-bj.qcloud.tencenttdmq.com:8080",
"InstanceId": "pulsar-x4r939zkwmm2",
"RouteType": 1,
"OperationType": 1,
"AccessPointsType": null
}
],
"ClusterSpecInfo": {
"SpecName": "PULSAR.P1.MINI2",
"MaxTps": 1,
"MaxBandWidth": 1,
"MaxNamespaces": 1,
"MaxTopics": 1,
"ScalableTps": 1
},
"RequestId": "0799dd77-707b-40d7-a4b5-4140b11f6c97"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.CloudService | 第三方云服务异常,请稍后重试 |
FailedOperation.OperateLater | 任务进行中,请稍后重试 |
InternalError.IllegalMessage | 内部错误。 |
InvalidParameter | 参数错误。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.Cluster | 集群不存在。 |