ListEcuByRegion - Enterprise Distributed Application Service

Queries the available elastic compute units (ECUs) in a specified namespace.

Operation description

Terms

Namespace: the logical concept that is used to isolate resources such as clusters, ECS instances, and applications, and microservices published in EDAS. This concept involves the default namespace and custom namespaces. Each region has a default namespace and supports multiple custom namespaces. By default, only the default namespace is available. You do not need to create a custom namespace if you do not want to isolate resources and microservices.
Elastic compute unit (ECU): After an ECS instance is imported to a cluster, the instance becomes an ECU.
Elastic compute container (ECC): After you deploy an application to an ECU in a cluster, the ECU becomes an ECC.

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:ListEcuByRegion

list

*All Resource

*

None

Request syntax

GET /pop/v5/resource/ecu_list HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
LogicalRegionId	string	No	The ID of the namespace. The ID of a custom namespace is in the `region ID:namespace identifier` format. Example: cn-beijing:tdy218. The ID of the default namespace is in the `region ID` format. Example: cn-beijing.	cn-beijing 或 cn-beijing:tdy218
Act	string	Yes	Set the value to `pop-query`.	pop-query

Response elements

Element	Type	Description	Example
	object	The content that is returned.
Code	integer	The HTTP status code that is returned.	200
Message	string	The additional information that is returned.	success
RequestId	string	The ID of the request.	00000000-0000-0000-****
EcuEntityList	object
EcuEntity	array<object>	The information about ECUs.
	object	The details about ECUs.
VpcId	string	The ID of the virtual private cloud (VPC) in which the ECU resides.	vpc-2zew8mi6gqbo5wf****
UpdateTime	integer	The timestamp when the ECU was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1572867895575
IpAddr	string	The private IP address of the ECU.	192.168.xxx.xxx
AvailableCpu	integer	The number of available CPU cores for the ECU.	4
CreateTime	integer	The timestamp when the ECU was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.	1572539283168
UserId	string	The ID of the Alibaba Cloud account.	edas@aliyun-****.com
InstanceId	string	The ID of the ECU.	i-2ze82h8f4zcn449y****
Mem	integer	The total size of memory. Unit: MB.	0
RegionId	string	The ID of the region in which the ECU resides.	cn-beijing
EcuId	string	The unique ID of the ECU. To query the ID, you can run the `dmidecode` command on the ECS instance that corresponds to the ECU.	c96c494c-1b91-4456-bbb3-b5afcd16****
Cpu	integer	The total number of CPU cores.	0
DockerEnv	boolean	Indicates whether Docker is installed. Valid values: true: Docker is installed. false: Docker is not installed.	true
Online	boolean	Indicates whether the ECU is online. Valid values: true: The ECU is online. false: The ECU is offline.	false
AvailableMem	integer	The size of available memory for the ECU. Unit: MB.	8192
ZoneId	string	The ID of the zone in which the ECU resides.	cn-beijing-a
Name	string	The name of the ECU.	worker-k8s-for
HeartbeatTime	integer	The timestamp when the last heartbeat detection was performed. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1572867865221

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "success",
  "RequestId": "00000000-0000-0000-****",
  "EcuEntityList": {
    "EcuEntity": [
      {
        "VpcId": "vpc-2zew8mi6gqbo5wf****",
        "UpdateTime": 1572867895575,
        "IpAddr": "192.168.xxx.xxx",
        "AvailableCpu": 4,
        "CreateTime": 1572539283168,
        "UserId": "edas@aliyun-****.com",
        "InstanceId": "i-2ze82h8f4zcn449y****",
        "Mem": 0,
        "RegionId": "cn-beijing",
        "EcuId": "c96c494c-1b91-4456-bbb3-b5afcd16****",
        "Cpu": 0,
        "DockerEnv": true,
        "Online": false,
        "AvailableMem": 8192,
        "ZoneId": "cn-beijing-a",
        "Name": "worker-k8s-for",
        "HeartbeatTime": 1572867865221
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.