All Products
Search
Document Center

DataWorks:DsgSceneQuerySceneListByName

Last Updated:Nov 21, 2024

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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dataworks:DsgSceneQuerySceneListByNamelist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SceneNamestringNo

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

ParameterTypeDescriptionExample
object

OpenApiResultModel<List>

Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
ErrorCodestring

The error code.

1029030003
ErrorMessagestring

The error message.

param error
HttpStatusCodeinteger

The HTTP status code.

400
Dataarray<object>

The returned data.

Datasobject
Idlong

The ID of the data masking scenario.

123
SceneCodestring

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
Descstring

The description of the data masking scenario.

SceneNamestring

The name of the data masking scenario.

test_scene
UserGroupsstring

The list of user groups in the data masking scenario. Separate user groups with commas (,).

user1,user2
SceneLevelinteger

The level of the data masking scenario. Valid values:

  • 0: level-1 data masking scenario
  • 1: level-2 data masking scenario
1
Projectsarray<object>

The information about the compute engine for which the data masking scenario takes effect.

Projectobject
DbTypestring

The type of the compute engine. Valid values:

  • ODPS: ODPS.ODPS
  • HOLO: HOLO.POSTGRES
  • EMR: EMR
ODPS.ODPS
ProjectNamestring

The name of the compute engine.

dev_project
ClusterIdstring

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
Childrenarray

The information about multiple levels of data masking scenarios.

Childrensany

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
RequestIdstring

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 codeError codeError messageDescription
400DESENSSCENE.ID.ERRORThe 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.
400DESENSSCENE.IDLEVEL.ERRORThe desensitization scenario is not a secondary scenario.-
400DESENSSCENE.PROJECT.ERRORThe project space does not exist.-
400DESENSSCENE.SIZE.ERRORThe number of desens scene exceeds the limit.Number of desensitization scenarios chao xian
400DESENSSCENE.UESRGROUP.ERRORThe 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.
400PARAMS.ERRORparam error.-
403PERMISSION.DENIED.ERRORPermission deniedInsufficient permissions.
500UNKNOWN.ERRORunknown error.Unknown error.

For a list of error codes, visit the Service error codes.