DsgDesensPlanQueryList - 脱敏规则列表

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

调试

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

授权信息

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

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

请求参数

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

分页的页数。

1
PageSizeinteger

每页显示的数据条数,最大为 100。

10
SceneIdinteger

二级脱敏场景 ID。您可调用 DsgSceneQuerySceneListByName 接口获取。

123
RuleNamestring

敏感字段名称。

phone
Ownerstring

脱敏规则的负责人。

user1
Statusinteger

脱敏规则的生效状态。取值如下:

  • 0:失效。
  • 1:生效。
1

返回参数

名称类型描述示例值
object

OpenApiResultModel<PagingResultModel>

Successboolean

调用是否成功。取值如下:

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

错误码。

1029030003
ErrorMessagestring

错误信息。

param error
HttpStatusCodeinteger

HTTP 状态码。

400
PageDataobject

分页数据。

PageNumberinteger

页码。

1
PageSizeinteger

每页显示的数据条数,最大为 100。

10
TotalCountinteger

返回的脱敏规则条数。

100
Dataarray<object>

脱敏规则信息。

Datasobject

脱敏规则信息。

Idlong

脱敏规则 ID。

123
DataTypestring

敏感字段类型。

phone
RuleNamestring

脱敏规则名称。

phone_hash
DesensPlanobject

脱敏规则详情。

DesensPlanTypestring

脱敏规则类型。

hash
ExtParamobject

脱敏规则参数。参数信息可参考 DsgDesensPlanAddOrUpdate 接口文档。

any

脱敏规则参数详情。

"extParam": { "algo":"MD5", "salt":"5" }
Ownerstring

脱敏规则的负责人。

user1
GmtCreatestring

脱敏规则的创建时间。

2024-05-09 15:46:20
GmtModifiedstring

脱敏规则的修改时间。

2024-05-09 15:46:20
Statusinteger

脱敏规则的生效状态。取值如下:

  • 0:失效。
  • 1:生效。
1
DesensWaystring

脱敏方式。

HASH
DesenModestring

脱敏方式类型。

HASH
DesensRulestring

脱敏规则。

HASH
SceneCodestring

脱敏规则所属的一级脱敏场景 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
CheckWatermarkboolean

是否添加水印。取值如下:

  • true:添加。
  • false:不添加。
true
SceneNamestring

脱敏规则所属的二级脱敏场景名称。

test_scene
RequestIdstring

请求的 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"
      }
    ]
  },
  "RequestId": "102400001"
}

错误码

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

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