DsgSceneQuerySceneListByName -

Queries a list of data masking scenarios.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	DsgSceneQuerySceneListByName	The operation that you want to perform. Set the value to DsgSceneQuerySceneListByName.
SceneName	String	No	dev_	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.

Response parameters

Parameter	Type	Example	Description
Success	Boolean	true	Indicates whether the request was successful. Valid values: true false
ErrorCode	String	1029030003	The error code.
ErrorMessage	String	param error	The error message.
HttpStatusCode	Integer	400	The HTTP status code.
Data	Array of Datas		The returned data.
Id	Long	123	The ID of the data masking scenario.
SceneCode	String	dataworks_display_desense_code	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
Desc	String	Test scenario	The description of the data masking scenario.
SceneName	String	test_scene	The name of the data masking scenario.
UserGroups	String	user1,user2	The list of user groups in the data masking scenario. You can separate the user groups with commas (,).
SceneLevel	Integer	1	The level of the data masking scenario. Valid values: 0: level-1 data masking scenario 1: level-2 data masking scenario
Projects	Array of Project		The information about the compute engine for which the data masking scenario takes effect.
DbType	String	ODPS.ODPS	The type of the compute engine. Valid values: ODPS: ODPS.ODPS HOLO: HOLO.POSTGRES EMR: EMR
ProjectName	String	dev_project	The name of the compute engine instance.
ClusterId	String	c-1234	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.
Children	Array of Any	$ref	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.
RequestId	String	102400001	The request ID. You can use the ID to locate logs and troubleshoot issues.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DsgSceneQuerySceneListByName
&SceneName=dev_
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DsgSceneQuerySceneListByNameResponse>
    <Success>true</Success>
    <ErrorCode>1029030003</ErrorCode>
    <ErrorMessage>param error</ErrorMessage>
    <HttpStatusCode>400</HttpStatusCode>
    <Data>
        <Id>123</Id>
        <SceneCode>dataworks_display_desense_code</SceneCode>
        <Desc>Test scenario</Desc>
        <SceneName>test_scene</SceneName>
        <UserGroups>user1,user2</UserGroups>
        <SceneLevel>1</SceneLevel>
        <Projects>
            <DbType>ODPS.ODPS</DbType>
            <ProjectName>dev_project</ProjectName>
            <ClusterId>c-1234</ClusterId>
        </Projects>
        <Children>$ref</Children>
    </Data>
    <RequestId>102400001</RequestId>
</DsgSceneQuerySceneListByNameResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HttpCode	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.	The data masking scenario is not a level-2 data masking scenario.
400	DESENSSCENE.PROJECT.ERROR	The project space does not exist.	The workspace does not exist.
400	DESENSSCENE.SIZE.ERROR	The number of desens scene exceeds the limit.	The number of data masking scenarios exceeds the upper 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.	The values specified for one or more parameters are invalid.
403	PERMISSION.DENIED.ERROR	Permission denied	You are not authorized to perform this operation.
500	UNKNOWN.ERROR	unknown error.	An unknown error has occurred.

For a list of error codes, see Service error codes.