ListEcsNotInCluster - Enterprise Distributed Application Service

Queries all Elastic Compute Service (ECS) instances that have not been imported to clusters.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

edas:ListEcsNotInCluster

get

*All Resource

*

None

Request syntax

GET /pop/v5/resource/ecs_not_in_cluster HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
NetworkMode	integer	Yes	The network type. Valid values: 1: classic network 2: virtual private cloud (VPC)	2
VpcId	string	No	The ID of the VPC. This parameter is required if the NetworkMode parameter is set to 2.	vpc-2zef6ob8****v8x3q46kp

Response elements

Element	Type	Description	Example
	object
Code	integer	The HTTP status code that is returned.	200
Message	string	The message that is returned.	success
RequestId	string	The ID of the request.	b197-40ab-9155-****
EcsEntityList	object
EcsEntity	array<object>	The information about ECS instances.
	object
VpcId	string	The ID of the VPC.	vpc-2zef6ob8mrlzv8x3q****
Status	string	The status of the ECS instance. Valid values: Pending: The ECS instance is being created. Running: The ECS instance is running. Starting: The ECS instance is being started. Stopping: The ECS instance is being stopped. Stopped: The ECS instance is stopped.	Running
PrivateIp	string	The private IP address of the ECS instance.	192.168..*
Expired	boolean	Indicates whether the ECS instance has expired. Valid values: true: The ECS instance has expired. false: The ECS instance has not expired.	false
InstanceId	string	The ID of the ECS instance.	i-2ze7s2v0b***********
Mem	integer	The size of memory. Unit: bytes.	4096
RegionId	string	The ID of the region where the ECS instance is located.	cn-beijing
VpcName	string	The name of the VPC.	test
Cpu	integer	The number of CPU cores.	2
InnerIp	string	The private IP address of the ECS instance.	192.168.20.113
Eip	string	The elastic IP address (EIP) associated with the ECS instance.	139.30.xxx.xx
InstanceName	string	The name of the ECS instance.	worker-k8s-for-cs-c9dfa009a5e7c4faab2010b87cae4****
PublicIp	string	The public IP address of the ECS instance.	131.30.xxx.xx

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "success",
  "RequestId": "b197-40ab-9155-****",
  "EcsEntityList": {
    "EcsEntity": [
      {
        "VpcId": "vpc-2zef6ob8mrlzv8x3q****",
        "Status": " Running",
        "PrivateIp": "192.168.*.**",
        "Expired": false,
        "InstanceId": "i-2ze7s2v0b***********",
        "Mem": 4096,
        "RegionId": "cn-beijing",
        "VpcName": "test",
        "Cpu": 2,
        "InnerIp": "192.168.20.113",
        "Eip": "139.30.xxx.xx",
        "InstanceName": "worker-k8s-for-cs-c9dfa009a5e7c4faab2010b87cae4****",
        "PublicIp": "131.30.xxx.xx"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.