ListScaleOutEcu - 获取用于应用扩容的ECU列表

从指定集群或应用关联集群获取可用于应用扩容的ECU列表。该接口仅适用于ECS集群。

接口说明

基本概念

  • 命名空间:指的是 EDAS 中用于隔离集群、ECS 实例和应用等资源及在 EDAS 中发布的微服务的一个逻辑概念,包括默认命名空间和自定义命名空间,每个地域下面包括一个默认命名空间和若干个自定义命名空间,默认情况下只有默认命名空间,如果不想隔离资源及微服务,则不必创建自定义命名空间。
  • ECU:ECS 导入到集群中后即为 ECU。
  • ECC:集群中的 ECU 在应用中部署后即成为 ECC。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
edas:ReadClusterRead
  • 全部资源
    *

请求语法

POST /pop/v5/resource/scale_out_ecu_list

请求参数

名称类型必填描述示例值
LogicalRegionIdstring

命名空间 ID。

  • 自定义命名空间 ID 格式为:地域 ID:命名空间标示符,例如:cn-beijing:test。
  • 默认命名空间 ID 格式为:地域 ID,例如:cn-beijing。
cn-beijing:test
ClusterIdstring

以集群为查询条件,查询该集群内可用的 ECU 列表。

说明 ClusterId 与 AppId 需要至少填入一个作为查询参数。
52984524-6d48-4bbd-******************
AppIdstring

以应用为查询条件,查询该应用所在集群内可用的 ECU 列表。

说明 ClusterId 与 AppId 需要至少填入一个作为查询参数。
b93024fd-8a9d-4ef7-99f1-5f0d65cc****
GroupIdstring

查询该应用分组所在集群内可用的 ECU 列表。

8123db90-880f-486f-****-****
Cpuinteger

查询满足 CPU 核数要求的 ECU。

1
Meminteger

查询满足剩余可用内存要求的 ECU,单位为 MB。

200
InstanceNuminteger

查询并列出指定数量的 ECU,如果不设置则代表列出所有满足筛查结果的 ECU 列表。

1

返回参数

名称类型描述示例值
object

接口响应。

Codeinteger

接口状态或 POP 错误码。

200
Messagestring

附加信息。

success
RequestIdstring

请求 ID。

AF860D6C-ACE3-4429-9D54-3BD15A******
EcuInfoListobject []

ECU 列表。

VpcIdstring

ECU 所在的 VPC ID。

vpc-2zef6ob8**********
UpdateTimelong

最后变更时间的时间戳。

1573281040827
IpAddrstring

ECU 的私网 IP。

192.168.XX.XX
AvailableCpuinteger

ECU 的可用 CPU 核数。

2
CreateTimelong

创建时间的时间戳。

1573281040819
UserIdstring

主账号 ID。

1172****6608****
InstanceIdstring

ECU 实例 ID。

i-2zej4i2jdf*********
RegionIdstring

ECU 所在地域 ID。

cn-beijing
EcuIdstring

这台 ECU 的唯一标识 ID,可以通过在 ECS 上执行dmidecode获取。

0de2ebdb-9490-4fc4-be41***************
Onlineboolean

是否在线,且实例当前是否受 EDAS 管控:

  • true:在线。
  • false:不在线。
true
DockerEnvboolean

是否安装了 Docker:

  • true:已安装 Docker。
  • false:未安装 Docker。
false
AvailableMeminteger

ECU 的可用内存数,单位 MB。

111
ZoneIdstring

ECU 所在可用区。

cn-beijing-h
Namestring

ECU 名称。

test
HeartbeatTimelong

上一次心跳检测的时间戳。

1573281040819

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "success",
  "RequestId": "AF860D6C-ACE3-4429-9D54-3BD15A******",
  "EcuInfoList": {
    "EcuInfo": [
      {
        "VpcId": "vpc-2zef6ob8**********",
        "UpdateTime": 1573281040827,
        "IpAddr": "192.168.XX.XX",
        "AvailableCpu": 2,
        "CreateTime": 1573281040819,
        "UserId": "1172****6608****",
        "InstanceId": "i-2zej4i2jdf*********",
        "RegionId": "cn-beijing",
        "EcuId": "0de2ebdb-9490-4fc4-be41***************",
        "Online": true,
        "DockerEnv": false,
        "AvailableMem": 111,
        "ZoneId": "cn-beijing-h",
        "Name": "test",
        "HeartbeatTime": 1573281040819
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。