创建Topic
功能介绍
创建Topic。
URI
POST /v2/{project_id}/mqs/instances/{instance_id}/topics
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。 |
|
instance_id |
是 |
String |
实例ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
Topic名称，以字母开头，仅能包含数字、字母、下划线(_)、中划线（-），长度3-200字符。 |
|
app_id |
是 |
String |
集成应用Key。 |
|
app_key |
否 |
String |
集成应用Key。 |
|
partition |
否 |
Integer |
Topic分区数，设置消费的并发数。 取值范围：1-100。 默认值：3。 |
|
replication |
否 |
Integer |
副本数，配置数据的可靠性。 取值范围：1-3。 默认值：3。
说明：
|
|
access_policy |
是 |
String |
权限类型。
|
|
sync_message_flush |
否 |
Boolean |
是否使用同步落盘。默认值为false。同步落盘会导致性能降低。 |
|
sync_replication |
否 |
Boolean |
是否开启同步复制，开启后，客户端生产消息时相应的也要设置acks=-1，否则不生效，默认关闭。 |
|
retention_time |
否 |
Integer |
消息老化时间。默认值为72。取值范围1~168，单位小时。 |
|
tag |
否 |
String |
权限类型对应的标签。 当权限类型是all时，发布和订阅的标签用符号“&”隔开。 当有多个标签时，标签用符号“||”隔开。 |
|
description |
否 |
String |
描述。长度0-1000字符。输入值首字符不能为"="、"+"、 "-"、"@"的全角和半角字符。 |
|
sensitive_word |
否 |
String |
敏感字段。 当有多个敏感字段时，敏感字段用符号“||”隔开。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
Topic名称。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误信息。 |
状态码： 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误信息。 |
请求示例
创建一个Topic，分区数为3，副本数为3，消息老化时间为72小时
POST https://{endpoint}/v2/{project_id}/mqs/instances/{instance_id}/topics
{
"name" : "topic-test-2",
"app_id" : "c5abd910-02b1-4bc4-b587-c3fe4c49dab9",
"partition" : 3,
"access_policy" : "all",
"replication" : 3,
"retention_time" : 72,
"sync_replication" : false,
"sync_message_flush" : false,
"tag" : "11 || 22 || aa || bb&11 || 22 || aa || bb",
"description" : "test",
"sensitive_word" : "sss || ddd"
}
响应示例
状态码： 200
OK
{
"name" : "topic-mqs-test"
}
状态码： 400
Bad Request
{
"error_code" : 400,
"error_msg" : "Bad Request"
}
状态码： 403
Forbidden
{
"error_code" : 403,
"error_msg" : "Forbidden"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
403 |
Forbidden |
错误码
请参见错误码。
