すべてのプロダクト
Search

このプロダクト

    DataWorks:CreateDataQualityRuleTemplate

    ドキュメントセンター

    DataWorks:CreateDataQualityRuleTemplate

    最終更新日:Aug 18, 2026

    ルールテンプレートを作成します。

    説明

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

    操作説明

    この特徴を使用するには、DataWorks Basic Edition 以上のエディションを購入する必要があります。

    今すぐお試しください

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

    テスト

    RAM 認証

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

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Name

    string

    必須

    ルールテンプレートの名前。名前には数字、文字、中国語の文字、半角または全角の句読点を含めることができます。名前の長さは最大 512 文字です。

    Table row Count Verification
    ProjectId

    integer

    必須

    DataWorks ワークスペースの ID。

    12345
    VisibleScope

    string

    任意

    テンプレートの可視性の範囲。有効な値:

    • Tenant: テナント全体で利用可能です。

    • Project: 現在のプロジェクトでのみ利用可能です。

    列挙値:

    • Project :

      現在のプロジェクトでのみ利用可能です。

    • Tenant :

      テナント全体で利用可能です。

    Project
    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 ステートメントによるサンプルコレクション。

    Count
    MetricParameters

    string

    必須

    サンプルコレクションに必須のパラメーター。

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

    string

    任意

    サンプリング文の前に実行する実行時パラメーター設定文。値の長さは最大 1000 文字です。現在、MaxCompute のみがサポートされています。

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

    object

    任意

    サンプル検証の設定項目。

    Type

    string

    必須

    しきい値の計算メソッド。有効な値:

    • Fixed

    • Fluctation

    • FluctationDiscreate

    • Auto

    • Average

    • Variance

    Fixed
    ReferencedSamplesFilter

    string

    任意

    リファレンスサンプルのクエリ方法を指定する式。一部のしきい値タイプでは、リファレンスサンプルをクエリし、その値を集約して比較用のしきい値を導出する必要があります。

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

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答パラメーター。

    RequestId

    string

    リクエストの ID。

    691CA452-D37A-4ED0-9441

    Code

    string

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

    UserDefined:3001

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "691CA452-D37A-4ED0-9441\n",
  "Code": "UserDefined:3001"
}

    エラーコード

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

    変更履歴

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