1. 接口描述
接口请求域名: tdmq.tencentcloudapi.com 。
运营端获取命名空间bundle列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeNamespaceBundlesOpt。 |
Version | 是 | String | 公共参数,本接口取值:2020-02-17。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
ClusterName | 是 | String | 物理集群名 示例值:cluster-s3hklt5n |
TenantId | 是 | String | 虚拟集群(租户)ID 示例值:pulsar-nzw8q5b3g7b2 |
NamespaceName | 是 | String | 命名空间名 示例值:default |
NeedMetrics | 是 | Boolean | 是否需要监控指标,若传false,则不需要传Limit和Offset分页参数 示例值:true |
Limit | 否 | Integer | 查询限制条数 示例值:10 |
Offset | 否 | Integer | 查询偏移量 示例值:0 |
Bundle | 否 | String | 过滤的 bundle 示例值:0x03d70a3c_0x051eb851 |
OwnerBroker | 否 | String | bundle 所属的 broker IP 地址,支持模糊查询 示例值:127.0.0.1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 记录条数 示例值:10 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 test
测试
输入示例
POST / HTTP/1.1
Host: tdmq.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeNamespaceBundlesOpt
<公共请求参数>
{
"ClusterName": "tdmq_txy_gz_01",
"Limit": 20,
"NamespaceName": "ns_1",
"NeedMetrics": true,
"Offset": 0,
"TenantId": "pulsar-pbkdk57xz9wv"
}
输出示例
{
"Response": {
"RequestId": "d2d3e253-3b1d-4471-a350-25e6ae20916c",
"TotalCount": 30
}
}
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.PulsarAdminError | PulsarAdminClient错误。 |
OperationDenied.DefaultEnvironment | 默认环境不允许操作。 |