文档中心 > DescribeEcs
DescribeEcs

最近更新时间:2021-11-17

请求方法:GET

接口描述:查询云主机实例列表


请求参数

Param

名称

类型

是否必选

描述

Action

String

操作名取值DescribeEcs

RegionId

String

区域Id

  • HB1-BJMY (华北2-北京2)

  • HD1-SHMY(华东1-上海)

Page

int

页码,默认1

Size

int

列表容量,默认10

InstanceId

String

以主机ID筛选

InstanceName

String

以主机名筛选

IpAddr

String

以主机IP筛选

 

返回参数

名称

类型

描述

RequestId

String

请求ID

page

int

请求page

size

int

请求size

totalCount

int

总条数

totalPages

int

总页数

list

object

内容

+instanceId

String

云主机ID

+instanceName

String

云主机名称

+instanceCode

String

规格编码

+instanceCodeName

String

规格描述

+status

String

主机实例,详见枚举说明

+imageId

String

镜像ID

+imageType

String

镜像类型

+imageCode

String

镜像规格

+imageParentCode

String

镜像规格族编码

+description

String

主机描述

+ip

String

主机IP

+eipId

String

EIP-ID

+eipAddr

String

EIP-IP

+eipSize

String

EIP带宽

+eipCode

String

EIP规格

+sysDiskSize

String

系统盘大小

+sysDiskCode

String

系统盘规格

+startTime

String

主机开通时间

+endTime

String

主机到期时间

+bindDiskCount

String

已绑定硬盘数量

+eniId

String

主机主网卡ID

+secondaryEni

String[]

辅助网卡ID(目前只支持绑定一块辅助网卡)

+azoneId

String

主机所在可见域

+payType

String

计费方式

 

示例

请求示例

GET https://api.unicloud.com/compute/ecs/instances?

Action=DescribeEcs

&RegionId=cb4c1d5f-7095-430a-8ea3-b5466b6093ea

&Page=1

&Size=10

&公共请求参数


返回示例

JSON格式

{

"RequestId": "b9de1a62-d09e-4d34-9a61-38f0f56564b6",

    "page": 1,

    "size": 10,

    "totalCount": 1,

    "totalPages": 1,

    "list": [

        {

            "instanceId": "ecs-j024uijbcy99",

            "instanceName": "i-enh1hMBDJo",

            "sysDiskSize": 40,

            "sysDiskCode": "ebs.highIO.ssd",

            "status": "RUNNING",

            "imageId": "centos-imageTest-2",

            "imageType": "linux",

            "imageCode": "imageTest2",

            "imageParentCode": "ecs.image.public",

            "instanceSystem": "imageTest2",

            "description": null,

            "ip": "172.16.0.24",

            "eipId": "eip-omnp1ro1kl3ob",

            "eipAddr": "101.65.1.146",

            "eipSize": 1,

            "eipName": "NetvsUK7x97Qk",

            "eipCode": "eip.bgp.static",

            "instanceCode": "ecs.s5.medium",

            "instanceCodeName": "通用型1核4GB",

            "payType": "YEAR_MONTH",

            "startTime": 1594627186000,

            "endTime": 1597334400000,

            "bindDiskCount": 0,

            "maxDisk": 15,

            "eniId": "eni-j024uijbczab",

            "regionId": "cn-beijing",

            "regionName": "华北2-北京2",

            "secondaryEni":["eni-j06n7tut19wo"],

            "azoneId": "cn-beijing-a",

            ""

        }

    ]

}