すべてのプロダクト
Search

このプロダクト

    DataWorks:GetQualityRule

    ドキュメントセンター

    DataWorks:GetQualityRule

    最終更新日:Mar 18, 2026

    品質ルールの情報を取得します。

    説明

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

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RuleId

    integer

    必須

    品質ルールの ID です。この ID は、ListQualityRules 操作を呼び出して取得できます。

    1234
    ProjectName

    string

    必須

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

    autotest
    ProjectId

    integer

    任意

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

    12345

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答のデータ構造です。

    HttpStatusCode

    integer

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

    200
    RequestId

    string

    リクエスト ID です。

    576b9457-2cf5-4****
    ErrorMessage

    string

    エラーメッセージです。

    You have no permission.
    ErrorCode

    string

    エラーコードです。

    401
    Success

    boolean

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

    true
    Data

    object

    品質ルールの詳細です。

    BlockType

    integer

    品質ルールの重大度です。有効な値は以下のとおりです。

    • 1: 強力なルール（Strong Rule）。強力なルールが重大アラートをトリガーすると、関連するスケジューリングタスクがブロックされます。

    • 0: 弱いルール（Weak Rule）。

    1
    OnDutyAccountName

    string

    このルールを設定した Alibaba Cloud アカウントの名前です。

    test
    WarningThreshold

    string

    警告アラートのしきい値です。この値は、期待値からの許容される偏差を指定し、カスタマイズ可能です。

    10
    Property

    string

    ルールが適用されるデータソースのソーステーブル内の列です。

    id
    RuleType

    integer

    品質ルールのタイプです。有効な値は以下のとおりです。

    • 0: システムテンプレートに基づくルール。

    • 1: カスタム SQL ステートメントに基づくルール。

    • 4: カスタムテンプレートに基づくルール。

    0
    Comment

    string

    ルールのコメントです。

    Verify that the primary key is unique
    OnDuty

    string

    このルールを設定した Alibaba Cloud アカウントの ID です。

    1822931****
    Checker

    integer

    チェックャー ID です。これはプライマリキーから派生し、フロントエンドでの識別に使用されます。

    9
    FixCheck

    boolean

    固定値に対する検証を行うかどうかを示します。

    true
    MethodId

    integer

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

    8
    CriticalThreshold

    string

    重大アラートのしきい値です。これは、期待値からの最大許容偏差を定義します。このしきい値が強力なルールで満たされた場合、関連するスケジューリングタスクはブロックされます。

    20
    PredictType

    integer

    しきい値が動的かどうかを示します。有効な値は以下のとおりです。

    • 0: 静的なしきい値。

    • 1: 動的なしきい値。

    0
    TemplateName

    string

    使用されるテンプレートの名前です。

    SQL task table rows, 1,7, 30 days fluctuation test
    CheckerName

    string

    チェックャーの名前です。

    compared with a fixed value
    RuleName

    string

    ルールの名前です。

    View table fluctuations
    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 があります。

    table_count
    EntityId

    integer

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

    165523
    WhereCondition

    string

    検証に使用されるフィルター条件またはカスタム SQL ステートメントです。

    id>10
    Operator

    string

    比較演算子です。

    >=
    ExpectValue

    string

    期待値です。

    30
    Trend

    string

    検証結果の傾向です。

    abs
    TemplateId

    integer

    使用されるテンプレートの ID です。

    7
    Id

    integer

    ルールの ID です。

    123232
    OpenSwitch

    boolean

    ルールが有効かどうかを示します。

    true
    TaskSetting

    string

    カスタムルールの前に挿入される変数設定です。形式は x=a,y=b です。

    x=a,y=b

    例

    成功レスポンス

    JSONJSON

    {
  "HttpStatusCode": 200,
  "RequestId": "576b9457-2cf5-4****",
  "ErrorMessage": "You have no permission.",
  "ErrorCode": "401",
  "Success": true,
  "Data": {
    "BlockType": 1,
    "OnDutyAccountName": "test",
    "WarningThreshold": "10",
    "Property": "id",
    "RuleType": 0,
    "Comment": "Verify that the primary key is unique",
    "OnDuty": "1822931****",
    "Checker": 9,
    "FixCheck": true,
    "MethodId": 8,
    "CriticalThreshold": "20",
    "PredictType": 0,
    "TemplateName": "SQL task table rows, 1,7, 30 days fluctuation test",
    "CheckerName": "compared with a fixed value",
    "RuleName": "View table fluctuations",
    "MethodName": "table_count",
    "EntityId": 165523,
    "WhereCondition": "id>10",
    "Operator": ">=",
    "ExpectValue": "30",
    "Trend": "abs",
    "TemplateId": 7,
    "Id": 123232,
    "OpenSwitch": true,
    "TaskSetting": "x=a,y=b\n"
  }
}

    エラーコード

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

    変更履歴

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