All Products
Search
Document Center

Enterprise Distributed Application Service:ListConvertableEcu

Last Updated:Mar 01, 2024

Queries the Elastic Compute Service (ECS) instances that can be imported to a specified cluster. This operation is applicable to ECS clusters.

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
edas:ReadClusterRead
  • Cluster
    acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/cluster/{#ClusterId}
    none
none

Request syntax

GET /pop/v5/resource/convertable_ecu_list

Request parameters

ParameterTypeRequiredDescriptionExample
clusterIdstringYes

The ID of the cluster. You can call the ListCluster operation to query the cluster ID. For more information, see ListCluster .

b3e3f77b-462e-****-****-bec8727a****

Response parameters

ParameterTypeDescriptionExample
object

The content that is returned.

Codeinteger

The HTTP status code that is returned.

200
Messagestring

The additional information that is returned.

success
RequestIdstring

The ID of the request.

b197-40ab-9155-7ca7
InstanceListobject []

The ECS instances that can be imported to the cluster.

VpcIdstring

The ID of the virtual private cloud (VPC).

vpc-2zef6ob8m************
Statusstring

The state of the instance. Valid values:

  • Pending: The instance is being created.
  • Running: The instance is running.
  • Starting: The instance is being started.
  • Stopping: The instance is being stopped.
  • Stopped: The instance is stopped.
Running
PrivateIpstring

The private IP address of the ECS instance. This parameter is valid only when the ECS instance is deployed in a VPC.

192.XX.XX.123
Expiredboolean

Indicates whether the ECS instance has expired.

false
InstanceIdstring

The ID of the ECS instance.

i-2ze7s2v0b***********
Meminteger

The size of memory for the ECS instance.

4096
RegionIdstring

The ID of the region where the ECS instance is located.

cn-beijing
VpcNamestring

The name of the VPC.

jianwei-test
EcuIdstring

The ID of the elastic compute units (ECU).

b197-40ab-9155-7ca7
Cpuinteger

The number of CPU cores of the ECS instance.

2
InnerIpstring

The private IP address of the ECS instance. This parameter is valid only when the ECS instance is deployed in a VPC.

192.168.13.xx
Eipstring

The elastic IP address (EIP) associated with the ECS instance. The EIP can be changed.

13.xx.xxx.xx
InstanceNamestring

The name of the ECS instance.

worker-k8s
PublicIpstring

The public IP address of the ECS instance. This IP address can be used only by the ECS instance.

13.xx.xx.xxx

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "success",
  "RequestId": "b197-40ab-9155-7ca7",
  "InstanceList": {
    "Instance": [
      {
        "VpcId": "vpc-2zef6ob8m************",
        "Status": " Running",
        "PrivateIp": "192.XX.XX.123",
        "Expired": false,
        "InstanceId": "i-2ze7s2v0b***********",
        "Mem": 4096,
        "RegionId": "cn-beijing",
        "VpcName": "jianwei-test",
        "EcuId": "b197-40ab-9155-7ca7",
        "Cpu": 2,
        "InnerIp": "192.168.13.xx",
        "Eip": "13.xx.xxx.xx",
        "InstanceName": "worker-k8s",
        "PublicIp": "13.xx.xx.xxx"
      }
    ]
  }
}

Error codes

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