GetDataQualityTemplate - DataWorks - Alibaba Cloud ドキュメントセンター

操作説明

この機能を使用するには、DataWorks ベーシック版以降を購入する必要があります。

今すぐお試しください

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

get

*All Resource

*

なし

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Id	string	任意	データ品質ルールテンプレートの ID。	a7ef0634-20ec-4a7c-a214-54020f91XXXX

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	API リクエスト ID。UUID として生成されます。	0bc14115***159376359
DataQualityTemplate	object	データ品質ルールテンプレート。
Id	string	データ品質ルールテンプレートの ID。	10001
ProjectId	integer	プロジェクト ID。	97535
CreateTime	integer	データ品質ルールテンプレートが作成された時間。	1606724043000
ModifyTime	integer	データ品質ルールテンプレートが更新された時間。	1606724043000
CreateUser	string	データ品質ルールテンプレートの作成者。	238428342865
ModifyUser	string	データ品質ルールテンプレートの最終更新者。	238428342865
Spec	string	データ品質ルールテンプレートの特定の設定。詳細については、「データ品質 Spec 設定の説明」をご参照ください。	{ "assertion": "anomaly detection fro id_not_null_cnt", "id_not_null_cnt": { "query": "SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = '$[yyyymmdd-1]';" }, "identity": "819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a" }
Owner	string	データ品質ルールテンプレートの所有者。	238428342865

例

成功レスポンス

JSONJSON

{
  "RequestId": "0bc14115***159376359",
  "DataQualityTemplate": {
    "Id": "10001",
    "ProjectId": 97535,
    "CreateTime": 1606724043000,
    "ModifyTime": 1606724043000,
    "CreateUser": "238428342865",
    "ModifyUser": "238428342865",
    "Spec": "{\n    \"assertion\": \"anomaly detection fro id_not_null_cnt\",\n    \"id_not_null_cnt\": {\n        \"query\": \"SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = '$[yyyymmdd-1]';\"\n    },\n    \"identity\": \"819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a\"\n}",
    "Owner": "238428342865"
  }
}

エラーコード

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

変更履歴

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