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

Triggering a WDR Report

Function

This API is used to trigger a WDR report.

Authorization Information

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

  • If you are using role/policy-based authorization, see the required permissions in Permissions Policies and Supported Actions.
  • 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

    Dependencies

    das:clouddba:write

    Write

    Instance

    -

    -

    -

URI

POST /v3/{project_id}/connections/{connection_id}/wdr/trigger-wdr

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 can contain 32 characters. Only letters and digits are supported.

Default Value

N/A

connection_id

Yes

String

Definition

Connection ID established between a database account and the database. The database user ID is created using the API in Creating an Instance Connection.

Constraints

N/A

Range

The value is a UUID containing 36 characters. Only letters, digits, and hyphens (-) are allowed.

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

node_id

Yes

String

Definition

Instance node ID

Constraints

Only GaussDB instance nodes are supported.

Range

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

Default Value

N/A

start_snapshot_id

Yes

Long

Definition

Start ID of the WDR snapshot

Constraints

N/A

Range

N/A

Default Value

N/A

end_snapshot_id

Yes

Long

Definition

End ID of the WDR snapshot

Constraints

N/A

Range

N/A

Default Value

N/A

time_zone

Yes

String

Definition

Time zone

Constraints

Format: Asia/Shanghai

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

success

Boolean

Definition

Operation result

Range

N/A

Example Requests

POST https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/connections/179e525e-0e9c-4dcc-9dd7-ee2f36121e23/wdr/trigger-wdr
 
{
  "start_snapshot_id": 2188,
  "end_snapshot_id": 2189,
  "time_zone": "Asia/Shanghai"
}

Example Responses

Status code: 200

Success.

{"success":true}

Status Codes

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Codes

See Error Codes.