Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Workload Diagnosis Report (WDR)/ Querying WDR Snapshot Status
Updated on 2025-10-20 GMT+08:00
View PDF
Share

Querying WDR Snapshot Status

Function

This API is used to query WDR Snapshot status. Before calling this API:

Debugging

You can debug this API in API Explorer.

URI

GET /v3/{project_id}/instances/{instance_id}/wdr-snapshot/status

Table 1 Parameter description

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

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

Default Value

N/A

instance_id

Yes

Definition

Instance ID, which uniquely identifies an instance.

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.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Language.

Constraints

N/A

Range

  • zh-cn
  • en-us

Default Value

en-us

Response Parameters

Table 3 Response body parameters

Parameter

Type

Description

status

String

Definition

WDR Snapshot status. Its value is case-insensitive.

Range

  • ON: WDR Snapshot is enabled.
  • OFF: WDR Snapshot is disabled.

start_time

String

Definition

Earliest time when a snapshot is generated. The format is yyyy-mm-dd hh:mm:ss timezone. timezone indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as +08. If no snapshots are generated, the value is left blank.

Range

N/A

end_time

String

Definition

Latest time when a snapshot is generated. The format is yyyy-mm-dd hh:mm:ss timezone. timezone indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as +08. If no snapshots are generated, the value is left blank.

Range

N/A

Example Request

Querying WDR Snapshot status

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/d04686c6baae4f65a742771186f47b7ain14/wdr-snapshot/status

Example Response

WDR Snapshot status returned.

{
   "status": "ON",
   "start_time": "2023-07-24 18:38:10.119531+08",
   "end_time": "2023-08-03 11:10:31.850324+08"
}

Status Codes

Error Codes

For details, see Error Codes.