查询弹性IP可绑定虚机列表v3
更新时间 2025-08-26 16:07:57
最近更新时间: 2025-08-26 16:07:57
接口功能介绍
查询弹性IP可绑定虚机列表v3
接口约束
无
URI
GET /v3/fip/describeDesktopForFip
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池ID。 | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | |
desktopOid | 否 | String | 桌面ID | ||
desktopName | 否 | String | 桌面名称 | ||
pageNum | 否 | Integer | 页码,至少1,默认1 | ||
pageSize | 否 | Integer | 每页数量,最大100,默认10 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 状态码。可能值: - 800:请求成功。 - 900:请求失败。 |
800 | |
error | String | 错误码。 | ECPC_1000 | |
message | String | 提示信息。 | OK. | |
returnObj | Object | 返回数据对象 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
total | Long | 总记录数 | ||
list | Array of Objects | 数据列表 | list |
表 list
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
desktopOid | String | 虚机ID | ||
desktopName | String | 虚机名称 | ||
nickname | String | 虚机別名 | ||
createDate | Object | 虚机创建时间 | createDate | |
portList | Array of Objects | 虚机网卡 | portList |
表 portList
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
portOid | String | 网卡ID | ||
portUuid | String | 网卡UUID | ||
ipAddr | String | 网卡ip地址 | ||
subnetName | String | 所属子网名称 | ||
subnetCidr | String | 所属子网网段 | ||
portName | String | 网卡名称 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{
"statusCode":800,
"message":"OK.",
"returnObj":{
"total":1,
"list":[{
"vpcOid":"fooId",
"desktopOid":"D0025042501321534",
"desktopName":"0000ecfi-KQoXL3qgpc",
"nickname":"null,",
"createDate":"1745552277000,",
"portList":[{
"portOid":"port-flqrdu1mq3grx34c5ifxf",
"portUuid":"735d6f8c-1b19-430f-9c5f-9c90afce2cda",
"ipAddr":"172.16.0.220",
"subnetName":"vpc-172",
"subnetCidr":"172.16.0.0/24",
"portName":null
}]
}]
}
}
状态码
请参考 状态码
错误码
请参考 错误码