接口功能介绍
查询租户购买的堡垒机详细信息。
接口约束
天翼云用户。
URI
POST /osm/v2/console/getInstanceAttribute
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| vmId | 是 | String | 主机id | 700c065cbbd35b8aa07d551dba4a5141 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 接口请求状态码 | 00000表示成功，其他为失败 | |
| message | String | 请口操作结果说明 | 操作成功或失败说明 | |
| returnObj | Object | 返回数据对像 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| id | String | 堡垒机的唯一标识 | 700c065cbbd35b8aa07d551dba4a5141 | |
| instanceName | String | 堡垒机名称 | osm-823gx | |
| regionId | String | 堡垒机所在资源池id | 8dd80525678b11edbc9e0242ac110002 | |
| regionName | String | 堡垒机所在资源池名称 | 贵州6公有云1 | |
| azName | String | 堡垒机所在可用区 | cn-xinan1 | |
| vmStatus | String | 主机状态 running：运行中 starting; 启动中 backingup: 备份中 stopping: 执行关机中 stopped: 已关机 restarting: 重启中 creating: 创建中 expired: 已到期 starting: 开机中 freezing: 冻结中 upgrading: 升级中 resizing: 变配中 error: 主机错误 | running | |
| eipId | String | 公网动态ip id | eip-dba4a5141 | |
| eipAddress | String | 公网动态ip | 20.138.38.20 | |
| specName | String | 规格名称 | 企业版 | |
| assetsNum | String | 授权资产数量 | 20 | |
| concurrencyNumber | String | 规格授权并发量 | 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": "700c065cbbd35b8aa07d551dba4a5141"
}
响应示例
{
"statusCode": "00000",
"message": "操作成功",
"returnObj": {
"id": "700c065cbbd35b8aa07d551dba4a5141",
"instanceName": "osm-823gx",
"regionId": "贵州6公有云1",
"regionName": "8dd80525678b11edbc9e0242ac110002",
"azName": "cn-xinan1",
"vmStatus": "running",
"eipId": "eip-dba4a5141",
"eipAddress": "20.138.38.20",
"specName": "企业版",
"assetsNum": 20,
"concurrencyNumber": 100,
"vpcId": "vpc077343",
"vpcName": "vpc-osm",
"securityGroupId": "sg-1v5hv8r5ng",
"securityGroupName": "sgs-osm",
"subnetId": "subnet-6m1u7qpjp4",
"subnetName": "subnet-osm",
"cpuNum": "8",
"memSize": "16",
"vmHdType": "sata",
"vmHd": "300",
"vmHdUsed": "100",
"createTimee": "2024-10-10 10:10:10",
"expireDate": "2024-10-10 10:10:10"
}
}
状态码
请参考 状态码
错误码
请参考 错误码
