文档首页/ 分布式消息服务RocketMQ版/ API参考（联盟区域）/ API V2（推荐）/ 参数管理/ 查询RocketMQ配置
更新时间：2026-04-03 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询RocketMQ配置

功能介绍

该接口用于查询RocketMQ配置，若成功则返回配置的相关信息。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，获取方式请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。获取方法如下：调用“查询所有实例列表”接口，从响应体中获取实例ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

total

Number

参数解释：

总数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

next_offset

Integer

参数解释：

下个分页的offset。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

previous_offset

Integer

参数解释：

上个分页的offset。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

rocketmq_configs

Array of RocketMQConfigResp objects

参数解释：

RocketMQ配置。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表3 RocketMQConfigResp

参数

参数类型

描述

name

String

参数解释：

RocketMQ配置名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

value

String

参数解释：

RocketMQ配置当前值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

config_type

String

参数解释：

RocketMQ配置的类型。

约束限制：

不涉及。

取值范围：

  • dynamic：动态。

  • static：静态。

默认取值：

不涉及。

default_value

String

参数解释：

RocketMQ配置的默认值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

valid_values

String

参数解释：

RocketMQ配置取值的范围。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

value_type

String

参数解释：

RocketMQ配置值的类型。

约束限制：

不涉及。

取值范围：

  • integer：整数类型。

  • boolean：布尔类型。

默认取值：

不涉及。

请求示例

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

响应示例

状态码：200

查询RocketMQ配置成功。

{
  "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"
  } ]
}

状态码

状态码

描述

200

查询RocketMQ配置成功。

错误码

请参见错误码。

父主题： 参数管理