ListSchemas-阿里云帮助中心

Queries the list of schemas under a specified database or MaxCompute project in Data Map. Currently supports MaxCompute and Holo types.

Operation description

You must purchase DataWorks Basic Edition or higher 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:ListSchemas

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ParentMetaEntityId	string	Yes	The parent entity ID. For more information, see Concepts related to metadata entities. For the Hologres metadata crawler type, you can call the ListDatabases operation to query the settings of the `ParentMetaEntityId` parameter. Configure the `ParentMetaEntityId` parameter in the `${EntityType}:${Instance ID or escaped URL}:${Catalog identifier}:${Database name}` format. If a level does not exist, leave the level empty. Note If you want to query the information about a MaxCompute schema, specify an empty string at the Instance ID level as a placeholder and a MaxCompute project name at the Database name level. Make sure that the schema feature is enabled for the MaxCompute project.	maxcompute-project:::project_name
Name	string	No	The name. Fuzzy match is supported.	abc
Comment	string	No	The comment. Fuzzy match is supported.	test comment
Types	array	No	The types. Exact match is supported. If this parameter is left empty, all types are queried.
	string	No	The schema type.	MANAGED
SortBy	string	No	The field used for sorting. Default value: CreateTime. Valid values: CreateTime ModifyTime Name Type	CreateTime
Order	string	No	The order in which schemas are sorted. Default value: Asc. Valid values: Asc: ascending order Desc: descending order	Asc
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	235BBA5E-3428-XXXXXX
Success	boolean	Indicates whether the request was successful.	true
PagingInfo	object	The pagination information.
TotalCount	integer	Total number of entries.	1
PageNumber	integer	Page number.	1
PageSize	integer	The number of entries per page.	10
Schemas	array	The schemas.
	Schema	The schema.

Examples

Success response

JSON format

{
  "RequestId": "235BBA5E-3428-XXXXXX",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 10,
    "Schemas": [
      {
        "Id": "maxcompute-schema:123456XXX::test_project:default\nholo-schema:h-abc123xxx::test_db:test_schema",
        "Name": "test_db",
        "Comment": "test comment",
        "Type": "MANAGED",
        "ParentMetaEntityId": "maxcompute-project:123456XXX::test_project\nholo-database:h-abc123xxx::test_db",
        "CreateTime": 1736852168000,
        "ModifyTime": 1736852168000
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.