All Products
Search
Document Center

DataWorks:DsgWhiteListQueryList

Last Updated:Nov 21, 2024

Queries a data masking whitelist.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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.
OperationAccess levelResource typeCondition keyAssociated operation
dataworks:DsgWhiteListQueryListlist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberintegerYes

The page number.

1
PageSizeintegerYes

The number of entries per page. Maximum value: 100.

10
SceneIdlongYes

The ID of the level-2 data masking scenario. You can call the DsgSceneQuerySceneListByName operation to query the list of IDs.

123
DataTypestringNo

The keyword of the sensitive field type.

phone

Response parameters

ParameterTypeDescriptionExample
object

OpenApiResultModel<PagingResultModel>

Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
ErrorCodestring

The error code.

1029030003
ErrorMessagestring

The error message.

param error
HttpStatusCodeinteger

The HTTP status code.

400
PageDataobject

The pagination information.

PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page.

10
TotalCountinteger

The total number of data masking whitelists.

100
Dataarray<object>

A collection of whitelists.

Datasobject
Idlong

The ID of the data masking whitelist.

123
Typestring

The sensitive field type.

phone
UserGroupsarray

A collection of user group names.

UserGroupstring

The name of the user group.

test_group
GmtCreatestring

The time when the whitelist was created.

2024-05-09 15:46:20
GmtModifiedstring

The time when the whitelist was modified.

2024-05-09 15:46:20
RuleIdlong

The ID of the data masking rule.

123
SceneIdlong

The ID of the level-2 data masking scenario.

123
StartTimestring

The time when the data masking whitelist takes effect cannot be earlier than the current time. Unit: days.

2024-05-09 15:46:20
EndTimestring

The expiration time of the data masking whitelist cannot be earlier than the time when the data masking whitelist takes effect. Unit: days.

2024-05-10 15:46:20
RequestIdstring

The request ID. You can use the ID to locate logs and troubleshoot issues.

102400001

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400WHITELIST.DESENSID.ERRORThe 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.
400WHITELIST.ENDTIME.ERRORend time cannot be earlier than start time.The end time cannot be earlier than the start time.
400WHITELIST.ID.ERRORThe 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.
400WHITELIST.MCPROJECT.ERRORThe projectName on the bottom layer desensitization whitelist of MC cannot be empty.ProjectName cannot be empty when creating MC desensitization whitelist
400WHITELIST.PAGESIZE.ERRORPage size is too large, maximum of 100.Page size exceeded, cannot exceed 100
400WHITELIST.SIZE.ERRORThe number of white list exceeds the limit.Whitelist quantity exceeded
400WHITELIST.STARTTIME.ERRORstart time cannot be earlier than today.Start time cannot be earlier than today
400WHITELIST.TIMEFORMAT.ERRORThe 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.
400WHITELIST.USERGROUP.ERRORThe 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.
400WHITELIST.USERGROUPEMPTY.ERRORUser group ID cannot be empty.User group ID cannot be empty
400WHITELIST.USERGROUPLISTSIZE.ERRORThe number of user group exceeds the limit.The number of user groups exceeds the limit.
400PARAMS.ERRORparam error.-
403PERMISSION.DENIED.ERRORPermission deniedInsufficient permissions.
500UNKNOWN.ERRORunknown error.Unknown error.

For a list of error codes, visit the Service error codes.