文档首页/ 数据安全中心 DSC/ API参考/ API/ 静态数据脱敏/ 获取脱敏开关状态 - ShowMaskSwitchStatus
更新时间:2026-11-13 GMT+08:00
分享

获取脱敏开关状态 - ShowMaskSwitchStatus

功能介绍

功能介绍:查询脱敏开关状态详情,返回开关状态值及对应的数据源类型,供控制台展示脱敏功能可用性。

接口约束

  • 无特殊约束。

调用方法

请参见如何调用API。

授权信息

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

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

URI

GET /v2/{project_id}/mask/switch-status

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

type

是

String

参数解释:

脱敏开关类型

约束限制:

不涉及

取值范围:

OBS-OBS,DB-DB,BIGDATA-大数据,MRS_HIVE-MRS Hive,DWS-数据仓库服务,ES-ES,Hive-Hive,HBase-HBase,DLI-数据湖探索

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

status

Integer

参数解释:

脱敏开关状态,表示所查询数据源脱敏功能的开启或关闭状态

取值范围:

  • 0:关闭

  • 1:开启

请求示例

无

响应示例

状态码:200

{
  "status" : 1
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

相关文档