文档首页/ 云数据库 GaussDB/ API参考/ API(推荐)/ WDR报告/ 查询WDR快照报告采集结果 - QueryingCollectionResultsforWDRSnapshotReports
更新时间:2025-12-25 GMT+08:00
分享

查询WDR快照报告采集结果 - QueryingCollectionResultsforWDRSnapshotReports

功能介绍

查询WDR快照报告采集结果。

调试

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

URI

GET /v3/{project_id}/instances/{instance_id}/wdr-snapshots

表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 请求Query参数

参数

是否必选

参数类型

描述

offset

integer

参数解释:

索引位置,偏移量。

约束限制:

不涉及。

取值范围:

必须为数字,不能为负数。

默认取值:

0

limit

integer

参数解释:

查询记录数。

约束限制:

不能为负数。

取值范围:

最小值为1,最大值为100。

默认取值:

10

start_time

String

参数解释:

查询开始时间。格式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始,Z指时区偏移量,时区中的+号需要进行URL编码,编码为%2B,时区中的-号无需编码。

例如北京时间偏移显示为+0800,start_time=2024-03-15T17:20:33+0800传参时编码为start_time=2024-03-15T17:20:33%2B0800。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

end_time

String

参数解释:

查询结束时间。格式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始,Z指时区偏移量,时区中的+号需要进行URL编码,编码为%2B,时区中的-号无需编码。

例如北京时间偏移显示为+0800,end_time=2024-03-16T17:20:33+0800传参时编码为end_time=2024-03-16T17:20:33%2B0800。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

job_id

String

参数解释:

任务ID。正确填写后,可查询指定任务对应的快照报告采集结果。

约束限制:

不支持模糊匹配,需填写完整的任务ID。

取值范围:

不涉及。

默认取值:

不涉及。

status

String

参数解释:

任务采集状态。填写后,可查询对应采集状态的任务结果。

约束限制:

不支持模糊匹配,区分大小写,请填写完整的合法状态值。

取值范围:

  • EXPORTING:采集中。
  • SUCCESS:采集成功。
  • FAILED:采集失败。

默认取值:

不涉及。

wdr_type

String

参数解释:

采集类型。

填写后,可查询对应采集类型的任务结果。

约束限制:

不支持模糊匹配,区分大小写,请填写完整的合法枚举值。

取值范围:

  • cluster:实例级。
  • component:组件级。
  • pdb:租户级。

默认取值:

不涉及。

job_start_time

String

参数解释:

采集任务创建时间起点。可查询任务创建时间大于等于该时间起点的任务结果。格式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始;Z指时区偏移量。

时区中的+号需要进行URL编码,编码为%2B,时区中的-号无需编码。

例如,北京时间偏移显示为+0800,job_start_time=2024-03-15T17:20:33+0800传参时编码为job_start_time=2024-03-15T17:20:33%2B0800。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

job_end_time

String

参数解释:

采集任务创建时间终点。可查询任务创建时间小于等于该时间终点的任务结果。格式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始;Z指时区偏移量。

时区中的+号需要进行URL编码,编码为%2B,时区中的-号无需编码。

例如,北京时间偏移显示为+0800,job_end_time=2024-03-16T17:20:33+0800,传参时编码为job_end_time=2024-03-16T17:20:33%2B0800。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

表4 响应Body参数

参数

参数类型

描述

wdr_snapshots

Array of objects

参数解释:

WDR快照信息列表。详细内容请参见表5

total_count

Integer

参数解释:

总记录数。

取值范围:

不涉及。

表5 ListWdrSnapshotsResult

参数

参数类型

描述

job_id

String

参数解释:

任务ID。

取值范围:

不涉及。

file_size

Integer

参数解释:

文件大小,单位KB。

取值范围:

当status为SUCCESS时,该值不为空。

wdr_type

String

参数解释:

采集类型。

取值范围:

  • cluster:实例级。
  • component:组件级。
  • pdb:租户级。

start_time

String

参数解释:

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

取值范围:

不涉及。

end_time

String

参数解释:

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

取值范围:

不涉及。

job_create_time

String

参数解释:

WDR报告生成任务的创建时间。格式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始,Z指时区偏移量,当前时间固定为+0时区。例如,"2025-07-08T10:57:59+0000"。

