文档首页/ 数据安全中心 DSC/ API参考/ API/ 数据库脱敏/ 检查脱敏同名任务 - ListCheckNames
更新时间:2026-10-20 GMT+08:00
分享

检查脱敏同名任务 - ListCheckNames

功能介绍

检查脱敏同名任务

调用方法

请参见如何调用API。

授权信息

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

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

URI

GET /v1/{project_id}/sdg/server/mask/dbs/templates/check-name

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

type

是

String

参数解释:

类型,表示待检查名称所属的脱敏任务或脱敏模板的类型标识,用于限定同名检查的范围和对象。

约束限制:

必填,与名称参数配合使用进行同名检查

取值范围:

字符串类型,长度1~256字符

默认取值:

不涉及

name

是

String

参数解释:

名称,表示待检查的脱敏任务或脱敏模板名称,用于检查在同指定类型下是否存在同名任务,避免重名冲突。

约束限制:

必填,与类型参数配合使用进行同名检查

取值范围:

字符串类型,长度1~256字符

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

status

String

参数解释:

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

取值范围:

  • success:成功

  • failed:失败

msg

String

参数解释:

提示信息

取值范围:

不涉及

id

String

参数解释:

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

取值范围:

不涉及

请求示例

检查脱敏同名任务

/v1/2b31ed520abcd1234ebedb6e57123456/sdg/server/mask/dbs/templates/check-name?type=DB&name=db-mask-template-01

响应示例

状态码:200

{
  "status" : "success",
  "msg" : "检查脱敏同名任务成功",
  "id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c"
}

状态码

状态码

描述

200

检查脱敏同名任务成功

错误码

请参见错误码。

相关文档