すべてのプロダクト
Search

このプロダクト

    DataWorks:GetQualityEntity

    ドキュメントセンター

    DataWorks:GetQualityEntity

    最終更新日:Mar 18, 2026

    GetQualityEntity を呼び出して、パーティションフィルター式を取得します。

    説明

    この API は廃止されました。一時的にアクセス可能ですが、更新やバグ修正対応は一切行われません。代わりに dataworks-public(2024-05-18) - GetDataQualityScan への移行を推奨します。より強化された機能に加え、サポートも引き続きご利用いただけます。

    今すぐお試しください

    この 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:*

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ProjectName

    string

    必須

    エンジンまたはデータソースの名前です。この名前は「データソース設定」ページで確認できます。

    autotest
    TableName

    string

    必須

    パーティションテーブルの名前です。GetMetaTablePartition 操作を呼び出して、テーブル名を取得できます。

    dual
    EnvType

    string

    必須

    エンジンまたはデータソースの種類です。有効な値は以下のとおりです。

    • cdh

    • analyticdb_for_mysql

    • odps

    • emr

    • hadoop

    • holodb

    • hybriddb_for_postgresql

    odps
    MatchExpression

    string

    任意

    パーティション式。

    dt=$[yyyymmdd]
    ProjectId

    integer

    必須

    DataWorks ワークスペースの ID です。ワークスペース ID を確認するには、DataWorks コンソール にログインし、「ワークスペース設定」ページに移動します。

    123456

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答オブジェクトです。

    HttpStatusCode

    integer

    HTTP ステータスコードです。

    200
    RequestId

    string

    リクエスト ID です。

    6d739ef6-098a-47****
    ErrorMessage

    string

    エラーメッセージです。

    You have no permission.
    ErrorCode

    string

    エラーコードです。

    401
    Success

    boolean

    リクエストが成功したかどうかを示します。

    true
    Data

    array<object>

    返されたデータです。

    object

    データの詳細です。

    RelativeNode

    string

    パーティションフィルター式に関連付けられたスケジューリングノードです。このパラメーターには、以下のサブパラメーターが含まれます。

    • ProjectName：スケジューリングノードが属するワークスペースの名前。

    • NodeID：スケジューリングノードの ID。

    [{"projectName":"xc_DP****","nodeId":7000026****}]
    OnDutyAccountName

    string

    所有者の Alibaba Cloud アカウントの名前です。

    test
    Task

    integer

    タスクノードです。

    0
    TableName

    string

    パーティションテーブルの名前です。

    test_dqc_de****
    Followers

    string

    アラート通知を受信するサブスクライバーです。値は Alibaba Cloud アカウントの ID です。

    1822931****
    OnDuty

    string

    パーティションフィルター式を設定した所有者です。値は Alibaba Cloud アカウントの ID です。

    1822931****
    MatchExpression

    string

    パーティションフィルター式です。

    dt=$[yyyymmdd-1]
    CreateTime

    integer

    パーティションフィルター式が作成された時刻です。

    1593964800000
    ProjectName

    string

    エンジンまたはデータソースの名前です。

    autotest
    HasRelativeNode

    boolean

    パーティションフィルター式がスケジューリングノードに関連付けられているかどうかを示します。有効な値は以下のとおりです。

    • true：パーティションフィルター式はスケジューリングノードに関連付けられています。

    • false：パーティションフィルター式はスケジューリングノードに関連付けられていません。

    true
    EnvType

    string

    エンジンまたはデータソースの種類です。

    odps
    EntityLevel

    integer

    パーティションフィルター式のレベルです。有効な値は以下のとおりです。

    • 0（SQL レベル）：各 SQL ステートメント実行後にデータ品質チェックがトリガーされます。

    • 1（タスクレベル）：すべての SQL ステートメント実行後にデータ品質チェックがトリガーされます。

    0
    ModifyUser

    string

    パーティションフィルター式を更新したユーザーです。値は Alibaba Cloud アカウントの ID です。

    1822931****
    Sql

    integer

    SQL レベルのパーティションフィルター式です。

    0
    Id

    integer

    パーティションフィルター式の ID です。

    4003918
    ModifyTime

    integer

    パーティションフィルター式が最後に更新された時刻です。

    1593964800000

    例

    成功レスポンス

    JSONJSON

    {
  "HttpStatusCode": 200,
  "RequestId": "6d739ef6-098a-47****",
  "ErrorMessage": "You have no permission.",
  "ErrorCode": "401",
  "Success": true,
  "Data": [
    {
      "RelativeNode": "[{\"projectName\":\"xc_DP****\",\"nodeId\":7000026****}]",
      "OnDutyAccountName": "test",
      "Task": 0,
      "TableName": "test_dqc_de****",
      "Followers": "1822931****",
      "OnDuty": "1822931****",
      "MatchExpression": "dt=$[yyyymmdd-1]",
      "CreateTime": 1593964800000,
      "ProjectName": "autotest",
      "HasRelativeNode": true,
      "EnvType": "odps",
      "EntityLevel": 0,
      "ModifyUser": "1822931****",
      "Sql": 0,
      "Id": 4003918,
      "ModifyTime": 1593964800000
    }
  ]
}

    エラーコード

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

    変更履歴

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