DocsICP FilingConsole
Documentation

ListMetaCollections

Updated at:
Copy as MD
Product
My Favorites

Queries the list of Data Map collections. Supports querying both Data Map categories and data albums.

Operation description

  1. You must purchase DataWorks Professional Edition or a higher edition to use this feature.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:ListMetaCollections

list

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
Type

string

Yes

The collection type. Valid values:

  • Category: category.

  • Album: data album.

  • AlbumCategory: album subcategory.

Valid values:

  • Category :

    Category.

  • Album :

    Data album.

  • AlbumCategory :

    Album subcategory.

Category
ParentId

string

No

The ID of the parent node collection object.

as78d756asd
Name

string

No

The collection name. Fuzzy match is supported.

Data Asset Subject Domain
Description

string

No

The collection description. Fuzzy match is supported.

Test collection
CreateUser

string

No

The user ID of the creator. This parameter is valid only for the album type. Default value: the current user ID.

123456
Administrator

string

No

The ID of the collection administrator. This parameter is valid only for the album type. Default value: the current user ID.

12345
SortBy

string

No

The sort field. Valid values:

  • Id (default)

  • Name: name.

  • CreateUser: creator ID.

  • CreateTime: creation time.

  • ModifyTime: modification time.

Name
Order

string

No

The sort direction. Valid values:

  • Asc (default)

  • Desc

Asc
PageNumber

integer

No

The page number. Default value: 1.

1
PageSize

integer

No

The page size. Default value: 10. Maximum value: 100.

10

Response elements

Element

Type

Description

Example

object

The response parameters.

RequestId

string

The request ID.

E25887B7-XXXX-54A5-9C4F-83A0DE367DDE
Data

object

The paged result object.

TotalCount

integer

The total number of records.

10
PageNumber

integer

The page number.

1
PageSize

integer

The page size.

10
MetaCollections

array<object>

The list of collections.

object

The collection object.

Name

string

The collection name.

test_category
Id

string

The collection name.

7a65sd7aasd
ParentId

string

The ID of the parent collection. Can be empty.

as78d756asd
Description

string

The collection description.

Test category
Type

string

The collection type. Valid values:

  • Category

  • Album

  • AlbumCategory: Album subcategory

Category
CreateUser

string

The creator user ID.

456789
CreateTime

integer

The creation time in milliseconds (timestamp).

1668568601000
ModifyTime

integer

The modification time in milliseconds (timestamp).

1668568601000
Administrators

array

The list of administrator IDs. Supported only for album types. Administrators must be users within the same tenant. Multiple administrators can be specified.

string

The administrator ID.

765432

Examples

Success response

JSON format

{
  "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"
        ]
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.