Updated on 2026-08-31 GMT+08:00

Setting an Instance to Read-Only or Canceling Its Read-Only Status

Function

This API is used to set an instance to read-only or cancel the read-only status of an instance. Before calling this API:

Learn how to authenticate it.
Obtain the required region and endpoint.

Constraints

An instance cannot be set to read-only when it is in any of the following statuses: Creating, Changing instance specifications, Frozen, and Abnormal.
Once an instance is set to read-only, data cannot be written into the instance.
You can only use this API to restore an instance to the read/write status if the instance was set to read-only using this API. If an instance becomes read-only due to other reasons (such as full storage for yearly/monthly instances or DRS migration in progress), you cannot use this API to cancel the read-only status.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependency
gaussdbformysql:instance:setInstanceReadonlyStatus	Write	instance *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	gaussdb:instance:setInstanceReadonlyStatus	-

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. To obtain this value, see Querying DB Instances. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us: English zh-cn: Chinese Default Value en-us

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
readonly	Yes	Boolean	Definition Set an instance to read-only or cancel its read-only status. Constraints N/A Range true: The instance is set to read-only. false: Read-only is canceled for the instance. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
job_id	String	Definition Task ID. Range N/A

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Setting an instance to read-only

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

{
  "readonly" : true
}

Canceling the read-only status of an instance

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

{
  "readonly" : false
}

Example Response

Status code: 200

Success.

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

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent Topic: Instance Management