Help Center/ Distributed Message Service for RocketMQ/ API Reference (Kuala Lumpur Region)/ APIs V2 (Recommended)/ Managing Parameters/ Modifying RocketMQ Configurations
Updated on 2024-04-08 GMT+08:00
Online Debugging
CLI Examples
View PDF

Modifying RocketMQ Configurations

Function

This API is used to modify RocketMQ configurations.

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

Status Codes

Status Code

Description

204

Successful.

Error Codes

See Error Codes.

Parent topic: Managing Parameters