Setting the Local Retention Period of Binlogs

Function

This API is used to set the local retention period of binlogs.

• Before calling this API, learn how to authenticate it.
• Before calling this API, learn about request header parameters.

Constraints

• The local retention period of binlogs cannot be set during the DB instance creation.
• This API is supported for RDS for MySQL DB instances only.

URI

• URI format

  PUT /v3/{project_id}/instances/{instance_id}/binlog/clear-policy

• Parameter description

  Table 1 Parameters

  Parameter	Mandatory	Description
  project_id	Yes	Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID.
  instance_id	Yes	Specifies the DB instance ID.

Request

Example Request

PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/fa60258325f6424ca1ba28653629d7b1in01/binlog/clear-policy

{
     "binlog_retention_hours": 3
}

Response

• Normal response

  Table 3 Parameters

  Parameter	Type	Description
  resp	String	Returns successful if the invoking is successful.

• Example normal response

  {
       "resp": "successful"
  }

• Abnormal response

  For details, see Abnormal Request Results.

Status Code

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.