Queries a data masking whitelist.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
dataworks:DsgWhiteListQueryList | list | *All Resources * |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
PageNumber | integer | Yes | The page number. | 1 |
PageSize | integer | Yes | The number of entries per page. Maximum value: 100. | 10 |
SceneId | long | Yes | The ID of the level-2 data masking scenario. You can call the DsgSceneQuerySceneListByName operation to query the list of IDs. | 123 |
DataType | string | No | The keyword of the sensitive field type. | phone |
Response parameters
Examples
Sample success responses
JSON
format
{
"Success": true,
"ErrorCode": "1029030003",
"ErrorMessage": "param error",
"HttpStatusCode": 400,
"PageData": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 100,
"Data": [
{
"Id": 123,
"Type": "phone",
"UserGroups": [
"test_group"
],
"GmtCreate": "2024-05-09 15:46:20",
"GmtModified": "2024-05-09 15:46:20",
"RuleId": 123,
"SceneId": 123,
"StartTime": "2024-05-09 15:46:20",
"EndTime": "2024-05-10 15:46:20"
}
]
},
"RequestId": "102400001"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | WHITELIST.DESENSID.ERROR | The desensitization rule ID does not match or does not exist with the tenant. | The scenario ID does not exist or does not belong to the tenant. |
400 | WHITELIST.ENDTIME.ERROR | end time cannot be earlier than start time. | The end time cannot be earlier than the start time. |
400 | WHITELIST.ID.ERROR | The whitelist ID does not match or does not exist with the tenant. | The whitelist ID does not exist or does not belong to the tenant. |
400 | WHITELIST.MCPROJECT.ERROR | The projectName on the bottom layer desensitization whitelist of MC cannot be empty. | ProjectName cannot be empty when creating MC desensitization whitelist |
400 | WHITELIST.PAGESIZE.ERROR | Page size is too large, maximum of 100. | Page size exceeded, cannot exceed 100 |
400 | WHITELIST.SIZE.ERROR | The number of white list exceeds the limit. | Whitelist quantity exceeded |
400 | WHITELIST.STARTTIME.ERROR | start time cannot be earlier than today. | Start time cannot be earlier than today |
400 | WHITELIST.TIMEFORMAT.ERROR | The time format is incorrect, please use yyyy MM dd HH: mm: ss format. | The time parameter is formatted incorrectly. You need to use yyyy MM dd HH: mm: ss. |
400 | WHITELIST.USERGROUP.ERROR | The user group ID does not match or does not exist with the tenant. | The user group ID does not exist or does not belong to the tenant. |
400 | WHITELIST.USERGROUPEMPTY.ERROR | User group ID cannot be empty. | User group ID cannot be empty |
400 | WHITELIST.USERGROUPLISTSIZE.ERROR | The number of user group exceeds the limit. | The number of user groups exceeds the limit. |
400 | PARAMS.ERROR | param error. | - |
403 | PERMISSION.DENIED.ERROR | Permission denied | Insufficient permissions. |
500 | UNKNOWN.ERROR | unknown error. | Unknown error. |
For a list of error codes, visit the Service error codes.