DsgSceneQuerySceneListByName - DataWorks - Alibaba Cloud Documentation Center

Queries a list of data masking scenarios.

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
SceneName	string	No	The name of the data masking scenario. A fuzzy match is performed in the platform based on a keyword to search for the data masking scenario.	dev_

Response parameters

Parameter	Type	Description	Example
	object	OpenApiResultModel<List>
Success	boolean	Indicates whether the request was successful. 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	array<object>	The returned data.
Datas	object
Id	long	The ID of the data masking scenario.	123
SceneCode	string	The code of the level-1 data masking scenario. Valid values: dataworks_display_desense_code: masking of displayed data in DataStudio and Data Map maxcompute_desense_code: data masking at the MaxCompute compute engine layer maxcompute_new_desense_code: data masking at the MaxCompute compute engine layer (new) hologres_display_desense_code: data masking at the Hologres compute engine layer dataworks_data_integration_desense_code: static data masking in Data Integration dataworks_analysis_desense_code: masking of displayed data in DataAnalysis	dataworks_display_desense_code
Desc	string	The description of the data masking scenario.
SceneName	string	The name of the data masking scenario.	test_scene
UserGroups	string	The list of user groups in the data masking scenario. Separate user groups with commas (,).	user1,user2
SceneLevel	integer	The level of the data masking scenario. Valid values: 0: level-1 data masking scenario 1: level-2 data masking scenario	1
Projects	array<object>	The information about the compute engine for which the data masking scenario takes effect.
Project	object
DbType	string	The type of the compute engine. Valid values: ODPS: ODPS.ODPS HOLO: HOLO.POSTGRES EMR: EMR	ODPS.ODPS
ProjectName	string	The name of the compute engine.	dev_project
ClusterId	string	The ID of the EMR cluster. This parameter is returned only when the data scope that takes effect in the data masking scenario is an EMR compute engine.	c-1234
Children	array	The information about multiple levels of data masking scenarios.
Childrens	any	If multiple levels of data masking scenarios exist, which indicates that a data masking scenario contains sub-level data masking scenarios, the value of this parameter is the information about the sub-level data masking scenarios. The parameters are the same as the outer parameters.	$ref
RequestId	string	The request ID. You can locate logs and troubleshoot issues based on the ID.	102400001

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "ErrorCode": "1029030003",
  "ErrorMessage": "param error",
  "HttpStatusCode": 400,
  "Data": [
    {
      "Id": 123,
      "SceneCode": "dataworks_display_desense_code",
      "Desc": "",
      "SceneName": "test_scene",
      "UserGroups": "user1,user2",
      "SceneLevel": 1,
      "Projects": [
        {
          "DbType": "ODPS.ODPS",
          "ProjectName": "dev_project",
          "ClusterId": "c-1234"
        }
      ],
      "Children": [
        "$ref"
      ]
    }
  ],
  "RequestId": "102400001"
}

Error codes

HTTP status code	Error code	Error message	Description
400	DESENSSCENE.ID.ERROR	The desensitization scenario 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	DESENSSCENE.IDLEVEL.ERROR	The desensitization scenario is not a secondary scenario.	-
400	DESENSSCENE.PROJECT.ERROR	The project space does not exist.	-
400	DESENSSCENE.SIZE.ERROR	The number of desens scene exceeds the limit.	Number of desensitization scenarios chao xian
400	DESENSSCENE.UESRGROUP.ERROR	The user group ID does not match the tenant or does not exist.	The user group ID does not exist or does not belong to the tenant.
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.