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

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

None

Response Parameters

Status code: 200

Table 2 Response body parameters
Parameter	Type	Description
rocketmq_configs	Array of RocketMQConfigResp objects	RocketMQ configuration.

Table 3 RocketMQConfigResp
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.

{
  "rocketmq_configs" : [ {
    "name" : "fileReservedTime",
    "value" : 48,
    "config_type" : "dynamic",
    "default_value" : 48,
    "valid_values" : "0-720",
    "value_type" : "integer"
  } ]
}

Status Codes

Status Code	Description
200	Successful.

Error Codes

See Error Codes.

Parent topic: Managing Parameters

Предыдущая статья

Managing Parameters

Следующая статья

Modifying RocketMQ Configurations

Была ли эта статья полезна?

Поддержка Юридические документы