全部产品
Search
文档中心

大数据开发治理平台 DataWorks:QueryRecognizeRuleDetail - 查询指定敏感字段详情

更新时间:Nov 15, 2024

调用QueryRecognizeRuleDetail接口查询数据保护伞的指定敏感字段详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dataworks:QueryRecognizeRuleDetailget
*全部资源
*

请求参数

名称类型必填描述示例值
SensitiveNamestring

敏感字段名称。可调用 QuerySensNodeInfo 接口,或进入 DataWorks 控制台,在数据保护伞的分类分级界面获取敏感字段名称。

姓名
TenantIdstring

租户 ID。您可登录 DataWorks 控制台,进入数据开发(DataStudio)页面,单击右上方当前登录用户名称,选择菜单 > 用户信息,获取租户 ID。

10241024

返回参数

名称类型描述示例值
object

返回数据。

Successboolean

调用是否成功。

  • true:成功。
  • false:失败。
true
ErrorCodestring

错误码。

9990030003
ErrorMessagestring

错误信息。

缺少参数
HttpStatusCodeinteger

HTTP 状态码。

200
Dataany

返回的敏感字段详情,JSON 格式。

{"nodeName":"单位基本概况","gmtModified":1709017449000,"hitThreshold":30,"sensitiveName":"mobile-yinni","templateId":"8222abeb-9784-4417-b420-0322926d5cbf","recognizeRulesType":2,"delete":false,"bydAccuracy":1,"colScan":"","defineType":1,"ydAccuracy":1,"contentRule":{"contentRule":{},"operationType":0},"nodeParent":"单位/单位基本信息/单位基本概况","level":6,"keyRuleId":"228248921215042mobile-yinni","isDelete":false,"levelName":"6level","sensitive":false,"operationType":0,"sourceName":"dsg-test-zuoyue","nodeId":"bea2fc81-90c9-45f3-b7a9-26d534208a0d","status":1}
RequestIdstring

请求的 ID。用于定位日志,排查问题。

10000001

示例

正常返回示例

JSON格式

{
  "Success": true,
  "ErrorCode": "9990030003",
  "ErrorMessage": "缺少参数",
  "HttpStatusCode": 200,
  "Data": "{\"nodeName\":\"单位基本概况\",\"gmtModified\":1709017449000,\"hitThreshold\":30,\"sensitiveName\":\"mobile-yinni\",\"templateId\":\"8222abeb-9784-4417-b420-0322926d5cbf\",\"recognizeRulesType\":2,\"delete\":false,\"bydAccuracy\":1,\"colScan\":\"\",\"defineType\":1,\"ydAccuracy\":1,\"contentRule\":{\"contentRule\":{},\"operationType\":0},\"nodeParent\":\"单位/单位基本信息/单位基本概况\",\"level\":6,\"keyRuleId\":\"228248921215042mobile-yinni\",\"isDelete\":false,\"levelName\":\"6level\",\"sensitive\":false,\"operationType\":0,\"sourceName\":\"dsg-test-zuoyue\",\"nodeId\":\"bea2fc81-90c9-45f3-b7a9-26d534208a0d\",\"status\":1}",
  "RequestId": "10000001"
}

错误码

HTTP status code错误码错误信息描述
400BADPARAMETERSParameters are missing or in the wrong format.缺少参数

访问错误中心查看更多错误码。