调用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 | 否 | 脱敏规则的生效状态。取值如下:
| 1 |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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. | 参数错误。 |
403 | PERMISSION.DENIED.ERROR | Permission denied | 权限不足。 |
500 | UNKNOWN.ERROR | unknown error. | 未知错误。 |
访问错误中心查看更多错误码。