DsgSceneQuerySceneListByName -

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DsgSceneQuerySceneListByName	系统规定参数。取值：DsgSceneQuerySceneListByName。
SceneName	String	否	dev_	脱敏场景名称的模糊查询关键字，平台会根据该关键字获取相关脱敏场景信息。

返回数据

名称	类型	示例值	描述
Success	Boolean	true	调用是否成功。取值如下： true：调用成功。 false：调用失败。
ErrorCode	String	1029030003	错误码。
ErrorMessage	String	param error	错误信息。
HttpStatusCode	Integer	400	HTTP状态码。
Data	Array of Datas		返回数据。
Id	Long	123	脱敏场景ID。
SceneCode	String	dataworks_display_desense_code	一级脱敏场景Code。取值如下：数据开发/数据地图展示脱敏：dataworks_display_desense_code MaxCompute引擎层脱敏：maxcompute_desense_code MaxCompute引擎层脱敏（新）：maxcompute_new_desense_code Hologres引擎层脱敏：hologres_display_desense_code 数据集成静态脱敏：dataworks_data_integration_desense_code 数据分析展示脱敏：dataworks_analysis_desense_code
Desc	String	测试用场景	脱敏场景描述信息。
SceneName	String	test_scene	脱敏场景名称。
UserGroups	String	user1,user2	脱敏场景的用户组名称列表。使用英文逗号（,）隔开。
SceneLevel	Integer	1	脱敏场景级别。取值如下： 0：一级场景 1：二级场景
Projects	Array of Project		脱敏场景生效的引擎信息。
DbType	String	ODPS.ODPS	引擎类型。取值如下： ODPS：ODPS.ODPS HOLO：HOLO.POSTGRES EMR：EMR
ProjectName	String	dev_project	引擎实例名称。
ClusterId	String	c-1234	EMR集群ID。仅当脱敏场景生效的数据范围为EMR引擎时，会返回该参数。
Children	Array of Any	$ref	若存在多级脱敏场景（即脱敏场景存在父子节点嵌套），则此处为嵌套的脱敏场景信息。参数与外层参数相同。
RequestId	String	102400001	请求的ID。用于定位日志，排查问题。

示例

请求示例

http(s)://[Endpoint]/?Action=DsgSceneQuerySceneListByName
&SceneName=dev_
&公共请求参数

正常返回示例

XML格式

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>测试用场景</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格式

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" : "测试用场景",
    "SceneName" : "test_scene",
    "UserGroups" : "user1,user2",
    "SceneLevel" : 1,
    "Projects" : [ {
      "DbType" : "ODPS.ODPS",
      "ProjectName" : "dev_project",
      "ClusterId" : "c-1234"
    } ],
    "Children" : [ "$ref" ]
  } ],
  "RequestId" : "102400001"
}

错误码

HttpCode	错误码	错误信息	描述
400	DESENSSCENE.ID.ERROR	The desensitization scenario ID does not match or does not exist with the tenant.	场景ID不存在或不属于该租户。
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.	脱敏场景数量超限。
400	DESENSSCENE.UESRGROUP.ERROR	The user group ID does not match the tenant or does not exist.	用户组ID不存在或不属于该租户。
400	PARAMS.ERROR	param error.	参数错误。
403	PERMISSION.DENIED.ERROR	Permission denied	权限不足。
500	UNKNOWN.ERROR	unknown error.	未知错误。

访问错误中心查看更多错误码。