Updated on 2025-12-18 GMT+08:00

Modifying a Topic

Function

This API is used to modify a topic.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/{project_id}/instances/{instance_id}/topics/{topic}

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

topic

Yes

String

Definition

Topic name.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

read_queue_num

No

Number

Definition

Total number of read queues.

Constraints

This parameter can be modified only for v4.8.0 instances.

Range

N/A

Default Value

N/A

write_queue_num

No

Number

Definition

Total number of write queues.

Constraints

This parameter can be modified only for v4.8.0 instances.

Range

N/A

Default Value

N/A

permission

No

String

Definition

Permission.

Constraints

This parameter can be modified only for v4.8.0 instances.

Range

N/A

Default Value

N/A

queues

No

Array of UpdateTopicQueueEntity objects

Definition

Queue.

Constraints

This parameter can be modified only for v4.8.0 instances.

Range

N/A

Default Value

N/A

topic_desc

No

String

Definition:

Topic description.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

Table 3 UpdateTopicQueueEntity

Parameter

Mandatory

Type

Description

broker

No

String

Definition:

Broker name.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

read_queue_num

No

Number

Definition:

Number of read queues.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

write_queue_num

No

Number

Definition:

Number of write queues.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

Response Parameters

Status code: 204

The topic is modified.

None

Example Requests

Changing a specified topic's total read queues to 3 and total write queues to 3

PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics/{topic}

{
  "topic_desc" : "topic_description"
}

Example Responses

None

SDK Sample Code

The SDK sample code is as follows.

Changing a specified topic's total read queues to 3 and total write queues to 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
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 UpdateTopicSolution {

    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();
        UpdateTopicRequest request = new UpdateTopicRequest();
        request.withInstanceId("{instance_id}");
        request.withTopic("{topic}");
        UpdateTopicReq body = new UpdateTopicReq();
        body.withTopicDesc("topic_description");
        request.withBody(body);
        try {
            UpdateTopicResponse response = client.updateTopic(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());
        }
    }
}

Changing a specified topic's total read queues to 3 and total write queues to 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
# 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 = UpdateTopicRequest()
        request.instance_id = "{instance_id}"
        request.topic = "{topic}"
        request.body = UpdateTopicReq(
            topic_desc="topic_description"
        )
        response = client.update_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)

Changing a specified topic's total read queues to 3 and total write queues to 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
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.UpdateTopicRequest{}
	request.InstanceId = "{instance_id}"
	request.Topic = "{topic}"
	topicDescUpdateTopicReq:= "topic_description"
	request.Body = &model.UpdateTopicReq{
		TopicDesc: &topicDescUpdateTopicReq,
	}
	response, err := client.UpdateTopic(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

204

The topic is modified.

Error Codes

See Error Codes.