设置实例读写状态

功能介绍

RDS for MySQL支持设置实例读写状态，以支持用户的业务需求。实例设置只读成功后，将限制用户数据写入。

• 调用接口前，您需要了解API 认证鉴权。

接口约束

• 该接口目前仅支持RDS for MySQL引擎。
• 该接口目前仅支持单机实例和HA实例。
• 实例在创建、变更规格、冻结、异常等状态下不能执行该操作。
• 非该接口设置（如：磁盘满、DRS迁移等）导致实例只读的情况，不能通过该接口恢复实例为“读写”状态。
• 该接口仅设置主实例的读写状态，区别于只读实例的概念。
• 设置实例读写状态功能目前处于部分区域公测中，如果所在区域未开放此功能，请联系客服开通白名单。

URI

• URI格式

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

• 参数说明

  表1 参数说明

  名称	是否必选	说明
  project_id	是	租户在某一Region下的项目ID。 获取方法请参见获取项目ID。
  instance_id	是	实例ID。

请求消息

请求示例

PUT https://{endpoint}/v3/054ea741f700d4a32f1bc00f5c80dd4c/instances/5b409baece064984a1b3eef6addae50cin01/readonly-status
{
    "readonly" : true 
}

响应消息

• 正常响应要素说明

  表3 要素说明

  名称	参数类型	说明
  job_id	String	任务ID。

• 正常响应样例

  {
      "job_id": "2b414788a6004883a02390e2eb0ea227"
  }

• 异常响应

  请参见异常请求结果。

状态码

• 正常

  200

• 异常

  请参见状态码。

错误码

请参见错误码。