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
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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
dataworks:* | get | *All Resources * |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
AppGuid | string | No | The compute engine instance ID. Specify the ID in the | odps.some_engine_name |
ClusterId | string | No | The E-MapReduce (EMR) cluster ID. | abc |
DatabaseName | string | No | The name of the metadatabase of the EMR cluster. | abc |
DataSourceType | string | No | The type of the data source. Valid values: odps and emr. | emr |
Response parameters
Examples
Sample success responses
JSON
format
{
"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 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.IllegalDate | The date format is invalid. | The date format is invalid. |
400 | InvalidParameter.Meta.IllegalPageError | The parameter for paging is invalid. | The parameter for paging is invalid. |
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 |
400 | InvalidParameter.Meta.NotExist | The data does not exist. | No data is available. |
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. | - |
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. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2023-05-12 | The Error code has changed | View Change Details |