All Products
Search
Document Center

DataWorks:DsgPlatformQueryProjectsAndSchemaFromMeta

Last Updated:Nov 21, 2024

Queries a list of compute engines of different types in the current tenant.

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:DsgPlatformQueryProjectsAndSchemaFromMetalist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
EngineNamestringYes

The type of the compute engine. Valid values:

  • ODPS.ODPS
  • EMR
  • HOLO.POSTGRES
EMR

Response parameters

ParameterTypeDescriptionExample
object

OpenApiResultModel<List>

Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
ErrorCodestring

The error code.

1029030003
ErrorMessagestring

The error message.

param error
HttpStatusCodeinteger

The HTTP status code.

400
Dataarray<object>

The data returned.

Datasobject
Projectstring

The name of the compute engine.

emr_test_project
ClusterIdstring

The ID of the EMR cluster. This parameter is generated only when the request parameter EngineName is set to EMR.

c-12345
RequestIdstring

The request ID. You can use the ID to locate logs and troubleshoot issues.

102400001

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "ErrorCode": "1029030003",
  "ErrorMessage": "param error",
  "HttpStatusCode": 400,
  "Data": [
    {
      "Project": "emr_test_project",
      "ClusterId": "c-12345"
    }
  ],
  "RequestId": "102400001"
}

Error codes

HTTP status codeError codeError messageDescription
400PARAMS.ERRORparam error.-
400ENGINE.NOT.ALLOWengine not allow.Engine type not allowed
403PERMISSION.DENIED.ERRORPermission deniedInsufficient permissions.
500UNKNOWN.ERRORunknown error.Unknown error.

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