DsgSceneQuerySceneListByName

Retrieves data masking scenarios, with optional fuzzy matching by name.

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:DsgSceneQuerySceneListByName

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SceneName	string	No	Keyword for fuzzy-matching scenario names.	dev_

Response elements

Element	Type	Description	Example
	object	OpenApiResultModel<List>
Success	boolean	Whether the request succeeded. Valid values: `true`: The request was successful. `false`: The request failed.	true
ErrorCode	string	Error code.	1029030003
ErrorMessage	string	Error message.	param error
HttpStatusCode	integer	HTTP status code.	400
Data	array<object>	List of data masking scenarios.
	array<object>	Details of a data masking scenario.
Id	integer	Scenario ID.	123
SceneCode	string	Level-1 scenario code. Valid values: Data masking in Data Map and DataStudio: `dataworks_display_desense_code` Data masking at the MaxCompute engine layer: `maxcompute_desense_code` Data masking at the MaxCompute engine layer (new): `maxcompute_new_desense_code` Data masking at the Hologres engine layer: `hologres_display_desense_code` Static data masking in Data Integration: `dataworks_data_integration_desense_code` Data masking in Data Analysis: `dataworks_analysis_desense_code`	dataworks_display_desense_code
Desc	string	Scenario description.	Test scenarios
SceneName	string	Scenario name.	test_scene
UserGroups	string	Applicable user groups, separated by commas (,).	user1,user2
SceneLevel	integer	Scenario level. Valid values: `0`: level-1 scenario `1`: level-2 scenario	1
Projects	array<object>	Engine instances bound to this scenario.
	object	An engine instance bound to this scenario.
DbType	string	Engine type. Valid values: MaxCompute: `ODPS.ODPS` Hologres: `HOLO.POSTGRES` E-MapReduce (EMR): `EMR`	ODPS.ODPS
ProjectName	string	Engine instance name.	dev_project
ClusterId	string	EMR cluster ID. Returned only when `DbType` is `EMR`.	c-123456
Children	array	Nested data masking scenarios.
	any	A nested (level-2) scenario. Parameters match the parent structure.	$ref
scenceDbType	string
RequestId	string	Request ID, used for troubleshooting.	102400001

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	DESENSSCENE.ID.ERROR	The scenario ID does not match or does not exist for this 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 data masking scenarios exceeds the limit.	The number of data masking scenarios exceeds the limit.
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.
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.