更新时间：2026-08-17 GMT+08:00

设置/解除实例只读 - SetInstanceReadonlyStatus

功能介绍

设置实例状态为只读或解读实例的只读状态。

接口约束

实例在创建、变更规格、冻结、异常等状态下不能执行设置只读操作。
实例设置为只读后，该实例将无法写入数据。
仅当实例的只读状态是通过本接口设置时，才可以通过此接口将其恢复为读写状态。对于其他原因（例如包年/包月实例磁盘空间满、正在进行DRS迁移等）造成的只读状态，无法通过此接口解除只读。

调用方法

请参见如何调用API。

授权信息

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

如果使用角色与策略授权，具体权限要求请参见权限和授权项。

如果使用身份策略授权，需具备如下身份策略权限。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
gaussdbformysql:instance:setInstanceReadonlyStatus	Write	instance *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	gaussdb:instance:setInstanceReadonlyStatus	-

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：租户在某一Region下的project ID。获取方法请参见获取项目ID。约束限制：不涉及。取值范围：只能由英文字母、数字组成，且长度为32个字符。默认取值：不涉及。
instance_id	是	String	参数解释：实例ID，此参数是实例的唯一标识。获取方法请参见查询实例列表。约束限制：不涉及。取值范围：只能由英文字母、数字组成，后缀为in07，长度为36个字符。默认取值：不涉及。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：用户Token。通过调用IAM服务获取用户Token接口获取。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
X-Language	否	String	参数解释：请求语言类型。约束限制：不涉及。取值范围： en-us：英文。 zh-cn：中文。默认取值： en-us。

表3 请求Body参数
参数	是否必选	参数类型	描述
readonly	是	Boolean	参数解释：设置或者解除实例只读。约束限制：不涉及。取值范围： true: 设置只读。 false: 解除只读。默认取值：不涉及。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
job_id	String	参数解释：任务ID。取值范围：不涉及。

状态码：400

表5 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误消息。

状态码：500

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误消息。

请求示例

设置实例状态为只读状态。

PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/12a49c2dc32648df8dd25e2976f70180in07/readonly-status

{
  "readonly" : true
}

解除实例只读状态。

PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/12a49c2dc32648df8dd25e2976f70180in07/readonly-status

{
  "readonly" : false
}

响应示例

状态码：200

Success.

{
  "job_id" : "abb148d0-76a9-4919-a64e-1e273d2505a4"
}

状态码

状态码	描述
200	Success.
400	Client error.
500	Server error.

错误码

请参见错误码。

父主题：实例管理