Updated on 2024-03-29 GMT+08:00

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

Project ID. For details, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

action

No

String

This parameter is used to delete topics in batches. If it is not set, a topic will be created. delete: Delete topics in batches.

Request Parameters

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

No

String

Topic name. Enter 3 to 64 characters. Use only letters, digits, percent (%), vertical bars (|), hyphens (-), and underscores (_).

brokers

No

Array of strings

Associated brokers.

queue_num

No

Number

Number of queues. The value ranges from 1 to 50.

Default: 8

permission

No

String

Permissions.

Default: all

message_type

No

String

Message type (available only for RocketMQ 5.x instances).

Default: all

topics

No

Array of strings

Topic list. This parameter is used when topics are deleted in batches.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

id

String

Topic name.

job_id

String

Job ID for deleting topics.

Example Requests

Creating a topic associated with broker-0 and 3 queues

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

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

Example Responses

Status code: 200

A topic is created or multiple topics are deleted in batches.

{
  "id" : "topic-test"
}

SDK Sample Code

The SDK sample code is as follows.

Creating a topic associated with broker-0 and 3 queues

 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
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> listbodyBrokers = new ArrayList<>();
        listbodyBrokers.add("broker-0");
        body.withQueueNum(java.math.BigDecimal.valueOf(3));
        body.withBrokers(listbodyBrokers);
        body.withPermission(CreateTopicOrBatchDeleteTopicReq.PermissionEnum.fromValue("all"));
        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());
        }
    }
}

Creating a topic associated with broker-0 and 3 queues

 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
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("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}"
        listBrokersbody = [
            "broker-0"
        ]
        request.body = CreateTopicOrBatchDeleteTopicReq(
            queue_num=3,
            brokers=listBrokersbody,
            permission="all",
            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)

Creating a topic associated with broker-0 and 3 queues

 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
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 listBrokersbody = []string{
        "broker-0",
    }
	queueNumCreateTopicOrBatchDeleteTopicReq:= float32(3)
	permissionCreateTopicOrBatchDeleteTopicReq:= model.GetCreateTopicOrBatchDeleteTopicReqPermissionEnum().ALL
	nameCreateTopicOrBatchDeleteTopicReq:= "topic-test"
	request.Body = &model.CreateTopicOrBatchDeleteTopicReq{
		QueueNum: &queueNumCreateTopicOrBatchDeleteTopicReq,
		Brokers: &listBrokersbody,
		Permission: &permissionCreateTopicOrBatchDeleteTopicReq,
		Name: &nameCreateTopicOrBatchDeleteTopicReq,
	}
	response, err := client.CreateTopicOrBatchDeleteTopic(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

A topic is created or multiple topics are deleted in batches.

Error Codes

See Error Codes.