有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

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

获取租户下命名空间列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeEnvironments。
Version String 公共参数,本接口取值:2020-02-17。
Region String 公共参数,详见产品支持的 地域列表
ClusterId String Pulsar 集群的ID
示例值:pulsar-ge3n43v3wj
EnvironmentId String 命名空间名称,模糊搜索。
示例值:default
Offset Integer 起始下标,不填默认为0。
示例值:0
Limit Integer 返回数量,不填则默认为10,最大值为20。
示例值:5
Filters.N Array of Filter * EnvironmentId
按照名称空间进行过滤,精确查询。
类型:String
必选:否

3. 输出参数

参数名称 类型 描述
TotalCount Integer 命名空间记录数。
示例值:1
EnvironmentSet Array of Environment 命名空间集合数组。
示例值:[]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取命名空间列表

输入示例

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

{
    "EnvironmentId": "abc",
    "Offset": 1,
    "Limit": 1,
    "ClusterId": "abc",
    "Filters": [
        {
            "Name": "abc",
            "Values": [
                "abc"
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "EnvironmentSet": [
            {
                "EnvironmentId": "abc",
                "Remark": "abc",
                "MsgTTL": 0,
                "CreateTime": "2020-09-22 00:00:00",
                "UpdateTime": "2020-09-22 00:00:00",
                "NamespaceId": "abc",
                "NamespaceName": "abc",
                "TopicNum": 0,
                "RetentionPolicy": {
                    "TimeInMinutes": 0,
                    "SizeInMB": 0
                },
                "AutoSubscriptionCreation": true
            }
        ],
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure.UnauthorizedOperation CAM鉴权不通过。
InternalError.SystemError 系统错误。
InvalidParameterValue.InvalidParams 参数值不在允许范围内。
MissingParameter.NeedMoreParams 必要参数没有传递。
ResourceNotFound.Cluster 集群不存在。