すべてのプロダクト
Search

このプロダクト

    DataWorks:DsgSceneQuerySceneListByName

    ドキュメントセンター

    DataWorks:DsgSceneQuerySceneListByName

    最終更新日:Mar 05, 2026

    DsgSceneQuerySceneListByName API を呼び出して、データマスキングシナリオのリストを取得します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dataworks:DsgSceneQuerySceneListByName

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    SceneName

    string

    任意

    データマスキングシナリオ名でのあいまい検索に使用するキーワードです。

    dev_

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答オブジェクト。

    Success

    boolean

    呼び出しが成功したかどうかを示します。 値 true は呼び出しが成功したことを示し、値 false は呼び出しが失敗したことを示します。

    • 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

    レベル 1 データマスキングシナリオのコード。 有効な値：

    • dataworks_display_desense_code：データ開発とデータマップの表示マスキング。

    • maxcompute_desense_code：MaxCompute のエンジンレベルのマスキング。

    • maxcompute_new_desense_code：MaxCompute (新しいバージョン) のエンジンレベルのマスキング。

    • hologres_display_desense_code：Hologres の表示マスキング。

    • 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：レベル 2 シナリオ

    1
    Projects

    array<object>

    シナリオが適用されるエンジンのリスト。

    object

    シナリオが適用されるエンジン。

    DbType

    string

    エンジンのタイプ。 有効な値：

    • ODPS.ODPS：MaxCompute エンジン。

    • HOLO.POSTGRES：Hologres エンジン。

    • EMR：E-MapReduce (EMR) エンジン。

    ODPS.ODPS
    ProjectName

    string

    エンジンインスタンスの名前。

    dev_project
    ClusterId

    string

    EMR クラスター ID。 このパラメーターは、マスキングシナリオが EMR エンジンに適用される場合にのみ返されます。

    c-123456
    Children

    array

    多階層マスキングシナリオのパラメーター情報。

    any

    多階層マスキングシナリオ (つまり、マスキングシナリオに親子ノードのネストが存在する) がある場合、これはネストされたマスキングシナリオ情報です。 パラメーターは外側のパラメーターと同じです。

    $ref
    scenceDbType

    string

    RequestId

    string

    リクエスト ID。 ログの特定や問題のトラブルシューティングに使用します。

    102400001

    例

    成功レスポンス

    JSONJSON

    {
  "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 ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 DESENSSCENE.ID.ERROR The desensitization scenario ID does not match or does not exist with the tenant.
    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.
    400 PARAMS.ERROR param error.
    500 UNKNOWN.ERROR unknown error.
    403 PERMISSION.DENIED.ERROR Permission denied

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。