すべてのプロダクト
Search

このプロダクト

    DataWorks:ListQualityRules

    ドキュメントセンター

    DataWorks:ListQualityRules

    最終更新日:Mar 18, 2026

    ListQualityRules を呼び出して、パーティションフィルター式に一致する品質ルールを取得します。

    説明

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

    今すぐお試しください

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

    テスト

    RAM 認証

    この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ProjectName

    string

    必須

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

    autotest
    EntityId

    integer

    必須

    パーティションフィルター式の ID です。GetQualityEntity 操作を呼び出してこの ID を取得します。

    12345
    PageNumber

    integer

    必須

    ページ番号です。

    1
    PageSize

    integer

    必須

    1 ページあたりに返すエントリ数です。デフォルト値：10。最大値：20。

    20
    ProjectId

    integer

    必須

    DataWorks ワークスペースの ID です。

    12345

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答オブジェクトです。

    HttpStatusCode

    integer

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

    200
    RequestId

    string

    リクエストの ID です。

    38cbdef0-f6cf-49****
    ErrorMessage

    string

    エラーメッセージです。

    You have no permission.
    Success

    boolean

    リクエストが成功したかどうかを示します。有効な値：

    • true

    • false

    true
    ErrorCode

    string

    エラーコードです。

    Invalid.Tenant.ConnectionNotExists
    Data

    object

    品質ルールのページネーション付きリストです。

    PageNumber

    integer

    ページ番号です。

    1
    PageSize

    integer

    1 ページあたりのエントリ数です。有効な値は 1～100 です。デフォルト値：10。

    20
    TotalCount

    integer

    返されたエントリの合計数です。

    400
    Rules

    array<object>

    品質ルールの詳細です。

    object

    返されるデータです。

    BlockType

    integer

    モニタリングルールの強度です。強度は、そのルールの重要度を示します。有効な値：

    • 1：強制ルールです。

    • 0：通常ルールです。ビジネス要件に応じて、モニタリングルールを強制ルールとして指定できます。強制ルールがトリガーされると、重大アラートが報告され、タスクのスケジューリングがブロックされます。

    0
    OnDutyAccountName

    string

    モニタリングルールの設定に使用される Alibaba Cloud アカウントの名前です。

    test
    Property

    string

    フィールドの名前です。

    id
    WarningThreshold

    string

    警告アラートのしきい値です。これは、モニタリング結果と期待値との偏差を指定します。ビジネス要件に応じて、しきい値をカスタマイズできます。

    10
    TableName

    string

    テーブルの名前です。

    dual
    OnDuty

    string

    モニタリングルールの設定に使用される Alibaba Cloud アカウントの ID です。

    1912****
    Comment

    string

    モニタリングルールの説明です。

    Verify table rules
    RuleCheckerRelationId

    integer

    ルール詳細の内部関連 ID です。

    132323
    FixCheck

    boolean

    チェックに固定値が使用されるかどうかを示します。

    true
    MethodId

    integer

    サンプルデータを収集するために使用されるメソッドの ID です。

    21
    TemplateName

    string

    モニタリングテンプレートの名前です。

    Number of SQL task table rows, 1, 7, and 30 days wave detection
    Trend

    string

    モニタリング結果の傾向です。

    abs
    HistoryWarningThreshold

    string

    警告アラートの履歴しきい値です。

    history max:40%,history min:10%
    RuleType

    integer

    モニタリングルールの種類です。有効な値：

    • 0：システムによって作成されたモニタリングルールです。

    • 1：ユーザーによって作成されたモニタリングルールです。

    • 2：ワークスペースレベルのモニタリングルールです。

    0
    MatchExpression

    string

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

    dt=$[yyyymmdd]
    ProjectName

    string

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

    autotest
    PropertyKey

    string

    このパラメーターは使用されません。無視してください。

    table_count
    CriticalThreshold

    string

    重大アラートのしきい値です。これは、モニタリング結果と期待値との偏差を指定します。ビジネス要件に応じて、しきい値をカスタマイズできます。強制ルールを使用している場合、重大アラートがトリガーされると、タスクのスケジューリングがブロックされます。

    40
    HistoryCriticalThreshold

    string

    重大アラートの履歴しきい値です。

    history max:80%,history min:50%
    MethodName

    string

    サンプルデータを収集するために使用されるメソッドの名前です。例：avg、count、sum、min、max、count_distinct、user_defined、table_count、table_size、table_dt_load_count、table_dt_refuseload_count、null_value、null_value/table_count、(table_count-count_distinct)/table_count、table_count-count_distinct など。

    count/table_count
    CheckerId

    integer

    チェッカー ID です。

    7
    EntityId

    integer

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

    1234
    ExpectValue

    string

    期待値です。

    1000
    TemplateId

    integer

    モニタリングテンプレートの ID です。

    7
    Id

    integer

    モニタリングルールの ID です。

    1234
    RuleName

    string

    モニタリングルールの名前です。

    test

    例

    成功レスポンス

    JSONJSON

    {
  "HttpStatusCode": 200,
  "RequestId": "38cbdef0-f6cf-49****",
  "ErrorMessage": "You have no permission.",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Data": {
    "PageNumber": 1,
    "PageSize": 20,
    "TotalCount": 400,
    "Rules": [
      {
        "BlockType": 0,
        "OnDutyAccountName": "test",
        "Property": "id",
        "WarningThreshold": "10",
        "TableName": "dual",
        "OnDuty": "1912****",
        "Comment": "Verify table rules",
        "RuleCheckerRelationId": 132323,
        "FixCheck": true,
        "MethodId": 21,
        "TemplateName": "Number of SQL task table rows, 1, 7, and 30 days wave detection",
        "Trend": "abs",
        "HistoryWarningThreshold": "history max:40%,history min:10%",
        "RuleType": 0,
        "MatchExpression": "dt=$[yyyymmdd]",
        "ProjectName": "autotest",
        "PropertyKey": "table_count",
        "CriticalThreshold": "40",
        "HistoryCriticalThreshold": "history max:80%,history min:50%",
        "MethodName": "count/table_count",
        "CheckerId": 7,
        "EntityId": 1234,
        "ExpectValue": "1000",
        "TemplateId": 7,
        "Id": 1234,
        "RuleName": "test"
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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