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

Collecting a WDR Snapshot Report

Function

This API is used to collect a WDR snapshot report. Before calling this API:

Debugging

You can debug this API in API Explorer.

URI

POST /v3/{project_id}/instances/{instance_id}/wdr-snapshots/collect

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
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

start_time

Yes

String

Definition

Snapshot start time. The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between calendar and hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as +0800.

Constraints

N/A

Range

N/A

Default Value

N/A

end_time

Yes

String

Definition

Snapshot end time. The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as +0800.

Constraints

N/A

Range

N/A

Default Value

N/A

wdr_type

Yes

Array of String

Definition

Collection type, which can be instance-level or component-level.

Constraints

For the instance level, enter cluster. For the component level, enter the component ID. The two collection types cannot be specified at the same time.

Response Parameters

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Definition

Job ID.

Range

N/A

Example Request

  • Collecting a component-level WDR snapshot report by time range 
    POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/d04686c6baae4f65a742771186f47b7ain14/wdr-snapshot/collect

{
  "start_time": "2023-08-01T11:10:31+0800",
  "end_time": "2023-08-02T11:10:31+0800",
  "wdr_type": [
    "dn_6001",
    "dn_6002"
  ]
}

Example Response

WDR snapshot collected.

{
  "job_id": "013454b4-112c-4449-97b1-0e8c97011f8"
}

Status Codes

Error Codes

For details, see Error Codes.