更新时间:2025-09-11 GMT+08:00
分享

采集WDR快照报告

功能介绍

采集WDR快照报告。

调试

您可以在API Explorer中调试该接口。

URI

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

表1 参数说明

名称

是否必选

说明

project_id

参数解释:

租户在某一Region下的项目ID。

获取方法请参见获取项目ID

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

instance_id

参数解释:

实例ID,此参数是用户创建实例的唯一标识。

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为36个字符。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

X-Language

String

参数解释:

语言。

约束限制:

不涉及。

取值范围:

  • zh-cn
  • en-us

默认取值

en-us

表3 请求Body参数

参数

是否必选

参数类型

描述

start_time

String

参数解释:

快照开始时间。格式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始,Z指时区偏移量,例如北京时间偏移显示为+0800。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

end_time

String

参数解释:

快照结束时间。格式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始,Z指时区偏移量,例如北京时间偏移显示为+0800。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

wdr_type

Array of String

参数解释:

采集类型,包括实例级和组件级。

约束限制:

实例级则需要输入"cluster",组件级则需要输入组件ID。实例级和组件级无法同时输入。

响应参数

表4 响应Body参数

参数

参数类型

描述

job_id

String

参数解释:

任务ID。

取值范围:

不涉及。

请求示例

  • 使用时间区间方式,采集组件级的WDR快照报告。
    POST https://gaussdb-opengauss.cn-north-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"
      ]
    }
  • 使用时间区间方式,采集实例级的WDR快照报告。
    POST https://gaussdb-opengauss.cn-north-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" : [ "cluster" ],
       "mode": "time_range" 
     }

响应示例

采集WDR快照成功。

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

状态码

错误码

请参见错误码

相关文档