DsgQueryDesensStatusList - DsgQueryDesensStatusList-DataWorks(DataWorks)-阿里云帮助中心

Queries the status of data masking switches.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
SceneCode	string	Yes	The level-1 scene code.	dataworks_display_desense_code
Keyword	string	No	The search keyword.	my
PageNumber	integer	Yes	The page number.	1
PageSize	integer	Yes	The number of entries per page.	10
sceneId	string	No	The scene ID. This parameter is required only when you query workspace-level switch data.	124

Response elements

Element	Type	Description	Example
	object	OpenApiResultModel>
Success	boolean	Indicates whether the request was successful.	true
ErrorCode	string	The error code.	400010
ErrorMessage	string	The error message.	param error
HttpStatusCode	integer	The HTTP status code.	200
Data	object	The details of the returned data.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	20
TotalCount	integer	The total number of entries.	100
PageData	array	The masking rule type.
	object	The data entry.
Id	integer	The switch ID.	56207
DesensStatus	integer	The switch status. 1: enabled. 0: disabled.	1
HandleSpace	string	The project name or workspace ID, depending on the scene.	1
WorkspaceIdentifier	string	The unique identifier of the workspace.	test_space
WorkspaceName	string	The workspace name.	test_space
RequestId	string	The request ID.	AASFDFSDFG-DFSDF-DFSDFD-SDFSDF

Examples

Success response

JSON format

{
  "Success": true,
  "ErrorCode": "400010",
  "ErrorMessage": "param error",
  "HttpStatusCode": 200,
  "Data": {
    "PageNumber": 1,
    "PageSize": 20,
    "TotalCount": 100,
    "PageData": [
      {
        "Id": 56207,
        "DesensStatus": 1,
        "HandleSpace": "1",
        "WorkspaceIdentifier": "test_space",
        "WorkspaceName": "test_space"
      }
    ]
  },
  "RequestId": "AASFDFSDFG-DFSDF-DFSDFD-SDFSDF"
}

Error codes

HTTP status code	Error code	Error message	Description
400	PARAMS.ERROR	param error.	Invalid parameter.
400	DESENSSTATUS.ID.ERROR	The desens status switch ID does not match or does not exist with the tenant.	The masking switch ID does not exist or does not belong to the tenant.
400	DESENSSTATUS.PAGESIZE.ERROR	Page size is too large, maximum of 100.	The page size exceeds the limit. The maximum value is 100.
400	DESENSSTATUS.SCENECODE.ERROR	Scene code does not exist.	The scene code does not exist.
400	DESENSSTATUS.SIZE.ERROR	The number of desens status exceeds the limit.	The number of masking switches exceeds the limit.
500	UNKNOWN.ERROR	unknown error.	An unknown error occurred.
403	PERMISSION.DENIED.ERROR	Permission denied	Insufficient permissions.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.