调用DsgDesensPlanQueryList查询脱敏规则列表-大数据开发治理平台 DataWorks-阿里云-大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

调用DsgDesensPlanQueryList接口，查询数据保护伞的脱敏规则列表。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:DsgDesensPlanQueryList

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
PageNumber	integer	是	分页的页数。	1
PageSize	integer	是	每页显示的数据条数，最大为 100。	10
SceneId	integer	是	二级脱敏场景 ID。您可调用 DsgSceneQuerySceneListByName 接口获取。	123
RuleName	string	否	敏感字段名称。	phone
Owner	string	否	脱敏规则的负责人。	user1
Status	integer	否	脱敏规则的生效状态。取值如下： 0：失效。 1：生效。	1
columns	array<object>	否
	object	否
dbType	string	否
project	string	否
table	string	否
column	string	否
emptyNotDesesn	string	否
dataType	string	否

返回参数

名称	类型	描述	示例值
	object	OpenApiResultModel<PagingResultModel>
Success	boolean	调用是否成功。取值如下： true：调用成功。 false：调用失败。	true
ErrorCode	string	错误码。	1029030003
ErrorMessage	string	错误信息。	param error
HttpStatusCode	integer	HTTP 状态码。	400
PageData	object	分页数据。
PageNumber	integer	页码。	1
PageSize	integer	每页显示的数据条数，最大为 100。	10
TotalCount	integer	返回的脱敏规则条数。	100
Data	array<object>	脱敏规则信息。
	array<object>	脱敏规则信息。
Id	integer	脱敏规则 ID。	123
DataType	string	敏感字段类型。	phone
RuleName	string	脱敏规则名称。	phone_hash
DesensPlan	object	脱敏规则详情。
DesensPlanType	string	脱敏规则类型。	hash
ExtParam	object	脱敏规则参数。参数信息可参考 DsgDesensPlanAddOrUpdate 接口文档。
	any	脱敏规则参数详情。	"extParam": { "algo":"MD5", "salt":"5" }
Owner	string	脱敏规则的负责人。	user1
GmtCreate	string	脱敏规则的创建时间。	2024-05-09 15:46:20
GmtModified	string	脱敏规则的修改时间。	2024-05-09 15:46:20
Status	integer	脱敏规则的生效状态。取值如下： 0：失效。 1：生效。	1
DesensWay	string	脱敏方式。	HASH
DesenMode	string	脱敏方式类型。	HASH
DesensRule	string	脱敏规则。	HASH
SceneCode	string	脱敏规则所属的一级脱敏场景 Code。取值如下：数据开发/数据地图展示脱敏：dataworks_display_desense_code MaxCompute 引擎层脱敏：maxcompute_desense_code MaxCompute 引擎层脱敏（新）：maxcompute_new_desense_code Hologres 引擎层脱敏：hologres_display_desense_code 数据集成静态脱敏：dataworks_data_integration_desense_code 数据分析展示脱敏：dataworks_analysis_desense_code	dataworks_display_desense_code
CheckWatermark	boolean	是否添加水印。取值如下： true：添加。 false：不添加。	true
SceneName	string	脱敏规则所属的二级脱敏场景名称。	test_scene
emptyNotDesesn	boolean
columns	array<object>
	object
dbType	string
project	string
table	string
column	string
RequestId	string	请求的 ID。用于定位日志，排查问题。	102400001

示例

正常返回示例

JSON格式

{
  "Success": true,
  "ErrorCode": "1029030003",
  "ErrorMessage": "param error",
  "HttpStatusCode": 400,
  "PageData": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "Data": [
      {
        "Id": 123,
        "DataType": "phone",
        "RuleName": "phone_hash",
        "DesensPlan": {
          "DesensPlanType": "hash",
          "ExtParam": {
            "key": "\"extParam\": {             \"algo\":\"MD5\",             \"salt\":\"5\"           }"
          }
        },
        "Owner": "user1",
        "GmtCreate": "2024-05-09 15:46:20",
        "GmtModified": "2024-05-09 15:46:20",
        "Status": 1,
        "DesensWay": "HASH",
        "DesenMode": "HASH",
        "DesensRule": "HASH",
        "SceneCode": "dataworks_display_desense_code",
        "CheckWatermark": true,
        "SceneName": "test_scene",
        "emptyNotDesesn": true,
        "columns": [
          {
            "dbType": "",
            "project": "",
            "table": "",
            "column": ""
          }
        ]
      }
    ]
  },
  "RequestId": "102400001"
}

错误码

HTTP status code	错误码	错误信息	描述
400	DESENSPLAN.DATATYPE.ERROR	Sensitive type already has a desensitization rule.	敏感类型已经配置脱敏规则。
400	DESENSPLAN.DATATYPENOTEXIST.ERROR	Sensitive type not exist.	敏感类型不存在。
400	DESENSPLAN.ID.ERROR	Desensitization rule ID does not exist.	脱敏规则ID不存在。
400	DESENSPLAN.PAGESIZE.ERROR	Page size is too large, maximum of 100.	页大小超限，最大为100。
400	DESENSPLAN.PARAM.ERROR	Desensitization rule parameter error.	脱敏规则参数错误。
400	DESENSPLAN.SCENECODE.ERROR	Scene code does not exist.	场景码不存在。
400	DESENSPLAN.SCENEID.ERROR	Scene ID does not exist.	场景ID不存在。
400	DESENSPLAN.SCENEIDLEVEL.ERROR	The scene is not a secondary scene.	场景不是二级场景。
400	DESENSPLAN.SIZE.ERROR	The number of desens plan exceeds the limit.	脱敏规则数量超限。
400	PARAMS.ERROR	param error.	参数错误。
500	UNKNOWN.ERROR	unknown error.	未知错误。
403	PERMISSION.DENIED.ERROR	Permission denied	权限不足。

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

变更历史

更多信息，参考变更详情。