接口功能介绍
查询租户购买的堡垒机实例列表信息。
接口约束
天翼云用户。
URI
POST /osm/v2/console/listInstance
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| pageNumber | 是 | Integer | 当前分页 | 1 | |
| pageSize | 是 | Integer | 分页显示的数据条数 | 10 | |
| name | 否 | String | 主机名称 | osm-82134 | |
| privateIp | 否 | String | 主机私网ip | 192.168.1.209 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| error | String | 接口错误详情 | ||
| statusCode | String | 接口请求状态码 | 00000表示成功，其他为失败 | |
| message | String | 请口操作结果说明 | 操作成功或失败说明 | |
| page | Object | 分页信息对像 | page | |
| returnObj | Array of Objects | 返回数据对像 | returnObj |
表 page
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| current | Integer | 当前页码 | 3 | |
| size | Integer | 分页数据记录数 | 10 | |
| total | Integer | 总数据量 | 54 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| id | String | 堡垒机的唯一标识 | 700c065cbbd35b8aa07d551dba4a5141 | |
| instanceName | String | 堡垒机名称 | osm-823gx | |
| regionId | String | 堡垒机所在资源池id | 贵州6公有云1 | |
| regionName | String | 堡垒机所在资源池名称 | 8dd80525678b11edbc9e0242ac110002 | |
| azName | String | 堡垒机所在可用区 | cn-xinan1 | |
| vmStatus | String | 主机状态 running：运行中 starting; 启动中 backingup: 备份中 stopping: 执行关机中 stopped: 已关机 restarting: 重启中 creating: 创建中 expired: 已到期 starting: 开机中 freezing: 冻结中 upgrading: 升级中 resizing: 变配中 error: 主机错误 | running | |
| eipId | String | 公网动态ip id | 8.43848E+11 | |
| eipAddress | String | 公网动态ip | 20.138.38.20 | |
| specName | String | 规格名称 | 企业版 | |
| assetsNum | String | 授权资产数量 | 20 | |
| concurrencyNumber | Integer | 规格授权并发量 | 100 | |
| vpcId | String | vpc id | vpc077343 | |
| vpcName | String | vpc名称 | vpc-osm | |
| securityGroupId | String | 安全组id | sg-1v5hv8r5ng | |
| securityGroupName | String | 安全组名称 | sgs-osm | |
| subnetId | String | 子网id | subnet-6m1u7qpjp4 | |
| subnetName | String | 子网名称 | subnet-osm | |
| cpuNum | Integer | 表示核心主机cpu数量 | 8 | |
| memSize | Integer | 表示内存大小，单位G | 16 | |
| vmHdType | String | 数据盘类型 | sata：高带磁盘 | |
| vmHd | Integer | 数据盘大小,单位G | 300 | |
| vmHdUsed | Integer | 数据盘已使用量,单位G | 100 | |
| createTimee | String | 创建时间 | 2024/10/10 10:10 | |
| expireDate | String | 到期时间 | 2024/10/10 10:10 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"vmId": "osm-83489843893",
"pageNumber": 1,
"pageSize": 10,
"userName": "zhangsan",
"name": "张三",
"phone": "18509098345",
"status": "ACTIVE",
"startTime": "2024-09-14 10:11:40",
"endTime": "2024-10-14 10:11:40",
"userGroupId": "user-group-id"
}
响应示例
{
"statusCode": "0",
"message": "操作成功",
"page": {
"current": 3,
"size": 10,
"total": 54
},
"returnObj": [
{
"id": "8934429824389",
"userName": "zhangsan",
"name": "张三",
"email": "zhangsan@qq.com",
"status": "ACTIVE",
"expireTime": "2024-10-10 10:10:10",
"bindOtp": true,
"bindUsbKey": false,
"createBy": "admin",
"createTime": "2024-10-10 10:10:10",
"lastLogin": "2024-10-10 10:10:10"
}
]
}
状态码
请参考 状态码
错误码
请参考 错误码
