Querying RocketMQ Configurations
Function
This API is used to query RocketMQ configurations. Configuration details will be returned.
URI
GET /v2/{project_id}/rocketmq/instances/{instance_id}/configs
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
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total |
Number |
Total. |
next_offset |
Integer |
Offset of the next page. |
previous_offset |
Integer |
Offset of the previous page. |
rocketmq_configs |
Array of RocketMQConfigResp objects |
RocketMQ configuration. |
Parameter |
Type |
Description |
---|---|---|
name |
String |
RocketMQ configuration name. |
value |
String |
RocketMQ configuration current value. |
config_type |
String |
RocketMQ configuration type. |
default_value |
String |
RocketMQ configuration default value. |
valid_values |
String |
RocketMQ configuration value range. |
value_type |
String |
RocketMQ configuration value type. |
Example Requests
GET https://{endpoint}/v2/{project_id}/rocketmq/instances/{instance_id}/configs
Example Responses
Status code: 200
Successful.
{ "total" : 1, "next_offset" : -1, "previous_offset" : -1, "rocketmq_configs" : [ { "name" : "fileReservedTime", "value" : 48, "config_type" : "dynamic", "default_value" : 48, "valid_values" : "1~720", "value_type" : "integer" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
Successful. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.