You need to enable JavaScript to run this app.
导航
CreateTopic - 创建 Topic
最近更新时间:2024.12.11 16:59:12首次发布时间:2023.07.27 17:33:07

调用 CreateTopic 接口,创建 Topic。

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com?Action=CreateTopic&Version=2023-06-01

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

CreateTopic

要执行的操作,取值:CreateTopic。

Version
String

2023-06-01

API的版本,取值:2023-06-01。

Topic
String

topic-1

自定义设置 Topic 名称。
只能由小写英文字符、数字、下划线(_)和短横线(-)组成,且长度为 3~64 个字符。

Retention
Integer

72

消息在 Topic 中的保留时长,单位为小时。

  • 默认与实例设置的全局消息保留时长保持一致,但也可按小时粒度自主调节。
  • 支持设置保留时间范围为 1~336 小时(14 天)。
InstanceId
String

o-00c****m46c

需要创建 Topic 的 BMQ 实例 ID。

Partitions
Integer

12

Topic 的分区数。
不同实例规格支持的分区数量不同,请注意可用范围。相关文档,请参见实例规格

Description
String

测试使用

Topic 的描述语句。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
TopicId
String

677bb****b1e406797e87e309785c4e6

创建的 Topic ID。

请求示例

POST /?Action=CreateTopic&Version=2023-06-01 HTTP/1.1
Host: bmq.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241104T134503Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=AK********/20241104/cn-beijing/bmq/request, SignedHeaders=host;x-content-sha256;x-date, Signature=********

{
  "Topic": "topic-1",
  "Retention": 72,
  "InstanceId": "o-00c****m46c",
  "Partitions": 12
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2024110421450719915523222202****",
    "Action": "CreateTopic",
    "Version": "2023-06-01",
    "Service": "bmq",
    "Region": "cn-beijing"
  },
  "Result": {
    "TopicId": "677bb****b1e406797e87e309785c4e6"
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
200
InvalidParameter
parameter is invalid, pls check parameters

参数值无效。

200
Unauthorized
authorized error

授权错误,请授权或切换账号后重试。

200
InternalServiceError
internal service error, please contact with admin

内部服务错误,请联系技术支持或提交工单

200
DatabaseError
database error

数据库错误。

200
ParameterEncodingError
Failure encoding object into query map

参数编码异常,请联系技术支持或提交工单