创建命名空间-消息队列 Pulsar 版-文档中心-腾讯云

1. 接口描述

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

用于在用户账户下创建消息队列 Tdmq 命名空间

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateEnvironment。
Version	是	String	公共参数，本接口取值：2020-02-17。
Region	是	String	公共参数，详见产品支持的地域列表。
EnvironmentId	是	String	环境（命名空间）名称，不支持中字以及除了短线和下划线外的特殊字符且不超过16个字符。示例值：devNamespace
MsgTTL	是	Integer	未消费消息过期时间，单位：秒，取值范围：60秒~15天。示例值：60
ClusterId	是	String	Pulsar 集群的ID 示例值：pulsar-ge3n43v3wj
Remark	否	String	说明，128个字符以内。示例值：demo
RetentionPolicy	否	RetentionPolicy	消息保留策略
AutoSubscriptionCreation	否	Boolean	是否开启自动创建订阅示例值：开启:true(default) false: 关闭

3. 输出参数

参数名称	类型	描述
EnvironmentId	String	环境（命名空间）名称。示例值：devNamespace
MsgTTL	Integer	未消费消息过期时间，单位：秒。示例值：60
Remark	String	说明，128个字符以内。注意：此字段可能返回 null，表示取不到有效值。示例值：demo
NamespaceId	String	命名空间ID 示例值：namespace-ak7jexmrz2
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建命名空间

是否开启自动创建订阅

输入示例

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

{
    "EnvironmentId": "devNamespace",
    "MsgTTL": "100",
    "AutoSubscriptionCreation": true,
    "ClusterId": "pulsar-b843bz38z5mz"
}

输出示例

{
    "Response": {
        "EnvironmentId": "devNamespace",
        "NamespaceId": "namespace-8893gp3428",
        "MsgTTL": 100,
        "Remark": "devRemark",
        "RequestId": "0843ea4f-d6ba-463b-952c-75708a7e8901"
    }
}

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

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

错误码	描述
AuthFailure.UnauthorizedOperation	CAM鉴权不通过。
FailedOperation	操作失败。
FailedOperation.CreateEnvironment	环境创建失败。
FailedOperation.CreateNamespace	创建命名空间失败。
InternalError.SystemError	系统错误。
InvalidParameterValue.InvalidParams	参数值不在允许范围内。
InvalidParameterValue.TTL	无效的消息TTL值。
LimitExceeded.Environments	实例下环境数量超过限制。
LimitExceeded.Namespaces	实例下命名空间数量超过限额。
LimitExceeded.RetentionSize	超过剩余额度，请重新调整。
LimitExceeded.RetentionTime	超过保留时间限制，请重新调整。
MissingParameter.NeedMoreParams	必要参数没有传递。
OperationDenied.DefaultEnvironment	默认环境不允许操作。
ResourceInUse	资源被占用。
ResourceInUse.Namespace	重名，命名空间已存在。
ResourceNotFound.Cluster	集群不存在。

创建命名空间

本页目录：