文档首页/ 分布式消息服务RabbitMQ版/ API参考/ API V2（推荐）/ 实例管理/ 获取实例配置 - ShowInstanceConfigs
更新时间：2026-07-15 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取实例配置 - ShowInstanceConfigs

功能介绍

获取实例配置。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

configs

Array of InstanceConfig objects

参数解释：

配置列表。
表3 InstanceConfig

参数

参数类型

描述

name

String

参数解释：

配置名称。

取值范围：

不涉及。

valid_values

String

参数解释：

有效值。

取值范围：

不涉及。

default_value

String

参数解释：

默认值。

取值范围：

不涉及。

config_type

String

参数解释：

配置类型。

取值范围：

  • dynamic：动态。

  • static：静态。

value

String

参数解释：

配置当前值。

取值范围：

不涉及。

value_type

String

参数解释：

值类型。

取值范围：

  • string：字符串类型。

  • integer：整数类型。

  • enum：枚举值类型。

请求示例

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

响应示例

状态码：200

获取实例配置成功。

{
  "configs" : [ {
    "name" : "heartbeat",
    "valid_values" : "0~infinity",
    "default_value" : "60",
    "config_type" : "dynamic",
    "value" : "60",
    "value_type" : "integer"
  } ]
}

状态码

状态码

描述

200

获取实例配置成功。

错误码

请参见错误码。

父主题： 实例管理

相关文档