すべてのプロダクト
Search
ドキュメントセンター

DataWorks:ListMetaCollectionEntities

最終更新日:Sep 04, 2026

コレクション内のエンティティを照会します。

今すぐお試しください

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

list

*すべてのリソース。

*

なし なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

CollectionQualifiedName

string

必須

コレクションの一意の識別子。

album.12345

EntityType

string

任意

エンティティタイプ。例: maxcompute-table は MaxCompute テーブルタイプを示します。

maxcompute-table

Keyword

string

任意

検索キーワード。

test

NextToken

string

任意

現在の読み取り操作の開始ポイントを指定するページネーショントークン。

12222

PageSize

integer

任意

ページサイズ。

10

レスポンスフィールド

フィールド

型

説明

例

object

OpenApiMetaResultModel。

Data

object

応答構造。

NextToken

string

次のトークン。

123344

EntityList

array

エンティティの配列。

Entity

エンティティ情報。

RequestId

string

リクエスト ID。この ID を使用してログを特定し、問題のトラブルシューティングができます。

E25887B7-579C-54A5-9C4F-83A0DE367DD

Success

boolean

呼び出しが成功したかどうかを示します。有効な値:

true: 呼び出しが成功しました。

false: 呼び出しが失敗しました。

true

ErrorCode

string

エラーコード。

Invalid.Collection.NotExists

ErrorMessage

string

エラーメッセージ。

指定されたパラメーターは無効です。

HttpStatusCode

integer

HTTP 状態コード。

200

例

成功レスポンス

JSONJSON

{
  "Data": {
    "NextToken": "123344",
    "EntityList": [
      {
        "QualifiedName": "maxcompute_table.563f0357118d05ef145d6bddf2966cc23e86ca8f2f013f915e565afdf09f7a23",
        "TenantId": 12345,
        "EntityContent": {
          "test": "test",
          "test2": 1
        }
      }
    ]
  },
  "RequestId": "E25887B7-579C-54A5-9C4F-83A0DE367DD",
  "Success": true,
  "ErrorCode": "Invalid.Collection.NotExists",
  "ErrorMessage": "The specified parameters are invalid.",
  "HttpStatusCode": 200
}

エラーコード

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

変更履歴

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