Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ DR Management/ Enabling Log Cache
Updated on 2026-07-16 GMT+08:00
View PDF
Share

Enabling Log Cache

Function

This API is used to enable log cache of the primary instance. Before calling this API:

Constraints

This function is supported only when streaming DR is used and the DB engine version is V2.0-3.200 or later.

Debugging

You can debug this API in API Explorer.

URI

POST /v3.5/{project_id}/instances/{instance_id}/disaster-recovery/keep-log-start

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID, which uniquely identifies an instance. For details about how to obtain the instance ID, see Querying DB Instances.

Constraints

N/A

Range

The value can contain 36 characters. 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.

You can obtain the token by calling the IAM API used to obtain a user token.

After a response is returned, the value of X-Subject-Token in the response header is the token.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Language.

Constraints

N/A

Range

  • zh-cn: Chinese
  • en-us: English

Default Value

en-us
Table 3 Parameter description

Parameter

Mandatory

Type

Description

xlog_keep_ratio

No

Integer

Definition

Ratio of the log cache space to the available disk space (%).

Constraints

This parameter does not take effect for DR instances.

Range

1–99

Default Value

10 for the primary instance

disaster_type

Yes

String

Definition

DR type.

Constraints

N/A

Range

stream: streaming DR.

Default Value

N/A

Response Parameters

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Definition

Job ID.

Range

The value can contain 36 characters, including letters, digits, and hyphens (-).

Example Request

POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.5/0483b6b16e954cb88930a360d2c4e663/instances/c04c789b6baa4b6dbcc139c5226f3a2cin14/disaster-recovery/keep-log-start
{ 
	"xlog_keep_ratio":50,
        "disaster_type" : "stream" 
}

Example Response

{ 
    "job_id":"8bf0175e-562e-45f6-942a-2e2c72c577d7" 
}

Status Codes

Error Codes

For details, see Error Codes.

Parent topic: DR Management