接口说明
本接口用于查询云主机的详细信息。
URL
GET https://ecloud.10086.cn/api/openapi-ecs/acl/v3/server/detail/{serverId}
请求参数
Path
|
参数名称
|
类型
|
必填
|
描述
|
|
serverId
|
string
|
是
|
主机ID，可通过主机列表详情接口获取。 |
Query
|
参数名称
|
类型
|
必填
|
描述
|
|
detail
|
boolean
|
否
|
是否查询ports、volumes与云主机备份策略的信息，默认为否。 |
|
tagNeeded
|
boolean
|
否
|
是否查询标签信息，默认为否。 |
请求示例
GET https://ecloud.10086.cn/api/openapi-ecs/acl/v3/server/detail/{serverId}返回参数
|
参数名称
|
类型
|
描述
|
|
body
|
ServerDetailForApiResp
|
请求成功时返回的数据。 |
|
availabilityZone
|
string
|
AZ。 |
|
bootVolumeId
|
string
|
订单侧系统盘ID。 |
|
bootVolumeType
|
enum(local,capacity,highPerformance,performanceOptimization,highPerformanceyc,performanceOptimizationyc)
|
云主机系统盘类型。 |
|
cpu
|
integer(int32)
|
cpu个数（核）。 |
|
createdTime
|
string(date-time)
|
创建时间。 |
|
description
|
string
|
云主机描述。 |
|
disk
|
integer(int32)
|
系统盘大小（GB）。 |
|
flavorId
|
string
|
规格ID。 |
|
id
|
string
|
云主机ID。 |
|
imageId
|
string
|
镜像ID。 |
|
imageName
|
string
|
镜像名称。 |
|
keypairName
|
string
|
密钥对名称。 |
|
maxBandwidth
|
string
|
云主机内网带宽。 |
|
memory
|
integer(int32)
|
内存大小（MB）。 |
|
modifiedTime
|
string(date-time)
|
修改时间。 |
|
name
|
string
|
云主机名称。 |
|
ports
|
<PortDetailInServerVO> array
|
云主机网卡列表。 |
|
bandwidthId
|
string
|
公网IP的带宽ID。 |
|
bandwidthSize
|
integer(int32)
|
公网IP的带宽，单位：Mb。 |
|
id
|
string
|
网卡ID。 |
|
ipId
|
<string> array
|
公网IP列表。 |
|
macAddress
|
string
|
mac地址。 |
|
name
|
string
|
网卡名称。 |
|
privateIp
|
<string> array
|
内网IP列表。 |
|
publicIp
|
<string> array
|
公网IP列表。 |
|
recycle
|
boolean
|
是否放入回收站，0：否，1：是。 |
|
region
|
string
|
可用区。 |
|
serverBackupPolicyResp
|
VmBackupPolicyResp
|
云主机备份策略返回体。 |
|
backupInterval
|
<enum(SUN,MON,TUE,WED,THU,FRI,SAT)> array
|
备份重复周期。周日：SUN，周一：MON，周二：TUE，周三：WED，周四：THU，周五：FRI，周六：SAT。 |
|
createdBy
|
string
|
创建者。 |
|
createdTime
|
string(date-time)
|
创建时间。 |
|
customerId
|
string
|
所属客户。 |
|
deleted
|
boolean
|
是否被删除。 |
|
name
|
string
|
网卡名称。 |
|
policyId
|
string
|
策略ID。 |
|
preservedNum
|
integer(int32)
|
备份保留数量。 |
|
preservedType
|
enum(FOREVER,DAILY,NUMBER,NO_DELETING,OTHER)
|
策略类型。 |
|
resourceType
|
enum(SERVER,VOLUME)
|
资源类型。 |
|
startTime
|
<string> array
|
备份创建时间，每天0~23点整。 |
|
serverVmType
|
enum(highIO,exclusive,memImprove,common,gpu,highPerformance,commonIntroductory,commonNetImprove,compute,computeNetImprove,memNetImprove,localStorage,localStorageEnhance,xlargeMemory,highFrequency,vgpu,normalComputeImprove,normalNetEnhance,storeEnhance,computeEnhance,armCompute,armNPU,economyCompute,vmexTest,edgeCommonNetImprove,edgeGPU,general,npu,pop,memoryDoubleCard,computeG2,memoryHBACard,localStorageLow,localStorageDoubleCard,superCompute,edgeBalance,edgeCompute,edgeLocalStorage,edgeCdn,edgeMem,edgeComputeVM,edgeDomesticARM,edgeDomesticX86,intelligentCompute,generalEnhance,universal,commonNetExclusive,UNRECOGNIZED)
|
云主机类型下的主机类型。 |
|
specsName
|
string
|
云主机规格名称。 |
|
status
|
integer(int32)
|
云主机状态，1:ACTIVE (运行中)，2:BUILD(创建中)，3:REBUILD(重装中)，4:SUSPENDED(休眠中)，5:PAUSED(已暂停)，6:RESIZE(规格变更中)，7:VERIFY_RESIZE(检查是否可规格变更中)，8:REVERT_RESIZE(规格变更回退中)，9:PASSWORD(更新密码中)，10:REBOOT(重启中)，11:HARD_REBOOT(硬重启中)，12:DELETED(已删除)，14:ERROR(云主机发生错误)，15:STOPPED(已停止)，16:SHUTOFF(已关闭)，17:MIGRATING(迁移中)，18: UNRECOGNIZED(未知状态)，19:BACKUPING(备份中)。 |
|
systemDisk
|
string
|
底层系统盘ID。 |
|
systemDiskTags
|
<ServerTagsResp> array
|
系统盘标签列表。 |
|
tagId
|
string
|
标签ID。 |
|
tagKey
|
string
|
标签键。 |
|
tagValue
|
string
|
标签值。 |
|
tags
|
<ServerTagsResp> array
|
云主机标签返回列表。 |
|
tagId
|
string
|
标签ID。 |
|
tagKey
|
string
|
标签键。 |
|
tagValue
|
string
|
标签值。 |
|
volumes
|
<VolumeDetailInServerVO> array
|
云主机数据盘列表。 |
|
id
|
string
|
网卡ID。 |
|
name
|
string
|
网卡名称。 |
|
size
|
integer(int32)
|
数据盘大小。 |
|
status
|
string
|
数据盘状态。 |
|
type
|
enum(capebs,ebs,ssd,edgessd,essdl1,essdl2,essdl3,capebszx,ssdebs,edgessdebs,edgecapacity,ssdio,hdd,capebsyc,ssdyc,ssdebsyc)
|
数据盘类型。 |
|
errorCode
|
string
|
统一错误码。 |
|
errorMessage
|
string
|
页面国际化错误提示。 |
|
errorParams
|
<string> array
|
统一错误码的自定义参数。 |
|
requestId
|
string
|
每个请求的序列号。 |
|
state
|
enum(OK,ERROR,EXCEPTION,ALARM,FORBIDDEN)
|
返回状态码。返回正常：OK，返回错误：ERROR，返回异常：EXCEPTION，需要告警实现的：ALARM，禁止访问：FORBIDDEN。 |
返回示例
{
"requestId":"reqId-a00023c6931791d509b67-fff13b01-1",
"state":"OK",
"body":{
"id":"5dc33e27-9edd-46e8-8e7d-f162063d44a0",
"name":"ECS-5730659111",
"cpu":2,
"memory":4096,
"disk":40,
"status":1,
"imageName":"BC-Linux for Euler 22.10 64位",
"imageId":"a31ccd1a-461a-4837-a186-98f5173bcb4b",
"flavorId":"ecloud-compute-8378C-0.8-000200040000",
"createdTime":"2024-06-12 13:43:40",
"modifiedTime":"2024-06-25 17:07:38",
"systemDisk":"432e5c0f-62e9-49fa-ad20-35fcbc4cc1b5",
"bootVolumeId":"768387dbed4644cb96a671b6be8309a3",
"availabilityZone":"ecloud_compute_c5_zone",
"serverVmType":"compute",
"bootVolumeType":"highPerformance",
"region":"N0512-JS-SZFH01",
"description":"",
"specsName":"c5.large.2",
"maxBandwidth":"0.8",
"ports":[
{
"id":"2fb64b21-a303-4078-b8e9-f6889ccde2ba",
"name":"port702771",
"privateIp":[
"192.168.3.29"
],
"macAddress":"fa:16:3e:ac:56:7a"
}
],
"tags":[
{
"tagId":"e73c06dc-58b8-4250-8de3-b3e1da814dfe",
"tagKey":"sysTest26",
"tagValue":"111"
},
{
"tagId":"45530e5b-f3fc-429f-b717-6ba151d8f0d0",
"tagKey":"sysTest27",
"tagValue":"111"
}
],
"recycle":false,
"systemDiskTags":[
{
"tagId":"e73c06dc-58b8-4250-8de3-b3e1da814dfe",
"tagKey":"sysTest26",
"tagValue":"111"
},
{
"tagId":"af184077-cd64-435c-a9cc-8aaf174b96b2",
"tagKey":"sysTest25",
"tagValue":"sysTest1"
}
]
}
}