取值范围:

不涉及。

start_snapshot_id

String

参数解释:

用于生成WDR报告的第一个对比快照ID。例如:"20024"。只针对使用报告生成模式为对比快照ID(mode=snapshot_id)的采集任务生效;如果该任务使用的是时间区间查询方式(mode=time_range),则该字段为空。

取值范围:

不涉及。

end_snapshot_id

String

参数解释:

用于生成WDR报告的第二个对比快照ID。例如:"20025"。只针对使用报告生成模式为对比快照ID(mode=snapshot_id)的采集任务生效;如果该任务使用的是时间区间查询方式(mode=time_range)来生成的,则该字段为空。

取值范围:

不涉及。

download_url

String

参数解释:

报告下载链接,有效时间为30分钟。

取值范围:

当status为SUCCESS时,该值不为空。

status

String

参数解释:

采集状态。

取值范围:

  • SUCCESS:采集成功。
  • FAILED:采集失败。
  • EXPORTING:采集中。

notes

string

参数解释:

备注。采集类型为组件级时,内容包括采集的组件ID。

取值范围:

不涉及。

error_msg

String

参数解释:

错误信息,供运维定位分析使用。

取值范围:

不涉及。

file_name

String

数解释:

WDR报告临时文件名称。

取值范围:

不涉及。

file_path

String

参数解释:

WDR报告临时文件保存路径。

取值范围:

不涉及。

obs_bucket

Array of objects

参数解释:

存储WDR报告临时文件的OBS桶信息。参见表6

表6 ObsBucket

参数

参数类型

描述

name

String

参数解释:

OBS桶名称。

取值范围:

不涉及。

type

String

参数解释:

OBS桶类型。

取值范围:

  • common:公共桶。
  • aps:智能运维专用桶。

url

String

参数解释:

OBS服务访问地址。

取值范围:

不涉及。

port

Integer

参数解释:

OBS服务端口号。

取值范围:

不涉及。

domain_id

String

参数解释:

最终租户ID。

取值范围:

不涉及。

请求示例

GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/d04686c6baae4f65a742771186f47b7ain14/wdr-snapshot?limit=10&offset=0

响应示例

查询WDR快照列表。

{
     "wdr_snapshots": [{
       "job_id": "56c196275a9a59f6c4c047414d64a5a7",
       "file_size": 1024,
       "wdr_type": "component",
       "start_time": "2023-07-24T18:38:10+0000",
       "end_time": "2023-08-01T15:32:11+0000",
       "start_snapshot_id": "14",
       "end_snapshot_id": "15",
       "job_create_time": "2023-08-02T02:33:57+0000",
       "download_url": https://dbs-0-sa-fb-1-21a59c4449fd4ef4b20b7c13f5777f42-gaussdbaps.obsv3.sa-fb-1.guiyang-x86-3.com:443/48ca77871d43477db2a7190e2d8ea7a8_wdr_download_680caff6-0746-4c2b-b23f-fff54df4e9f2/48ca77871d43477db2a7190e2d8ea7a8_add63d531234421aadbe74a991eac6c6in14_20250712052202_20250712062210_metric_file_wdr.tar.gz?AccessKeyId=MQ7RUJKGCWLPQWA17S2C&Expires=1752289798&Signature=p3thVQrN12v7lfBDjnPKVotlR3g%3D",
       "status": "SUCCESS",
       "notes": "dn_6001,dn_6002"
       "error_msg": null,
       "file_path": "48ca77871d43477db2a7190e2d8ea7a8_wdr_download_680caff6-0746-4c2b-b23f-fff54df4e9f2/",
       "file_name": "48ca77871d43477db2a7190e2d8ea7a8_add63d531234421aadbe74a991eac6c6in14_20250712052202_20250712062210_metric_file_wdr.tar.gz",
       "obs_bucket": {
                "name": "dbs-0-sa-fb-1-21a59c4449fd4ef4b20b7c13f5777f42-gaussdbaps",
                "type": "aps",
                "url": "obsv3.sa-fb-1.guiyang-x86-3.com",
                "port": 443,
                "domain_id": "d0409f2f635a4a0d99227d6a8b6fb795"
        }
      }],
    "total_count": 10
}

状态码

错误码

请参见错误码

相关文档