文档首页/ 云数据库 GaussDB/ API参考/ API(推荐)/ WDR报告/ 打开或者关闭WDR快照开关
更新时间:2025-09-11 GMT+08:00
分享

打开或者关闭WDR快照开关

功能介绍

打开或者关闭WDR快照开关。

调试

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

URI

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

表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参数

参数

是否必选

参数类型

描述

status

String

参数解释:

开关状态,不区分大小写。

约束限制:

不涉及。

取值范围:

  • ON:WDR快照开启。
  • OFF:WDR快照关闭。

默认取值

不涉及。

响应参数

无。

请求示例

PUT https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/d04686c6baae4f65a742771186f47b7ain14/wdr-snapshot/status
{ 
  "status" : "ON" 
}

响应示例

无。

状态码

错误码

请参见错误码

相关文档