Creating a Topic or Deleting Topics in Batches

Function

This API is used to create a topic or delete topics in batches.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
instance_id	Yes	String	Definition Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body. Constraints N/A Range N/A Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
action	No	String	Definition This parameter is used to delete topics in batches. If it is not set, a topic will be created. Constraints N/A Range delete: batch deletion Left blank: topic creation Default Value N/A

Request Parameters

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	No	String	Definition Topic name. Constraints Enter 3 to 64 characters. Use only letters, digits, percent (%), vertical bars (\|), hyphens (-), and underscores (_). Mandatory for topic creation. Range N/A Default Value N/A
brokers	No	Array of strings	Associated broker. This parameter is mandatory only for RocketMQ 4.8.0 instances.
queue_num	No	Number	Total number of queues. The range is 1–50.
queues	No	Array of queues objects	Queue. This parameter is mandatory only for RocketMQ 4.8.0 instances.
permission	No	String	Permission. This parameter is mandatory only for RocketMQ 4.8.0 instances. Options: pub (publish) sub (subscribe) all (publish + subscribe)
message_type	No	String	Message type (This parameter is mandatory only for RocketMQ 5.x instances). Options: NORMAL (normal messages) FIFO (ordered messages) DELAY (scheduled messages) TRANSACTION (transactional messages)
topics	No	Array of strings	Topic list. This parameter is used when topics are deleted in batches.

**Table 4** queues
Parameter	Mandatory	Type	Description
broker	No	String	Associated brokers.
queue_num	No	Number	Number of queues. The value ranges from 1 to 50.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
id	String	Topic name.
job_id	String	Job ID for deleting topics.

Example Requests

For RocketMQ 4.8.0 instances: Creating a topic associated with broker-0 with 3 queues

POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics

{
  "name" : "topic-test",
  "permission" : "all",
  "queues" : [ {
    "broker" : "broker-0",
    "queue_num" : 3
  } ]
}

Deleting topics of a RocketMQ 5.x instance in a batch

POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics?action=delete

{
  "topics" : [ "topic01", "topic02" ]
}

Example Responses

Status code: 200

Topic created.

Successfully created the topic
```
{
  "id" : "topic-test"
}
```

Successfully deleted topics in a batch

{
  "job_id" : "8abfa7b299f0497c0199f0dc0a9a092b"
}

SDK Sample Code

The SDK sample code is as follows.

For RocketMQ 4.8.0 instances: Creating a topic associated with broker-0 with 3 queues

        
         
           
           
             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))
        );
        body.withPermission(CreateTopicOrBatchDeleteTopicReq.PermissionEnum.fromValue("all"));
        body.withName("topic-test");
        body.withQueues(listbodyQueues);
        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());
        }
    }
}

            

          

        
       

Deleting topics of a RocketMQ 5.x instance in a batch

        
         
           
           
             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<String> listbodyTopics = new ArrayList<>();
        listbodyTopics.add("topic01");
        listbodyTopics.add("topic02");
        body.withTopics(listbodyTopics);
        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());
        }
    }
}

            

          

        
       

For RocketMQ 4.8.0 instances: Creating a topic associated with broker-0 with 3 queues

        
         
           
           
             # 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
            )
        ]
        request.body = CreateTopicOrBatchDeleteTopicReq(
            permission="all",
            name="topic-test",
            queues=listQueuesbody
        )
        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)

            

          

        
       

Deleting topics of a RocketMQ 5.x instance in a batch

        
         
           
           
             # 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}"
        listTopicsbody = [
            "topic01",
            "topic02"
        ]
        request.body = CreateTopicOrBatchDeleteTopicReq(
            topics=listTopicsbody
        )
        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)

            

          

        
       

For RocketMQ 4.8.0 instances: Creating a topic associated with broker-0 with 3 queues

        
         
           
           
             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,
        },
    }
	permissionCreateTopicOrBatchDeleteTopicReq:= model.GetCreateTopicOrBatchDeleteTopicReqPermissionEnum().ALL
	nameCreateTopicOrBatchDeleteTopicReq:= "topic-test"
	request.Body = &model.CreateTopicOrBatchDeleteTopicReq{
		Permission: &permissionCreateTopicOrBatchDeleteTopicReq,
		Name: &nameCreateTopicOrBatchDeleteTopicReq,
		Queues: &listQueuesbody,
	}
	response, err := client.CreateTopicOrBatchDeleteTopic(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

            

          

        
       

Deleting topics of a RocketMQ 5.x instance in a batch

        
         
           
           
             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}"
	var listTopicsbody = []string{
        "topic01",
	    "topic02",
    }
	request.Body = &model.CreateTopicOrBatchDeleteTopicReq{
		Topics: &listTopicsbody,
	}
	response, err := client.CreateTopicOrBatchDeleteTopic(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

            

          

        
       