Updated on 2024-07-05 GMT+08:00

Modifying RocketMQ Configurations

Function

This API is used to modify RocketMQ configurations.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/{project_id}/rocketmq/instances/{instance_id}/configs

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.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

rocketmq_configs

No

Array of RocketMQConfigReq objects

RocketMQ configuration.

Table 3 RocketMQConfigReq

Parameter

Mandatory

Type

Description

name

No

String

RocketMQ configuration name.

value

No

String

RocketMQ configuration target value.

Response Parameters

None

Example Requests

Modifying RocketMQ configurations with file retention period changed to 72 hours.

PUT  https://{endpoint}/v2/{project_id}/rocketmq/instances/{instance_id}/configs

{
  "rocketmq_configs" : [ {
    "name" : "fileReservedTime",
    "value" : 72
  } ]
}

Example Responses

None

SDK Sample Code

The SDK sample code is as follows.

Modifying RocketMQ configurations with file retention period changed to 72 hours.

 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
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 UpdateRocketMqConfigsSolution {

    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();
        UpdateRocketMqConfigsRequest request = new UpdateRocketMqConfigsRequest();
        request.withInstanceId("{instance_id}");
        ModifyConfigReq body = new ModifyConfigReq();
        List<RocketMQConfigReq> listbodyRocketmqConfigs = new ArrayList<>();
        listbodyRocketmqConfigs.add(
            new RocketMQConfigReq()
                .withName(RocketMQConfigReq.NameEnum.fromValue("fileReservedTime"))
                .withValue("72")
        );
        body.withRocketmqConfigs(listbodyRocketmqConfigs);
        request.withBody(body);
        try {
            UpdateRocketMqConfigsResponse response = client.updateRocketMqConfigs(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());
        }
    }
}

Modifying RocketMQ configurations with file retention period changed to 72 hours.

 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
# 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 = UpdateRocketMqConfigsRequest()
        request.instance_id = "{instance_id}"
        listRocketmqConfigsbody = [
            RocketMQConfigReq(
                name="fileReservedTime",
                value="72"
            )
        ]
        request.body = ModifyConfigReq(
            rocketmq_configs=listRocketmqConfigsbody
        )
        response = client.update_rocket_mq_configs(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Modifying RocketMQ configurations with file retention period changed to 72 hours.

 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
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.UpdateRocketMqConfigsRequest{}
	request.InstanceId = "{instance_id}"
	nameRocketmqConfigs:= model.GetRocketMqConfigReqNameEnum().FILE_RESERVED_TIME
	valueRocketmqConfigs:= "72"
	var listRocketmqConfigsbody = []model.RocketMqConfigReq{
        {
            Name: &nameRocketmqConfigs,
            Value: &valueRocketmqConfigs,
        },
    }
	request.Body = &model.ModifyConfigReq{
		RocketmqConfigs: &listRocketmqConfigsbody,
	}
	response, err := client.UpdateRocketMqConfigs(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

Successful.

Error Codes

See Error Codes.