文档首页/ 分布式数据库中间件 DDM/ API参考/ API（推荐）/ 实例管理/ 设置实例只读状态
更新时间：2026-05-15 GMT+08:00
在线调试
CLI示例
查看PDF
分享

设置实例只读状态

功能介绍

设置实例只读状态

接口约束

  • 设置实例为只读后，新创建的逻辑库还可以实现读写功能，需要重新将实例设置为只读

  • 设置实例只读期间，不可随意修改逻辑库SQL黑名单；手动清理逻辑库SQL黑名单可解除只读状态

调用方法

请参见如何调用API。

授权信息

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

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    ddm:instance:setReadOnly

    Write

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    ddm:instance:modify

    -

URI

PUT /v3/{project_id}/instances/{instance_id}/readonly-status

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID，此参数是实例的唯一标识。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，后缀为in09，长度为36个字符。

默认取值：

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

readonly

是

Boolean

参数解释：

实例是否设置为只读。

  • true：设置为只读。

  • false：解除只读状态。

约束限制：

不涉及。

取值范围：

true或者false。

默认取值：

不涉及。

请求示例

设置实例的只读状态。

PUT https://{endpoint}/v3/a8e2a5e2a6xxxxxxxxxx5af5b9ddabe5/instances/849c450a43xxxxxxxxxxf33cff5f0717pr09/readonly-status

{
  "readonly" : true
}

响应参数

  • 正常响应参数说明
表3 响应Body参数

参数

参数类型

描述

job_id

String

参数解释：

工作流ID。

取值范围：

不涉及。

响应示例

  • 正常响应示例 
    {
  "job_id" : "075fabcf-c4f0-4dc3-a734-65449f5cd277"
}
  • 异常响应

    请参见异常请求结果。

状态码

错误码

请参见错误码。

父主题： 实例管理

相关文档