更新时间:2024-07-05 GMT+08:00

创建主题或批量删除主题

功能介绍

创建主题或批量删除主题。

调用方法

请参见如何调用API

URI

POST /v2/{project_id}/instances/{instance_id}/topics

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见获取项目ID

instance_id

String

实例ID。

表2 Query参数

参数

是否必选

参数类型

描述

action

String

批量删除Topic时使用,不配置则为创建接口。删除操作:delete。

请求参数

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

主题名称,只能由英文字母、数字、百分号、竖线、中划线、下划线组成,长度3~64个字符。

brokers

Array of strings

关联的代理(仅RocketMQ实例4.8.0版本需要填写此参数)。

queue_num

Number

队列数,范围1~50。

queues

Array of queues objects

队列(仅RocketMQ实例4.8.0版本需要填写此参数)。

permission

String

权限(仅RocketMQ实例4.8.0版本需要填写此参数)。

取值范围:

  • pub(发布)

  • sub(订阅)

  • all(发布+订阅)

message_type

String

消息类型(仅RocketMQ实例5.x版本需要填写此参数)。

取值范围:

  • NORMAL(普通消息)

  • FIFO(顺序消息)

  • DELAY(定时消息)

  • TRANSACTION(事务消息)

topics

Array of strings

主题列表,当批量删除主题时使用。

表4 queues

参数

是否必选

参数类型

描述

broker

String

关联的代理。

queue_num

Number

队列数,范围1~50。

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

id

String

主题名称。

job_id

String

删除主题任务ID。

请求示例

  • 4.8.0版本RocketMQ实例创建一个主题,关联的代理为broker-0,队列数为3。

    POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics
    
    {
      "name" : "topic-test",
      "brokers" : [ "broker-0" ],
      "permission" : "all",
      "queues" : [ {
        "broker" : "broker-0",
        "queue_num" : 3
      } ]
    }
  • 5.x版本RocketMQ实例创建一个主题,消息类型为普通。

    POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics
    
    {
      "name" : "topic-test",
      "message_type" : "NORMAL"
    }

响应示例

状态码: 200

创建主题或批量删除主题成功。

{
  "id" : "topic-test"
}

SDK代码示例

