All Products
Search
Document Center

Microservices Engine:ListClusterTypes

Last Updated:Aug 12, 2024

Queries the engine types that can be activated.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
mse:ListClusterTypes
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region in which the instance resides. The region is supported by Microservices Engine (MSE).

cn-hangzhou
ConnectTypestringNo

The network type. Valid values:

  • slb
  • eni
slb
MseVersionstringNo

The edition of the MSE instance that you want to purchase.

  • mse_pro: Professional Edition
  • mse_dev: Developer Edition
mse_pro
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object

The data structure.

HttpStatusCodeinteger

The HTTP status code returned.

200
RequestIdstring

The ID of the request.

821B5B05-8919-5FBB-BA75-417BFC093EB8
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
True
ErrorCodestring

The error code returned if the request failed.

mse-100-000
Codeinteger

The status code returned.

200
Messagestring

The message returned.

The request was successfully processed.
DynamicMessagestring

The dynamic part in the error message. This parameter is used to replace the **%s** variable in the ErrMessage parameter.

Note If the return value of the ErrMessage parameter is The Value of Input Parameter %s is not valid and the return value of the DynamicMessage parameter is DtsJobId, the specified DtsJobId parameter is invalid.
The specified parameter is invalid.
Dataarray<object>

The data entries returned.

object

The data structure.

ShowNamestring

The type of the MSE engine that can be activated.

Zookeeper

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "RequestId": "821B5B05-8919-5FBB-BA75-417BFC093EB8",
  "Success": true,
  "ErrorCode": "mse-100-000",
  "Code": 200,
  "Message": "The request was successfully processed.\n",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": [
    {
      "ShowName": "Zookeeper"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalRequestInvalid request:%sInvalid request: %s
400InvalidParameterParameter error:%sRequest parameter error: %s
403NoPermissionYou are not authorized to perform this operation.-
403NoPermissionYou are not authorized to perform this operation:%sYou do not have the permission to use this interface:%s
404NotFoundNot found:%sThe resource does not exist:%s
500InternalErrorAn error occurred while processing your request.-
500InternalErrorConsole error. Try again later:%sConsole error. Try again later: %s

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

Change history

Change timeSummary of changesOperation
2024-02-23The response structure of the API has changedView Change Details
2024-02-23API Description Update. The Error code has changedView Change Details