Obtaining the Local Retention Period of Binlogs

Function

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

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

Authorization Information

URI

• URI format

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

• Parameter description

  Table 1 Parameters

  Parameter	Mandatory	Description
  project_id	Yes	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
  instance_id	Yes	Definition Instance ID. You can obtain the value of this parameter from id in Table 4 by calling the API for querying DB instances. Constraints N/A Range N/A Default Value N/A

Request

• Request parameters

  None

• URI example

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

Response

• Normal response

  Table 2 Parameters

  Parameter	Mandatory	Type	Description
  binlog_retention_hours	Yes	Integer	Definition Local retention period of binlogs, in hours. Range 0 to 168 (7 x 24)
  binlog_clear_type	No	String	Definition Binlog retention policy. Range time: indicates that binlogs are retained by time. fast: indicates that binlogs are not retained.

• Example normal response

  {
       "binlog_retention_hours": 3,
       "binlog_clear_type": "time"
  }

• Abnormal response

  For details, see Abnormal Response Results.

Status Code

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.