すべてのプロダクト
Search

このプロダクト

    DataWorks:UpdateDataQualityRuleTemplate

    ドキュメントセンター

    DataWorks:UpdateDataQualityRuleTemplate

    最終更新日:Sep 03, 2026

    データ品質ルールテンプレートを更新します。

    説明

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

    操作説明

    この操作は、DataWorks Basic Edition 以上のエディションを購入した後にのみ呼び出すことができます。

    今すぐお試しください

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

    テスト

    RAM 認証

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

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Code

    string

    必須

    ルールテンプレートのコード。

    USER_DEFINED:123
    Name

    string

    任意

    ルールテンプレートの名前。名前には、数字、英字、漢字、および半角・全角の句読点を含めることができます。名前は最大 512 文字です。

    Table row Count Verification

    ProjectId

    integer

    必須

    DataWorksワークスペースのID。DataWorksコンソールにログオンし、ワークスペース管理ページに移動してIDを取得できます。

    このパラメータは、このAPI 呼び出しに使用されるDataWorksワークスペースを指定します。

    10000
    DirectoryPath

    string

    任意

    カスタムテンプレートが格納されているカテゴリディレクトリ。レベルはスラッシュ (/) で区切られます。各レベルの名前は最大 1024 文字までで、空白文字またはスラッシュ (/) を含めることはできません。

    /ods/order_data
    SamplingConfig

    object

    任意

    サンプル収集に必要な設定。

    Metric

    string

    任意

    サンプリング対象のメトリックの名前。有効な値:

    • Count: テーブルの行数。

    • Min: フィールドの最小値。

    • Max: フィールドの最大値。

    • Avg: フィールドの平均値。

    • DistinctCount: フィールドの一意の値の数。

    • DistinctPercent: フィールドの一意の値の数とデータ行数の比率。

    • DuplicatedCount: フィールドの重複値の数。

    • DuplicatedPercent: フィールドの重複値の数とデータ行数の比率。

    • TableSize: テーブルのサイズ。

    • NullValueCount: フィールドがnullの行の数。

    • NullValuePercent: フィールドがnullの行の割合。

    • GroupCount: フィールド値が集計された後の各値に対応するデータ行の数。

    • CountNotIn: 値が列挙値と一致しない行の数。

    • CountDistinctNotIn: 列挙値と一致しない一意の値の数。

    • UserDefinedSql: カスタムSQLを使用したサンプル収集。

    Max
    MetricParameters

    string

    任意

    サンプル収集に必要なパラメータ。

    {"SQL": "select count(1) from table;"}

    SettingConfig

    string

    任意

    サンプリングステートメントが実行される前に挿入および実行されるランタイムパラメータ設定ステートメント。ステートメントは最大 1,000 文字までです。MaxComputeのみがサポートされています。

    SET odps.sql.udf.timeout=600s; SET odps.sql.python.version=cp27;

    CheckingConfig

    object

    任意

    サンプル検証の設定。

    Type

    string

    任意

    監視対象オブジェクトのタイプ。有効な値:

    • Table

    Table
    ReferencedSamplesFilter

    string

    任意

    一部のタイプのしきい値については、参照サンプルをクエリし、参照サンプルの値を集計して、比較に使用するしきい値を取得する必要があります。ここでは、参照サンプルのクエリ方法を示すために式が使用されます。

    { "bizdate": [ "-1", "-7", "-1m" ] }

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返されるデータ。

    RequestId

    string

    リクエストのID

    691CA452-D37A-4ED0-****

    Success

    boolean

    更新が成功したかどうかを示します。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "691CA452-D37A-4ED0-****\n",
  "Success": true
}

    エラーコード

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

    変更履歴

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