文档中心>API 中心

查询Pulsar专业版实例列表

最近更新时间:2025-03-20 20:02:12

我的收藏

1. 接口描述

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

查询用户已购的Pulsar专业版实例列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribePulsarProInstances。
Version String 公共参数,本接口取值:2020-02-17。
Region String 公共参数,详见产品支持的 地域列表
Filters.N Array of Filter 查询条件过滤器
Limit Integer 查询数目上限,默认20
示例值:20
Offset Integer 查询起始位置
示例值:1

3. 输出参数

参数名称 类型 描述
TotalCount Integer 未分页的总数目
示例值:10
Instances Array of PulsarProInstance 实例信息列表
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取实例列表

输入示例

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

{
    "Filters": [
        {
            "Name": "instancelds",
            "Values": [
                "pulsar-aer8pde2z2we"
            ]
        }
    ],
    "Limit": 1,
    "Offset": 1
}

输出示例

复制
复制成功
{
    "Response": {
        "TotalCount": 1,
        "Instances": [
            {
                "InstanceId": "pulsar-aer8pde2z2we",
                "InstanceName": "DevName",
                "InstanceVersion": "2.9.1",
                "Status": 1,
                "ConfigDisplay": "基础型",
                "MaxTps": 1,
                "MaxStorage": 1,
                "ExpireTime": 1,
                "AutoRenewFlag": 1,
                "PayMode": 1,
                "Remark": "devRemark",
                "SpecName": "vip-basic-1",
                "ScalableTps": 1,
                "VpcId": "vpc-xxxx",
                "SubnetId": "subnet-xxxx",
                "MaxBandWidth": 1,
                "Tags": [
                    {
                        "TagKey": "devKey",
                        "TagValue": "devValue"
                    }
                ],
                "CreateTime": "2023-12-08 10:25:51",
                "BillingLabelVersion": "PULSAR.P1"
            }
        ],
        "RequestId": "e83dfdba-ed1a-4460-b175-81430ddf61fa"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。

如果遇到产品相关问题,您可咨询 在线客服 寻求帮助。

可通过正文划词反馈文档内容问题,我们会快速处理并更新文档内容。