All Products
Search
Document Center

:DsgWhiteListQueryList

Last Updated:Jun 05, 2024

Queries a data masking whitelist configured in Data Security Guard.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action

String

Yes

DsgWhiteListQueryList

The operation that you want to perform. Set the value to DsgWhiteListQueryList.

PageNumber

Integer

Yes

1

The page number.

PageSize

Integer

Yes

10

The number of entries per page. Valid values: 1 to 100.

SceneId

Long

Yes

123

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

DataType

String

No

phone

The keyword of the sensitive field type.

Response parameters

Parameter

Type

Example

Description

Success

Boolean

true

Indicates whether the request was successful. Valid values:

  • true

  • false

ErrorCode

String

1029030003

The error code.

ErrorMessage

String

param error

The error message.

HttpStatusCode

Integer

400

The HTTP status code.

PageData

Object

The pagination information.

PageNumber

Integer

1

The page number.

PageSize

Integer

10

The number of entries per page.

TotalCount

Integer

100

The total number of data masking whitelists.

Data

Array of Datas

A collection of whitelists.

Id

Long

123

The ID of the data masking whitelist.

Type

String

phone

The sensitive field type.

UserGroups

Array of String

test_group

The name of the user group.

GmtCreate

String

2024-05-09 15:46:20

The time when the whitelist was created.

GmtModified

String

2024-05-09 15:46:20

The time when the whitelist was modified.

RuleId

Long

123

The ID of the data masking rule.

SceneId

Long

123

The ID of the level-2 data masking scenario.

StartTime

String

2024-05-09 15:46:20

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

EndTime

String

2024-05-10 15:46:20

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

RequestId

String

102400001

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

Examples

Sample requests

http(s)://[Endpoint]/?Action=DsgWhiteListQueryList
&PageNumber=1
&PageSize=10
&SceneId=123
&DataType=phone
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DsgWhiteListQueryListResponse>
    <Success>true</Success>
    <ErrorCode>1029030003</ErrorCode>
    <ErrorMessage>param error</ErrorMessage>
    <HttpStatusCode>400</HttpStatusCode>
    <PageData>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <TotalCount>100</TotalCount>
        <Data>
            <Id>123</Id>
            <Type>phone</Type>
            <UserGroups>test_group</UserGroups>
            <GmtCreate>2024-05-09 15:46:20</GmtCreate>
            <GmtModified>2024-05-09 15:46:20</GmtModified>
            <RuleId>123</RuleId>
            <SceneId>123</SceneId>
            <StartTime>2024-05-09 15:46:20</StartTime>
            <EndTime>2024-05-10 15:46:20</EndTime>
        </Data>
    </PageData>
    <RequestId>102400001</RequestId>
</DsgWhiteListQueryListResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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

HttpCode

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.

The ProjectName parameter must specified when you create a data masking whitelist for a MaxCompute project.

400

WHITELIST.PAGESIZE.ERROR

Page size is too large, maximum of 100.

The number of entries per page exceeds the upper limit. The maximum number of entries per page is 100.

400

WHITELIST.SIZE.ERROR

The number of white list exceeds the limit.

The number of whitelists exceeds the upper limit.

400

WHITELIST.STARTTIME.ERROR

start time cannot be earlier than today.

The 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 incorrectly formatted. The time should be in the yyyy MM dd HH: mm: ss format.

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.

The user group ID must be specified.

400

WHITELIST.USERGROUPLISTSIZE.ERROR

The number of user group exceeds the limit.

The number of user groups exceeds the upper limit.

400

PARAMS.ERROR

param error.

The values specified for one or more parameters are invalid.

403

PERMISSION.DENIED.ERROR

Permission denied

You are not authorized to perform this operation.

500

UNKNOWN.ERROR

unknown error.

An unknown error has occurred.

For a list of error codes, see Service error codes.