文档首页/ 数据安全中心 DSC/ API参考/ API/ 大数据脱敏/ ES脱敏任务开关 - UpdateSwitchStatusBigdataById
更新时间：2026-10-20 GMT+08:00
在线调试
CLI示例
查看PDF
分享

ES脱敏任务开关 - UpdateSwitchStatusBigdataById

功能介绍

ES脱敏任务开关

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

PUT /v1/{project_id}/sdg/server/mask/bigdata/templates/{template_id}/switch-status

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。可参考获取项目ID获取。

约束限制：

不涉及

取值范围：

以IAM服务接口返回值为准，长度为32个字符，满足正则匹配"^[a-z0-9]{32}$"

默认取值：

不涉及

template_id

是

String

参数解释：

脱敏模板ID，可通过查询脱敏模板列表接口获取

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token，用于接口请求的身份认证。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表3 请求Body参数

参数

是否必选

参数类型

描述

status

否

Integer

参数解释：

脱敏开关状态，0表示关闭，1表示开启

约束限制：

不涉及

取值范围：

  • 0：关闭

  • 1：开启

默认取值：

不涉及

type

否

String

参数解释：

数据源类型，用于指定脱敏开关对应的数据源类型

约束限制：

不涉及

取值范围：

  • OBS-对象存储服务

  • DB-数据库

  • BIGDATA-大数据

  • MRS_HIVE-MRS Hive数据仓库

  • DWS-数据仓库服务

  • ES-Elasticsearch搜索引擎

  • Hive-Hive数据仓库

  • HBase-HBase数据库

  • DLI-数据湖探索

默认取值：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

status

String

参数解释：

请求处理状态，标识任务的执行结果

取值范围：

  • success：成功

  • failed：失败

msg

String

参数解释：

提示信息

取值范围：

不涉及

id

String

参数解释：

被删除的水印嵌入任务对应的资源ID

取值范围：

不涉及

请求示例

ES脱敏任务开关

{
  "status" : 1,
  "type" : "OBS"
}

响应示例

状态码：200

{
  "status" : "success",
  "msg" : "ES脱敏模板开关成功",
  "id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c"
}

状态码

状态码

描述

200

ES脱敏模板开关成功

错误码

请参见错误码。

父主题： 大数据脱敏

相关文档