Data Quality ルールテンプレートのリストを照会します。
この API は廃止されました。一時的にアクセス可能ですが、更新やバグ修正対応は一切行われません。代わりに dataworks-public(2024-05-18) - ListDataQualityTemplates への移行を推奨します。より強化された機能に加え、サポートも引き続きご利用いただけます。
操作説明
この特徴を使用するには、DataWorks Basic Edition 以上のエディションを購入する必要があります。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ProjectId |
integer |
必須 |
DataWorks ワークスペースの ID。 |
10000 |
| CreationSource |
string |
必須 |
ルールテンプレートの作成ソース。このパラメーターは必須です。有効な値:
|
System |
| DirectoryPath |
string |
任意 |
カスタムテンプレートが格納されているカテゴリディレクトリ。レベルは転送スラッシュ (/) で区切ります。各レベル名の長さは最大 1024 文字で、空白文字やバックスラッシュを含めることはできません。 |
/ods/order_data |
| Name |
string |
任意 |
テンプレートルール名のあいまい一致。テンプレートがシステムテンプレートの場合、言語に基づいてシステムテンプレートの国際化された名前があいまい一致されます。 |
Table rows |
| PageNumber |
integer |
必須 |
ページングクエリのページサイズ。デフォルト値: 10。 |
10 |
| PageSize |
integer |
必須 |
ページングクエリのページ番号。デフォルト値: 1。 |
1 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答パラメーター。 |
||
| RequestId |
string |
リクエストの ID。 |
691CA452-D37A-**** |
| PagingInfo |
object |
Data Quality ルールテンプレートのページングクエリのページング結果。 |
|
| TotalCount |
integer |
エントリの総数。 |
42 |
| PageSize |
integer |
ページサイズ。 |
10 |
| PageNumber |
integer |
ページ番号。 |
1 |
| DataQualityRuleTemplates |
array<object> |
ルールテンプレートのリスト。 |
|
|
array<object> |
ルールテンプレートの詳細。 |
||
| Code |
string |
ルールテンプレートのコード。 |
USER_DEFINED:123 |
| Name |
string |
ルールテンプレートの名前。数字、英字、漢字、半角または全角の句読点の組み合わせで、最大 512 文字まで指定できます。 |
Table row Count Verification |
| ProjectId |
integer |
DataWorks ワークスペース ID。 |
2043 |
| SamplingConfig |
object |
サンプル収集に必要な設定。 |
|
| Metric |
string |
サンプリングメトリックの名前。
|
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 |
しきい値の計算方法。
|
Fixed |
| ReferencedSamplesFilter |
string |
一部の種類のしきい値では、参照サンプルをクエリする必要があり、その後参照サンプルの値が集計されて比較用のしきい値が取得されます。ここでは参照サンプルのクエリ方法を示すために式が使用されます。 |
{ "bizdate": [ "-1", "-7", "-1m" ] } |
| VisibleScope |
string |
テンプレートの利用可能範囲:
|
Project |
| DirectoryPath |
string |
カスタムテンプレートが格納されているカテゴリディレクトリ。階層はスラッシュ (/) で区切られます。各階層の名前は最大 1,024 文字で、空白文字やスラッシュを含むことはできません。 |
/ods/order_data |
例
成功レスポンス
JSONJSON
{
"RequestId": "691CA452-D37A-****",
"PagingInfo": {
"TotalCount": 42,
"PageSize": 10,
"PageNumber": 1,
"DataQualityRuleTemplates": [
{
"Code": "USER_DEFINED:123",
"Name": "Table row Count Verification\n",
"ProjectId": 2043,
"SamplingConfig": {
"Metric": "Max",
"MetricParameters": "{\"Sql\": \"select count(1) from table;\"}\n",
"SettingConfig": "SET odps.sql.udf.timeout=600s; \nSET odps.sql.python.version=cp27;\n"
},
"CheckingConfig": {
"Type": "Fixed",
"ReferencedSamplesFilter": "{ \"bizdate\": [ \"-1\", \"-7\", \"-1m\" ] }\n"
},
"VisibleScope": "Project",
"DirectoryPath": "/ods/order_data"
}
]
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。