调用DsgSceneQuerySceneListByName获取脱敏场景列表-大数据开发治理平台 DataWorks-阿里云-大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

调用DsgSceneQuerySceneListByName接口，获取脱敏场景列表。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:DsgSceneQuerySceneListByName

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
SceneName	string	否	脱敏场景名称的模糊查询关键字，平台会根据该关键字获取相关脱敏场景信息。	dev_

返回参数

名称	类型	描述	示例值
	object	OpenApiResultModel<List>
Success	boolean	调用是否成功。取值如下： true：调用成功。 false：调用失败。	true
ErrorCode	string	错误码。	1029030003
ErrorMessage	string	错误信息。	param error
HttpStatusCode	integer	HTTP 状态码。	400
Data	array<object>	返回数据。
	array<object>	返回数据。
Id	integer	脱敏场景 ID。	123
SceneCode	string	一级脱敏场景 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	dataworks_display_desense_code
Desc	string	脱敏场景描述信息。	Test scenarios
SceneName	string	脱敏场景名称。	test_scene
UserGroups	string	脱敏场景的用户组名称列表。使用英文逗号（,）隔开。	user1,user2
SceneLevel	integer	脱敏场景级别。取值如下： 0：一级场景 1：二级场景	1
Projects	array<object>	脱敏场景生效的引擎信息。
	object	脱敏场景生效的引擎信息。
DbType	string	引擎类型。取值如下： ODPS：ODPS.ODPS HOLO：HOLO.POSTGRES EMR：EMR	ODPS.ODPS
ProjectName	string	引擎实例名称。	dev_project
ClusterId	string	EMR 集群 ID。仅当脱敏场景生效的数据范围为 EMR 引擎时，会返回该参数。	c-123456
Children	array	多级脱敏场景参数信息。
	any	若存在多级脱敏场景（即脱敏场景存在父子节点嵌套），则此处为嵌套的脱敏场景信息。参数与外层参数相同。	$ref
scenceDbType	string
RequestId	string	请求的 ID。用于定位日志，排查问题。	102400001

示例

正常返回示例

JSON格式

{
  "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"
}

错误码

HTTP status code	错误码	错误信息	描述
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.	参数错误。
500	UNKNOWN.ERROR	unknown error.	未知错误。
403	PERMISSION.DENIED.ERROR	Permission denied	权限不足。

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

变更历史

更多信息，参考变更详情。