全部產品
Search

搜尋本產品

    DataWorks：DsgSceneQuerySceneListByName - 擷取脫敏情境列表

    文件中心

    DataWorks：DsgSceneQuerySceneListByName - 擷取脫敏情境列表

    更新時間：Mar 05, 2026

    調用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

    • Data Integration靜態脫敏：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 許可權不足。

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。