SDK代码示例如下。

  • 4.8.0版本RocketMQ实例创建一个主题,关联的代理为broker-0,队列数为3。

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    package com.huaweicloud.sdk.test;
    
    import com.huaweicloud.sdk.core.auth.ICredential;
    import com.huaweicloud.sdk.core.auth.BasicCredentials;
    import com.huaweicloud.sdk.core.exception.ConnectionException;
    import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
    import com.huaweicloud.sdk.core.exception.ServiceResponseException;
    import com.huaweicloud.sdk.rocketmq.v2.region.RocketMQRegion;
    import com.huaweicloud.sdk.rocketmq.v2.*;
    import com.huaweicloud.sdk.rocketmq.v2.model.*;
    
    import java.util.List;
    import java.util.ArrayList;
    
    public class CreateTopicOrBatchDeleteTopicSolution {
    
        public static void main(String[] args) {
            // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
            // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
            String ak = System.getenv("CLOUD_SDK_AK");
            String sk = System.getenv("CLOUD_SDK_SK");
            String projectId = "{project_id}";
    
            ICredential auth = new BasicCredentials()
                    .withProjectId(projectId)
                    .withAk(ak)
                    .withSk(sk);
    
            RocketMQClient client = RocketMQClient.newBuilder()
                    .withCredential(auth)
                    .withRegion(RocketMQRegion.valueOf("<YOUR REGION>"))
                    .build();
            CreateTopicOrBatchDeleteTopicRequest request = new CreateTopicOrBatchDeleteTopicRequest();
            request.withInstanceId("{instance_id}");
            CreateTopicOrBatchDeleteTopicReq body = new CreateTopicOrBatchDeleteTopicReq();
            List<CreateTopicReqQueues> listbodyQueues = new ArrayList<>();
            listbodyQueues.add(
                new CreateTopicReqQueues()
                    .withBroker("broker-0")
                    .withQueueNum(java.math.BigDecimal.valueOf(3))
            );
            List<String> listbodyBrokers = new ArrayList<>();
            listbodyBrokers.add("broker-0");
            body.withPermission(CreateTopicOrBatchDeleteTopicReq.PermissionEnum.fromValue("all"));
            body.withName("topic-test");
            body.withQueues(listbodyQueues);
            body.withBrokers(listbodyBrokers);
            request.withBody(body);
            try {
                CreateTopicOrBatchDeleteTopicResponse response = client.createTopicOrBatchDeleteTopic(request);
                System.out.println(response.toString());
            } catch (ConnectionException e) {
                e.printStackTrace();
            } catch (RequestTimeoutException e) {
                e.printStackTrace();
            } catch (ServiceResponseException e) {
                e.printStackTrace();
                System.out.println(e.getHttpStatusCode());
                System.out.println(e.getRequestId());
                System.out.println(e.getErrorCode());
                System.out.println(e.getErrorMsg());
            }
        }
    }
    
  • 5.x版本RocketMQ实例创建一个主题,消息类型为普通。

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    package com.huaweicloud.sdk.test;
    
    import com.huaweicloud.sdk.core.auth.ICredential;
    import com.huaweicloud.sdk.core.auth.BasicCredentials;
    import com.huaweicloud.sdk.core.exception.ConnectionException;
    import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
    import com.huaweicloud.sdk.core.exception.ServiceResponseException;
    import com.huaweicloud.sdk.rocketmq.v2.region.RocketMQRegion;
    import com.huaweicloud.sdk.rocketmq.v2.*;
    import com.huaweicloud.sdk.rocketmq.v2.model.*;
    
    
    public class CreateTopicOrBatchDeleteTopicSolution {
    
        public static void main(String[] args) {
            // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
            // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
            String ak = System.getenv("CLOUD_SDK_AK");
            String sk = System.getenv("CLOUD_SDK_SK");
            String projectId = "{project_id}";
    
            ICredential auth = new BasicCredentials()
                    .withProjectId(projectId)
                    .withAk(ak)
                    .withSk(sk);
    
            RocketMQClient client = RocketMQClient.newBuilder()
                    .withCredential(auth)
                    .withRegion(RocketMQRegion.valueOf("<YOUR REGION>"))
                    .build();
            CreateTopicOrBatchDeleteTopicRequest request = new CreateTopicOrBatchDeleteTopicRequest();
            request.withInstanceId("{instance_id}");
            CreateTopicOrBatchDeleteTopicReq body = new CreateTopicOrBatchDeleteTopicReq();
            body.withMessageType(CreateTopicOrBatchDeleteTopicReq.MessageTypeEnum.fromValue("NORMAL"));
            body.withName("topic-test");
            request.withBody(body);
            try {
                CreateTopicOrBatchDeleteTopicResponse response = client.createTopicOrBatchDeleteTopic(request);
                System.out.println(response.toString());
            } catch (ConnectionException e) {
                e.printStackTrace();
            } catch (RequestTimeoutException e) {
                e.printStackTrace();
            } catch (ServiceResponseException e) {
                e.printStackTrace();
                System.out.println(e.getHttpStatusCode());
                System.out.println(e.getRequestId());
                System.out.println(e.getErrorCode());
                System.out.println(e.getErrorMsg());
            }
        }
    }
    
  • 4.8.0版本RocketMQ实例创建一个主题,关联的代理为broker-0,队列数为3。

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    # coding: utf-8
    
    import os
    from huaweicloudsdkcore.auth.credentials import BasicCredentials
    from huaweicloudsdkrocketmq.v2.region.rocketmq_region import RocketMQRegion
    from huaweicloudsdkcore.exceptions import exceptions
    from huaweicloudsdkrocketmq.v2 import *
    
    if __name__ == "__main__":
        # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        ak = os.environ["CLOUD_SDK_AK"]
        sk = os.environ["CLOUD_SDK_SK"]
        projectId = "{project_id}"
    
        credentials = BasicCredentials(ak, sk, projectId)
    
        client = RocketMQClient.new_builder() \
            .with_credentials(credentials) \
            .with_region(RocketMQRegion.value_of("<YOUR REGION>")) \
            .build()
    
        try:
            request = CreateTopicOrBatchDeleteTopicRequest()
            request.instance_id = "{instance_id}"
            listQueuesbody = [
                CreateTopicReqQueues(
                    broker="broker-0",
                    queue_num=3
                )
            ]
            listBrokersbody = [
                "broker-0"
            ]
            request.body = CreateTopicOrBatchDeleteTopicReq(
                permission="all",
                name="topic-test",
                queues=listQueuesbody,
                brokers=listBrokersbody
            )
            response = client.create_topic_or_batch_delete_topic(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
    
  • 5.x版本RocketMQ实例创建一个主题,消息类型为普通。

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    # coding: utf-8
    
    import os
    from huaweicloudsdkcore.auth.credentials import BasicCredentials
    from huaweicloudsdkrocketmq.v2.region.rocketmq_region import RocketMQRegion
    from huaweicloudsdkcore.exceptions import exceptions
    from huaweicloudsdkrocketmq.v2 import *
    
    if __name__ == "__main__":
        # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        ak = os.environ["CLOUD_SDK_AK"]
        sk = os.environ["CLOUD_SDK_SK"]
        projectId = "{project_id}"
    
        credentials = BasicCredentials(ak, sk, projectId)
    
        client = RocketMQClient.new_builder() \
            .with_credentials(credentials) \
            .with_region(RocketMQRegion.value_of("<YOUR REGION>")) \
            .build()
    
        try:
            request = CreateTopicOrBatchDeleteTopicRequest()
            request.instance_id = "{instance_id}"
            request.body = CreateTopicOrBatchDeleteTopicReq(
                message_type="NORMAL",
                name="topic-test"
            )
            response = client.create_topic_or_batch_delete_topic(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
    
  • 4.8.0版本RocketMQ实例创建一个主题,关联的代理为broker-0,队列数为3。

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    package main
    
    import (
    	"fmt"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
        rocketmq "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2/model"
        region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2/region"
    )
    
    func main() {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        ak := os.Getenv("CLOUD_SDK_AK")
        sk := os.Getenv("CLOUD_SDK_SK")
        projectId := "{project_id}"
    
        auth := basic.NewCredentialsBuilder().
            WithAk(ak).
            WithSk(sk).
            WithProjectId(projectId).
            Build()
    
        client := rocketmq.NewRocketMQClient(
            rocketmq.RocketMQClientBuilder().
                WithRegion(region.ValueOf("<YOUR REGION>")).
                WithCredential(auth).
                Build())
    
        request := &model.CreateTopicOrBatchDeleteTopicRequest{}
    	request.InstanceId = "{instance_id}"
    	brokerQueues:= "broker-0"
    	queueNumQueues:= float32(3)
    	var listQueuesbody = []model.CreateTopicReqQueues{
            {
                Broker: &brokerQueues,
                QueueNum: &queueNumQueues,
            },
        }
    	var listBrokersbody = []string{
            "broker-0",
        }
    	permissionCreateTopicOrBatchDeleteTopicReq:= model.GetCreateTopicOrBatchDeleteTopicReqPermissionEnum().ALL
    	nameCreateTopicOrBatchDeleteTopicReq:= "topic-test"
    	request.Body = &model.CreateTopicOrBatchDeleteTopicReq{
    		Permission: &permissionCreateTopicOrBatchDeleteTopicReq,
    		Name: &nameCreateTopicOrBatchDeleteTopicReq,
    		Queues: &listQueuesbody,
    		Brokers: &listBrokersbody,
    	}
    	response, err := client.CreateTopicOrBatchDeleteTopic(request)
    	if err == nil {
            fmt.Printf("%+v\n", response)
        } else {
            fmt.Println(err)
        }
    }
    
  • 5.x版本RocketMQ实例创建一个主题,消息类型为普通。

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    package main
    
    import (
    	"fmt"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
        rocketmq "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2"
    	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2/model"
        region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2/region"
    )
    
    func main() {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        ak := os.Getenv("CLOUD_SDK_AK")
        sk := os.Getenv("CLOUD_SDK_SK")
        projectId := "{project_id}"
    
        auth := basic.NewCredentialsBuilder().
            WithAk(ak).
            WithSk(sk).
            WithProjectId(projectId).
            Build()
    
        client := rocketmq.NewRocketMQClient(
            rocketmq.RocketMQClientBuilder().
                WithRegion(region.ValueOf("<YOUR REGION>")).
                WithCredential(auth).
                Build())
    
        request := &model.CreateTopicOrBatchDeleteTopicRequest{}
    	request.InstanceId = "{instance_id}"
    	messageTypeCreateTopicOrBatchDeleteTopicReq:= model.GetCreateTopicOrBatchDeleteTopicReqMessageTypeEnum().NORMAL
    	nameCreateTopicOrBatchDeleteTopicReq:= "topic-test"
    	request.Body = &model.CreateTopicOrBatchDeleteTopicReq{
    		MessageType: &messageTypeCreateTopicOrBatchDeleteTopicReq,
    		Name: &nameCreateTopicOrBatchDeleteTopicReq,
    	}
    	response, err := client.CreateTopicOrBatchDeleteTopic(request)
    	if err == nil {
            fmt.Printf("%+v\n", response)
        } else {
            fmt.Println(err)
        }
    }
    

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

创建主题或批量删除主题成功。

错误码

请参见错误码