ListMetaCollections による Data Map コレクションの概要 - DataWorks - Alibaba Cloud - DataWorks

データマップコレクションのリストをクエリします。データマップカテゴリとデータアルバムの両方のクエリをサポートします。

操作説明

この特徴を使用するには、DataWorks Professional Edition 以上のエディションを購入する必要があります。

今すぐお試しください

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

list

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Type	string	必須	コレクションタイプ。有効な値: Category: カテゴリ。 Album: データアルバム。 AlbumCategory: アルバムサブカテゴリ。列挙値: Category : カテゴリ。 Album : データアルバム。 AlbumCategory : アルバムサブカテゴリ。	Category
ParentId	string	任意	親ノードコレクションオブジェクトの ID。	as78d756asd
Name	string	任意	コレクション名。あいまい一致がサポートされています。	Data Asset Subject Domain
Description	string	任意	コレクションの説明。あいまい一致がサポートされています。	テストコレクション
CreateUser	string	任意	作成者のユーザー ID。このパラメーターはアルバムタイプに対してのみ有効です。デフォルト値: 現在のユーザー ID。	123456
Administrator	string	任意	コレクション管理者の ID。このパラメーターはアルバムタイプに対してのみ有効です。デフォルト値: 現在のユーザー ID。	12345
SortBy	string	任意	ソートフィールド。有効な値: Id (デフォルト) Name: 名前。 CreateUser: 作成者 ID。 CreateTime: 作成時間。 ModifyTime: 変更時間。	Name
Order	string	任意	ソート方向。有効な値: Asc (デフォルト) Desc	Asc
PageNumber	integer	任意	ページ番号。デフォルト値: 1。	1
PageSize	integer	任意	ページサイズ。デフォルト値: 10。最大値: 100。	10

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
RequestId	string	リクエスト ID。	E25887B7-XXXX-54A5-9C4F-83A0DE367DDE
Data	object	ページネーション結果オブジェクト。
TotalCount	integer	レコードの総数。	10
PageNumber	integer	ページ番号。	1
PageSize	integer	ページサイズ。	10
MetaCollections	array<object>	コレクションのリスト。
	object	コレクションオブジェクト。
Name	string	コレクション名です。	test_category
Id	string	コレクション名。	7a65sd7aasd
ParentId	string	親コレクションの ID です。空欄可。	as78d756asd
Description	string	コレクションの説明です。	Test category
Type	string	コレクションの種別です。有効な値は以下のとおりです。 Category Album AlbumCategory：アルバムのサブカテゴリ	Category
CreateUser	string	作成者ユーザー ID です。	456789
CreateTime	integer	作成時刻（ミリ秒単位のタイムスタンプ）です。	1668568601000
ModifyTime	integer	更新時刻（ミリ秒単位のタイムスタンプ）です。	1668568601000
Administrators	array	管理者 ID のリストです。アルバムタイプでのみサポートされます。管理者は同一テナント内のユーザーである必要があります。複数の管理者を指定できます。
	string	管理者 ID です。	765432

例

成功レスポンス

JSONJSON

{
  "RequestId": "E25887B7-XXXX-54A5-9C4F-83A0DE367DDE",
  "Data": {
    "TotalCount": 10,
    "PageNumber": 1,
    "PageSize": 10,
    "MetaCollections": [
      {
        "Name": "test_category",
        "Id": "7a65sd7aasd",
        "ParentId": "as78d756asd",
        "Description": "Test category",
        "Type": "Category",
        "CreateUser": "456789",
        "CreateTime": 1668568601000,
        "ModifyTime": 1668568601000,
        "Administrators": [
          "765432"
        ]
      }
    ]
  }
}

エラーコード

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

変更履歴

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