すべてのプロダクト
Search

このプロダクト

    DataWorks:ListDataQualityTemplates

    ドキュメントセンター

    DataWorks:ListDataQualityTemplates

    最終更新日:Mar 21, 2026

    プロジェクト内のデータ品質ルールテンプレートの一覧を照会します。

    操作説明

    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:ListDataQualityTemplates

    list

    *All Resource

    *

    		 なし なし

    リクエスト構文

    POST  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Catalog

    string

    任意

    データ品質テンプレートが属するディレクトリパス。

    /timeliness/ods_layer
    ProjectId

    integer

    任意

    プロジェクト ID。

    10000
    Name

    string

    任意

    テンプレートルール名の曖昧一致検索。

    table_rows
    PageNumber

    integer

    任意

    1 ページあたりのレコード数。デフォルト値：10。

    1
    PageSize

    integer

    任意

    ページ番号。デフォルト値：1。

    10

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答スキーマ

    RequestId

    string

    API リクエスト ID（UUID で生成）。

    0bc14115***159376359
    PageInfo

    object

    データ品質ルールテンプレートのページ単位の照会結果。

    TotalCount

    integer

    総レコード数。

    10
    PageSize

    integer

    ページ数。

    20
    PageNumber

    integer

    ページ番号。

    1
    DataQualityTemplates

    array<object>

    ルールテンプレートのリスト。

    object

    ルールテンプレート。

    ModifyTime

    integer

    データ品質ルールテンプレートの更新時刻。

    1729816478147
    Owner

    string

    データ品質ルールテンプレートのオーナー。

    205250754596036836
    ModifyUser

    string

    データ品質ルールテンプレートの最終更新者。

    205250754596036836
    CreateTime

    integer

    データ品質ルールテンプレートの作成時刻。

    1729816478147
    ProjectId

    integer

    プロジェクト ID。

    7635
    CreateUser

    string

    データ品質ルールテンプレートの作成者。

    7892346529452
    Id

    string

    データ品質ルールテンプレートの ID。

    819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a
    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" }

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "0bc14115***159376359",
  "PageInfo": {
    "TotalCount": 10,
    "PageSize": 20,
    "PageNumber": 1,
    "DataQualityTemplates": [
      {
        "ModifyTime": 1729816478147,
        "Owner": "205250754596036836",
        "ModifyUser": "205250754596036836",
        "CreateTime": 1729816478147,
        "ProjectId": 7635,
        "CreateUser": "7892346529452",
        "Id": "819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a",
        "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}"
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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