GetSchema - DataWorks - Alibaba Cloud Documentation Center

Queries the information about a schema in Data Map. You can call this API operation to query the information only about MaxCompute and Hologres schemas.

Operation description

This API operation is available for all DataWorks editions.
You can call this API operation to query the information only about MaxCompute and Hologres schemas.

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

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Id	string	Yes	The ID. You can refer to the ListSchemas operation and Concepts related to metadata entities. The format is `${EntityType}:${Instance ID or escaped URL}:${Catalog ID}:${Database name}:${Schema name}</code>`. Use empty strings as placeholders for missing levels. Note For the MaxCompute type, use an empty string as the placeholder for the instance ID level. The database name is the MaxCompute project name, and the project must have the three-level model enabled. Examples: `maxcompute-schema:::project_name:schema_name` (The three-level model is enabled for the MaxCompute project.) `holo-schema:instance_id::database_name:schema_name` Note `instance_id`: The Hologres instance ID . `database_name`: The database name . `database_name`: The MaxCompute project name . `schema_name`: The schema name.	maxcompute-schema:123456XXX::test_project:default holo-schema:h-abc123xxx::test_db:test_schema

Response parameters

Parameter	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	A89B5D9D-74EA-XXXXXX
Success	boolean	Indicates whether the request was successful.	true
Schema	Schema	The schema information.

Examples

Sample success responses

JSONformat

{
  "RequestId": "A89B5D9D-74EA-XXXXXX",
  "Success": true,
  "Schema": {
    "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.