1. 查询云服务器列表
本接口用于查询云服务器列表。
- 该接口用于查询用户已创建未删除的云服务器列表。
- 该接口为同步接口，接口调用后会直接返回查询结果。
- 该接口会以列表的形式返回所有符合条件的云服务器信息。
1.1. 接口说明
本接口所属服务类型为 ecs
本接口操作类型为 DescribeInstances
1.1.1. 请求路径
POST {baseUrl}/v3/ecs/DescribeInstances1.1.2. 请求体
{
"aliasName": "ecs-swykjztk",
"ecsUuid": "1d393df7-5ef0-4123-bf44-d2f953efae5e",
"ip": "",
"eip": "",
"pageNum": 1,
"pageSize": 10
}请求体内容说明
| 属性名 | 属性类型 | 是否必须 | 查询方式 | 说明 |
|---|---|---|---|---|
| aliasName | String | 否 | 等值查询 | 待查询云服务器名称 |
| ecsUuid | String | 否 | 等值查询 | 待查询云服务器 UUID |
| ip | String | 否 | 等值查询 | 待查询云服务器内网 IP 地址 |
| eip | String | 否 | 等值查询 | 待查询云服务器绑定的公网 IP 地址 |
| pageNum | Integer | 否 | 等值查询 | 页号 |
| pageSize | Integer | 否 | 等值查询 | 页大小 |
1.1.3. 返回内容
{
"code": 200,
"data": {
"pageNum": 1,
"pageSize": 10,
"rows": [
{
"aliasName": "ecs-swykjztk",
"autoRenewCnt": 0,
"billingType": "PrePaid",
"createdTime": "2023-10-23 16:53:48",
"destroyTime": "2023-12-26 16:53:48",
"ebsList": [
"12b8a31a-109a-44c1-a640-3f7a2d9c6bd3"
],
"eip": "172.18.1.118",
"eipList": [
"6ba9f828-acf1-4ace-8408-a71bf11b9a6d"
],
"expireStrategy": "AutoDelete",
"expireTime": "2023-12-23 16:53:48",
"image": {
"imageArch": "64bit",
"imageDesc": "操作系统：Ubuntu20.04",
"imageId": "636bc998-9382-47e9-9573-6dbac34abda7",
"imageName": "GT-Ubuntu20.04-CMD-V2.0",
"imageOs": "Ubuntu",
"imageType": "custom",
"imageVersion": "20.04",
"vhostType": "cpu,ecpu"
},
"instanceType": {
"vhostCpus": 4,
"vhostGpus": 0.0,
"vhostMemory": 8589934592,
"vhostModel": "ecs.cpu.calc.4c8g",
"vhostType": "cpu"
},
"ip": "10.0.2.117",
"loginName": "ubuntu",
"loginPassword": "3165666e50492e67464e616c49614155",
"loginPort": 22,
"operatingSystem": "Ubuntu",
"payPeriod": 2,
"prepaidTime": "2023-10-23 16:53:48",
"resourceName": "dev-GT-Ubuntu20-04-CMD-V2-0-8GB-5M",
"resourceStatus": "Running",
"resourceUuid": "1d393df7-5ef0-4123-bf44-d2f953efae5e",
"updatedTime": "2023-10-23 16:56:30",
"zone": {
"regionCode": "cn-zhongwei",
"regionName": "中卫",
"zoneCode": "cn-zhongwei-a",
"zoneName": "中卫一区"
}
}
],
"total": 1
},
"message": "查询云服务器列表成功"
}返回体内容说明
| 属性名 | 属性类型 | 说明 |
|---|---|---|
| aliasName | String | 云服务器别名 |
| autoRenewCnt | Integer | 包月云服务器自动续费月数 |
| billingType | String | 云服务器计费类型 |
| createdTime | Datetime | 云服务器创建时间 |
| updatedTime | Datetime | 云服务器更新时间 |
| ebsList | List<EBS> | 云服务器挂载的云盘列表 |
| eipList | List<EIP> | 云服务器绑定的公网 IP 列表 |
| ip | String | 云服务器内网 IP 信息 |
| eip | String | 云服务器外网 IP 信息 |
| expireStrategy | String | 包月云服务器到期策略 |
| expireTime | Datetime | 包月云服务器到期时间 |
| destroyTime | Datetime | 策略为到期删除的包月云服务器最后删除时间 |
| image | Image | 云服务器用到的镜像 |
| instanceType | InstanceType | 云服务器规格信息 |
| loginName | String | 云服务器登录用户 |
| loginPassword | String | 云服务器登录密码 |
| loginPort | String | 云服务器登录端口 |
| operatingSystem | String | 云服务器操作系统 |
| payPeriod | Integer | 购买月数，例如：payPeriod=1表示购买1个月 |
| prepaidTime | Datetime | 包月云服务器的包月开始时间 |
| resourceName | String | 云服务器名称 |
| resourceStatus | String | 云服务器状态 |
| resourceUuid | String | 云服务器唯一 id |
| zone | Zone | 云服务器所属可用区信息 |
💡
云服务器状态resourceStatus属性值详见 云服务器状态