1)接口功能介绍
获取后端服务器组可用的虚机列表。
2)接口约束
后端服务器组id必须正确请求。
3)URI
GET /v1/getVirtualMachineList。
4)请求参数
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
nodeCode | 是 | String | 边缘集群id | cn-guangzhou6 | |
backendGroupId | 是 | String | 后端服务器组id | 129 | |
subnetIp | 否 | String | 内网IP地址 | 172.22.3.33 | |
virtualMachineCustomName | 否 | String | 后端服务器名称 | test |
5)响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
status | 是 | Object | 应答状态 | status | |
data | 是 | object | 返回数据 | data |
表 status
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
message | 是 | String | 状态描述 | Success | |
code | 是 | String | 状态码 | Success |
表 data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
virtualMachineList | 是 | List | * | 获取可用主机IP响应数据列表 | virtualMachineList |
表 virtualMachineList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
virtualMachineId | 否 | String | evm-c1qmqiejga41vi6c10l0 | evm-c1qmqiejga41vi6c10l0 | |
spec | 否 | String | 虚机规格 | 2 vCPUs | 2G |
subnetIp | 否 | String | 虚机内外ip | 100.64.0.35 | |
customName | 否 | String | 虚机名称 | evm-name |
6)请求示例
GET https://{host}/v1/getVirtualMachineList?nodeCode=hn-changde-1&backendGroupId=5150
7)响应示例
{
"data": {
"virtualMachineList": [
{
"customName": "evm-eop-test-勿删",
"subnetIp": "10.0.0.3",
"spec": "1 vCPUs | 1G",
"virtualMachineId": "evm-cdusn1719r7fam2ea170"
},
{
"customName": "evm-7qeg",
"subnetIp": "10.0.0.5",
"spec": "1 vCPUs | 1G",
"virtualMachineId": "evm-cdusn1719r7fam2ea180"
}
]
},
"requestId": "9a5b7e7c-6ea3-450b-ad22-b345fc49087a"
}
}
8)状态码
状态码 | 描述 |
---|---|
Success | 表示请求成功。 |