ListMetaCollections によるコレクションクエリ - DataWorks - Alibaba Cloud - DataWorks

操作説明

コレクションには、ALBUM (アルバムコレクション) および ALBUM_CATEGORY (アルバム内のサブカテゴリ) が含まれます。

今すぐお試しください

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

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ParentQualifiedName	string	任意	親コレクションの一意な識別子。	Album.1234
NextToken	string	任意	現在の読み取り操作の開始ポイントを指定するページネーショントークン。	12345
PageSize	integer	任意	1 ページあたりのエントリ数。デフォルト値: 10。最大値: 100。	10
Keyword	string	任意	キーワード。	キーワード
OrderBy	string	任意	ソートに使用されるフィールド名。	ソートフィールド
CollectionType	string	必須	照会するコレクションのタイプ。有効な値: ALBUM: アルバムコレクション。 ALBUM_CATEGORY: アルバム内のサブカテゴリ。	ALBUM
Creator	string	任意	作成者のユーザー ID。	1200759642363000
Administrator	string	任意	コレクション管理者の ID。	1200759642363000
Follower	string	任意	コレクションフォロワーの ID。	1200759642363000

次のパラメーターのうち、最大 1 つを設定できます: Creator、Administrator、Follower。

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンス構造体。
RequestId	string	リクエスト ID。ログの特定および問題のトラブルシューティングに使用されます。	E25887B7-579C-54A5-9C4F-83A0DE367DDE
Data	object	返されるオブジェクト。
NextToken	string	次のトークン。	37ae2053d87d380f28ce0dc0853ca51e
CollectionList	array	配列オブジェクト。
	Collection	返されるコレクションオブジェクト。
Success	boolean	呼び出しが成功したかどうかを示します。有効な値: true: 呼び出しが成功した。 false: 呼び出しが失敗した。	true
ErrorCode	string	エラーコード。	Invalid.Collection.NotExists
ErrorMessage	string	エラーメッセージ。	指定されたパラメーターは無効です。
HttpStatusCode	integer	HTTP 状態コード。	200

例

成功レスポンス

JSONJSON

{
  "RequestId": "E25887B7-579C-54A5-9C4F-83A0DE367DDE",
  "Data": {
    "NextToken": "37ae2053d87d380f28ce0dc0853ca51e",
    "CollectionList": [
      {
        "QualifiedName": "album.12334",
        "CollectionType": "album",
        "Name": "collectionName",
        "Comment": "comment",
        "OwnerId": "1234444",
        "OwnerName": "owner",
        "CreateTime": 1668600147617,
        "UpdateTime": 1668600148617,
        "Level": 1
      }
    ]
  },
  "Success": true,
  "ErrorCode": "Invalid.Collection.NotExists",
  "ErrorMessage": "The specified parameters are invalid.",
  "HttpStatusCode": 200
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	Invalid.Collection.ParamError	msg: %s
400	Invalid.User.NotExist	msg: %s
400	Invalid.Collection.QualifiedNameError	msg: %s
400	Invalid.Collection.CollectionNotCompatible	msg: %s
400	Invalid.Collection.EntityOverflow	msg: %s
400	Invalid.Collection.NotExist	msg: %s
400	Invalid.Collection.AlreadyExist	msg: %s
400	Invalid.Collection.UnsupportedOperation	msg: %s
400	InvalidParameter.Meta.Missing	msg: %s
400	Forbidden.No.Permission	msg: %s
400	InvalidParameter.Meta.IllegalData	msg: %s

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

変更履歴

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