ListSchemas - DataWorks - Alibaba Cloud Documentation Center

Queries a list of schemas in a database or a MaxCompute project in Data Map. Only schemas of the MaxCompute and Hologres metadata crawler types are supported.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dataworks:ListSchemas	list	All Resources ``	none	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:123456XXX::test_project holo-database:h-abc123xxx::test_db
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 parameters

Parameter	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.
PageSize	integer	The number of entries per page.	10
Schemas	array	The schemas.
SchemaList	Schema	The schema.

Examples

Sample success responses

JSONformat

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

For a list of error codes, visit the Service error codes.