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

修改实例配置 - ModifyInstanceConfigs

功能介绍

修改实例配置。

调用方法

请参见如何调用API。

授权信息

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

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

configs

否

Array of ModifyInstanceConfig objects

参数解释：

待修改配置列表。

约束限制：

不涉及。
表3 ModifyInstanceConfig

参数

是否必选

参数类型

描述

name

否

String

参数解释：

修改的配置名称。请调用获取实例配置接口，获取实例配置名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

value

否

String

参数解释：

配置的修改值。请调用获取实例配置接口，获取实例配置参数对应的有效值valid_values。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

job_id

String

参数解释：

配置修改任务ID。

取值范围：

不涉及。

dynamic_config

Integer

参数解释：

本次修改动态配置参数个数。

取值范围：

不涉及。

static_config

Integer

参数解释：

本次修改静态配置参数个数。

取值范围：

不涉及。

请求示例

修改实例的消费超时。

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

{
  "configs" : [ {
    "name" : "consumer_timeout",
    "value" : "1800000"
  } ]
}

响应示例

状态码：200

修改实例配置成功。

{
  "job_id" : null,
  "dynamic_config" : 0,
  "static_config" : 1
}

状态码

状态码

描述

200

修改实例配置成功。

错误码

请参见错误码。

父主题： 实例管理

相关文档