DsgWhiteListDeleteList

Updated at:

Deletes data masking whitelists from Data Security Guard.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:DsgWhiteListDeleteList

list

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

Ids

array

Yes

The IDs of the whitelists.

integer

No

The whitelist ID. Call DsgWhiteListQueryList to query whitelist IDs.

123

Response elements

Element

Type

Description

Example

object

OpenApiResultModel

Success

boolean

Whether the request succeeded. Valid values:

  • true

  • false

true

ErrorCode

string

The error code.

1029030003

ErrorMessage

string

The error message.

param error

HttpStatusCode

integer

The HTTP status code.

400

Data

boolean

Whether the deletion succeeded. Valid values:

  • true: succeeded.

  • false: failed.

true

RequestId

string

The request ID. Use this ID for troubleshooting.

102400001

Examples

Success response

JSON format

{
  "Success": true,
  "ErrorCode": "1029030003",
  "ErrorMessage": "param error",
  "HttpStatusCode": 400,
  "Data": true,
  "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.
500 UNKNOWN.ERROR unknown error. Unknown error.
403 PERMISSION.DENIED.ERROR Permission denied Insufficient permissions.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.