All Products
Search
Document Center

DataWorks:GetMetaDBInfo

Last Updated:Nov 21, 2024

Queries the basic metadata information about a compute engine instance.

Operation description

The ID of the EMR cluster. This parameter is required only if you set the DataSourceType parameter to emr.

You can log on to the EMR console to obtain the ID of the EMR cluster.

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.

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:
    • The required resource types are displayed in bold characters.
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
dataworks:*get
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
AppGuidstringNo

The compute engine instance ID. Specify the ID in the Engine type.Engine name format.

odps.some_engine_name
ClusterIdstringNo

The E-MapReduce (EMR) cluster ID.

abc
DatabaseNamestringNo

The name of the metadatabase of the EMR cluster.

abc
DataSourceTypestringNo

The type of the data source. Valid values: odps and emr.

emr

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

0bc1411515937****
Dataobject

The basic metadata information.

Typestring

The type of the metadatabase.

hive
Commentstring

The comment.

The ID of the compute engine instance. The ID is in the Engine type.Engine name format.
CreateTimelong

The time when the compute engine instance was created.

1541576644000
ProjectIdlong

The workspace ID.

22
ProjectNamestring

The name of the workspace.

test
AppGuidstring

The compute engine instance ID. Specify the ID in the Engine type.Engine name format.

odps.engine_name
OwnerNamestring

The name of the workspace owner.

323
OwnerIdstring

The ID of the Alibaba Cloud account used by the workspace owner.

23
EnvTypeinteger

The type of the environment. Valid values: 0 and 1. The value 0 indicates the development environment. The value 1 indicates the production environment.

1
ProjectNameCnstring

The display name of the workspace.

The storage path of the metadatabase of the EMR cluster.
Endpointstring

The endpoint of the service.

http://service.odpsstg.aliyun-inc.com/
ClusterBizIdstring

The EMR cluster ID.

abc
Namestring

The name of the database.

abc
Locationstring

The storage path of the metadatabase of the EMR cluster.

hdfs://
TenantIdlong

The tenant ID.

233
ModifyTimelong

The time when the compute engine instance was modified.

1541576644000

Examples

Sample success responses

JSONformat

{
  "RequestId": "0bc1411515937****",
  "Data": {
    "Type": "hive",
    "Comment": "The ID of the compute engine instance. The ID is in the Engine type.Engine name format.\n",
    "CreateTime": 1541576644000,
    "ProjectId": 22,
    "ProjectName": "test",
    "AppGuid": "odps.engine_name",
    "OwnerName": "323",
    "OwnerId": "23",
    "EnvType": 1,
    "ProjectNameCn": "The storage path of the metadatabase of the EMR cluster.\n",
    "Endpoint": "http://service.odpsstg.aliyun-inc.com/",
    "ClusterBizId": "abc",
    "Name": "abc",
    "Location": "hdfs://",
    "TenantId": 233,
    "ModifyTime": 1541576644000
  }
}

Error codes

HTTP status codeError codeError messageDescription
400Invalid.Meta.AppNotExistThe MaxCompute project does not exist.The MaxCompute project does not exist.
400InvalidParameter.Meta.CommonErrorThe specified parameter is invalid.The request parameter is invalid.
400InvalidParameter.Meta.IllegalThe app guid parameter is invalid.The app guid parameter is invalid.
400InvalidParameter.Meta.IllegalDateThe date format is invalid.The date format is invalid.
400InvalidParameter.Meta.IllegalPageErrorThe parameter for paging is invalid.The parameter for paging is invalid.
400InternalError.UserId.MissingAn internal system error occurred. Try again later.-
400InternalError.Meta.NoCalcEngineAn error occurred while retrieving the compute engine based on the MaxCompute project.Incorrect project entered by user
400InvalidParameter.Meta.NotExistThe data does not exist.No data is available.
403Forbidden.Meta.NoTenantThe user is not the owner of any tenants.The user is not the owner of any tenants.
403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.No permission, please authorize
429Throttling.ApiThe request for this resource has exceeded your available limit.-
429Throttling.Api.RiskThe request for this resource has exceeded your daily available limit.-
429Throttling.SystemThe DataWorks system is busy. Try again later.-
429Throttling.UserYour request is too frequent. Try again later.-
500InternalError.SystemAn internal system error occurred. Try again later.-
500InternalError.Meta.TenantTimeOutFailed to connect to the interface network.Failed to connect to the interface network.
500InternalError.Meta.UnknownAn unknown error occurred while processing your request.An unknown error occurred while processing your request.

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

Change history

Change timeSummary of changesOperation
2023-05-12The Error code has changedView Change Details