Retrieves tables in the specified Engine Instance.

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:*

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number to return.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 1,000.	100
AppGuid	string	Yes	The unique identifier for the project, in the format `odps.{projectName}`. This parameter is required only if the `DataSourceType` is set to `odps`.	odps.testProjectName
ClusterId	string	No	The ID of the E-MapReduce (EMR) cluster. This parameter is required only if the `DataSourceType` is set to `emr`.	abc
DatabaseName	string	No	The name of the database.	abc
DataSourceType	string	No	The type of the data source. Valid values: `odps` and `emr`.	odps

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The unique ID for this request.	0bc1ec92159376
Data	object	Information about the tables in the engine instance.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of tables.	20
TableEntityList	array<object>	A list of table details.
	object	A table object.
TableName	string	The name of the table.	tname
TableGuid	string	The unique identifier of the table.	odps.engine_name.tname
DatabaseName	string	The name of the database.	abc

Create a database instance

This document shows how to create a database instance.

Configuration

After you log in, navigate to the "Settings" page, then select "Monitoring".

If the basic settings have been configured, you can skip to the "Advanced" section.

On the configuration page, enter the following information:
- Instance Name: Enter a descriptive name for your instance.
- Database Type: Select a database engine, such as MySQL.
- Region: Select the region for the instance.
Once you have completed the configuration, read the terms of service carefully.
Click Buy Now, then click Go to Pay.
Once the instance is created, it will appear in the instance list. Click the Manage link to open the details page. If you encounter problems, click View Documentation.

Additional information

The system will check the agent environment.

Note

Collecting more data requires more storage.

We recommend starting with a smaller dataset then expanding as needed.

Examples

Success response

JSON format

{
  "RequestId": "0bc1ec92159376",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 20,
    "TableEntityList": [
      {
        "TableName": "tname",
        "TableGuid": "odps.engine_name.tname",
        "DatabaseName": "abc"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid.Meta.AppNotExist	The MaxCompute project does not exist.	The MaxCompute project does not exist.
400	InvalidParameter.Meta.CommonError	The specified parameter is invalid.	The request parameter is invalid.
400	InvalidParameter.Meta.Illegal	The app guid parameter is invalid.	The app guid parameter is invalid.
400	InvalidParameter.Meta.IllegalPageError	The parameter for paging is invalid.	The parameter for paging is invalid.
400	InvalidParameter.Meta.NotExist	The object does not exist.
400	InternalError.UserId.Missing	An internal system error occurred. Try again later.
400	InternalError.Meta.NoCalcEngine	An error occurred while retrieving the compute engine based on the MaxCompute project.	Incorrect project entered by user
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.Meta.TenantTimeOut	Failed to connect to the interface network.	Failed to connect to the interface network.
500	InternalError.Meta.Unknown	An unknown error occurred while processing your request.	An unknown error occurred while processing your request.
403	Forbidden.Meta.NoTenant	The user is not the owner of any tenants.	The user is not the owner of any tenants.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	No permission, please authorize
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.Api.Risk	The request for this resource has exceeded your daily available limit.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.