接口说明
查询实例详情。
URL
GET https://ecloud.10086.cn/api/openapi-instance/v4/describe-instance
请求参数
Query
|
参数名称
|
类型
|
必填
|
描述
|
|
instanceId
|
string
|
是
|
实例ID。可通过查询实例状态列表接口获取。 |
|
moreDetail
|
boolean
|
否
|
是否查询ports、volumes与实例备份策略的信息。取值范围：
默认值：false。 |
|
tagNeeded
|
boolean
|
否
|
是否查询标签信息，取值范围：
默认值：false。 |
请求示例
GET https://ecloud.10086.cn/api/openapi-instance/v4/describe-instance返回参数
|
参数名称
|
类型
|
描述
|
|
body
|
InstanceDetail
|
请求成功时返回的数据。 |
|
availabilityZone
|
string
|
底层规格az信息。 |
|
bootVolumeId
|
string
|
订单侧系统盘ID。 |
|
bootVolumeType
|
string
|
实例系统盘类型。 |
|
cpu
|
integer(int32)
|
cpu个数（核）。 |
|
createdTime
|
string(date-time)
|
创建时间。 |
|
description
|
string
|
实例描述。 |
|
disk
|
integer(int32)
|
系统盘大小，单位：GB。 |
|
id
|
string
|
实例ID。 |
|
imageId
|
string
|
镜像ID。 |
|
imageName
|
string
|
镜像名称。 |
|
keypairName
|
string
|
密钥对名称。 |
|
maxBandwidth
|
string
|
实例内网带宽，单位：Mbps。 |
|
memory
|
integer(int32)
|
内存大小，单位：MB。 |
|
modifiedTime
|
string(date-time)
|
修改时间。 |
|
instanceName
|
string
|
实例名称。 |
|
ports
|
<PortDetailInServerVO> array
|
实例网卡列表。 |
|
bandwidthId
|
string
|
公网IP的带宽ID。 |
|
bandwidthSize
|
integer(int32)
|
公网IP的带宽，单位：Mbps。 |
|
id
|
string
|
网卡ID。 |
|
ipId
|
<string> array
|
公网IP列表。 |
|
macAddress
|
string
|
mac地址。 |
|
name
|
string
|
网卡名称。 |
|
privateIp
|
<string> array
|
内网IP列表。 |
|
publicIp
|
<string> array
|
公网IP列表。 |
|
routerId
|
string
|
路由器ID。 |
|
sourceDestCheck
|
boolean
|
源/目的地址检查开关。 |
|
subnetName
|
string
|
子网名称。 |
|
vpcName
|
string
|
vpc名称。 |
|
zoneId
|
string
|
可用区ID。 |
|
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
|
string
|
实例规格族。 |
|
flavorName
|
string
|
实例规格名称。 |
|
status
|
string
|
实例状态。 |
|
systemDisk
|
string
|
底层系统盘ID。 |
|
systemDiskTags
|
<InstanceTags> array
|
系统盘标签列表。 |
|
tagId
|
string
|
标签ID。 |
|
tagKey
|
string
|
标签键。 |
|
tagValue
|
string
|
标签值。 |
|
tags
|
<InstanceTags> array
|
实例标签列表。 |
|
tagId
|
string
|
标签ID。 |
|
tagKey
|
string
|
标签键。 |
|
tagValue
|
string
|
标签值。 |
|
volumes
|
<InstanceDataVolume> array
|
实例数据盘列表。 |
|
id
|
string
|
数据盘ID。 |
|
name
|
string
|
数据盘名称。 |
|
size
|
integer(int32)
|
数据盘大小。 |
|
status
|
string
|
数据盘状态。 |
|
type
|
string
|
数据盘类型。 |
|
recycle
|
boolean
|
是否放入回收站。取值范围： - false：否。 - true：是。 |
|
dedicatedHostId
|
string
|
实例所属专属宿主机实例ID。 |
|
dedicatedHostClusterId
|
string
|
实例所属宿主机集群ID。 |
|
chargeMode
|
string
|
付费方式。取值范围： 包月：MONTH。 包年：YEAR。 按量：HOUR。 |
|
threadsPerCore
|
integer(int32)
|
CPU线程数，仅部分规格支持。取值范围：- 1： 关闭超线程。
|
|
topologyType
|
string
|
CPU拓扑，仅部分规格支持。取值范围：
|
|
archiveStatus
|
string
|
归档状态。取值范围：
|
|
errorCode
|
string
|
统一错误码。 |
|
errorMessage
|
string
|
页面国际化错误提示。 |
|
errorParams
|
<string> array
|
统一错误码的自定义参数。 |
|
requestId
|
string
|
每个请求的序列号。 |
|
state
|
enum(OK,ERROR,EXCEPTION,ALARM,FORBIDDEN)
|
返回状态码。返回正常：OK，返回错误：ERROR，返回异常：EXCEPTION，需要告警实现的：ALARM，禁止访问：FORBIDDEN。 |
返回示例
{
"requestId":"reqId-93bb342ee1cb47afb20dbbc5947b3d74",
"state":"OK",
"body":{
"availabilityZone":"ecloud_compute_c3_zone",
"bootVolumeId":"f9f2d2aa8e5d44519d1a6d58747a10ed",
"bootVolumeType":"highPerformance",
"cpu":4,
"createdTime":"2025-09-04 19:21:58",
"description":null,
"disk":40,
"id":"94fec171-5423-46ae-a0eb-5ad07269b3e4",
"imageId":"bd09fd1c-935d-409d-8439-5e36112ebf87",
"imageName":"BC-Linux 7.1 64位",
"maxBandwidth":"2",
"memory":16384,
"modifiedTime":"2025-09-10 09:11:53",
"instanceName":"test-name-old",
"ports":[
{
"id":"14518c87-2f7c-4cd7-8440-65412c45a12d",
"name":"port347012",
"privateIp":[
"192.168.9.170"
],
"macAddress":"fa:16:3e:2b:02:f0",
"vpcName":"VPC_82001",
"routerId":"82f11f71-7dda-4d23-8bef-47f034fa5422",
"subnetName":"test001"
}
],
"zoneId":"cn-jiangsu-1a",
"serverVmType":"compute",
"flavorName":"c3.xlarge.4",
"status":"active",
"systemDisk":"e2580b96-8817-47e8-84bf-45806ede8bf4",
"systemDiskTags":[
{
"tagId":"862c42d8-4508-4a42-8d24-c24400b6a582",
"tagKey":"key",
"tagValue":"value"
}
],
"tags":[
{
"tagId":"862c42d8-4508-4a42-8d24-c24400b6a582",
"tagKey":"key",
"tagValue":"value"
}
],
"volumes":[
{
"id":"123a878a-e6e7-4c5b-8ee0-bcd5320ab830",
"name":"BS682144_8",
"size":10,
"type":"ssd",
"status":"in-use"
}
],
"recycle":false,
"chargeMode":"HOUR"
}
}