接口说明
查询实例列表并关联查询实例详情。
URL
POST https://ecloud.10086.cn/api/openapi-instance/v4/list/describe-instances
请求参数
Body
|
参数名称
|
类型
|
必填
|
描述
|
|
describeInstancesReq
|
DescribeInstancesReq
|
是
|
describeInstancesReq |
|
withNetwork
|
boolean
|
否
|
是否查询网络信息。取值范围：
默认值：false。 |
|
status
|
<string> array
|
否
|
实例状态。取值范围：
|
|
serverTypes
|
<string> array
|
否
|
实例类型。取值范围：
|
|
serverVmTypes
|
<string> array
|
否
|
实例规格族。取值范围：
|
|
productTypes
|
<string> array
|
否
|
实例的产品类型。取值范围：
|
|
imageOsTypes
|
<string> array
|
否
|
实例操作系统类型。取值范围：
|
|
rangeInInstanceIds
|
<string> array
|
否
|
范围内实例ID集合。 |
|
tags
|
<Tag> array
|
否
|
标签，可通过查询用户标签列表接口获取。 |
|
key
|
string
|
是
|
标签键，仅支持中英文、数字、中划线、下划线，长度1-127位之间，不能以ecloud开头。 |
|
value
|
string
|
是
|
标签值，仅支持数字、中英文、中划线、下划线，长度在1~255位之间，不能以 |
|
dedicatedHostClusterId
|
string
|
否
|
宿主机集群ID，您可以通过查看专属宿主机集群列表获取信息。 |
|
instanceName
|
string
|
否
|
实例名称。 |
|
instanceId
|
string
|
否
|
实例ID，可通过查询实例状态列表接口获取。 |
|
cpu
|
integer(int32)
|
否
|
cpu核数。 |
|
ram
|
integer(int32)
|
否
|
内存大小，单位：MB。 |
|
disk
|
integer(int32)
|
否
|
系统盘大小，单位：GB。 |
|
startDate
|
string
|
否
|
开始时间。输入格式为：yyyy-MM-dd HH:mm:ss。 |
|
endDate
|
string
|
否
|
结束时间。输入格式为：yyyy-MM-dd HH:mm:ss。 |
|
publicIp
|
string
|
否
|
公网IP地址。 |
|
privateIp
|
string
|
否
|
内网IP地址。 |
|
securityGroupId
|
string
|
否
|
安全组ID。 |
|
routerId
|
string
|
否
|
router的ID。 |
|
vpcId
|
string
|
否
|
VPC的ID。您可以通过查询分页查询VPC列表获取。 |
|
unBindFip
|
boolean
|
否
|
是否未绑定公网IP。取值范围：
|
|
mountVolumeId
|
string
|
否
|
绑定的数据盘ID。 |
|
unMountVolumeId
|
string
|
否
|
未绑定的数据盘ID。 |
|
dedicatedHostId
|
string
|
否
|
专属宿主机ID。您可以通过 查看集群内专属宿主机列表获取信息。 |
|
deCloudIdForVm
|
string
|
否
|
查询Decloud下的虚拟机节点使用。 |
|
imageId
|
string
|
否
|
镜像ID，您可以通过下面的接口查询您需要的镜像。 |
|
page
|
integer(int32)
|
否
|
列表分页页数，起始页为1。 |
|
pageSize
|
integer(int32)
|
否
|
列表分页每页大小，取值范围[1,100]。 默认值：10。 |
|
keyName
|
string
|
否
|
密钥对名称，可通过查询密钥对列表获取。 |
|
unBindBackupPolicy
|
boolean
|
否
|
实例是否绑定备份策略。取值范围：
|
|
backupPolicyId
|
string
|
否
|
实例绑定的备份策略ID。 |
|
hasBackup
|
boolean
|
否
|
实例是否有备份。取值范围：
|
|
queryWordId
|
string
|
否
|
模糊查询实例ID。 |
|
queryWordName
|
string
|
否
|
模糊查询实例名称或公网IP。 |
|
backupPolicyNeeded
|
boolean
|
否
|
是否需要返回实例备份策略的信息。取值范围：
默认值：false。 |
|
groupId
|
string
|
否
|
群组ID。 |
|
excludeGroupId
|
string
|
否
|
需要排除的群组。 |
|
needMainPortId
|
boolean
|
否
|
是否需要裸金属主网卡ID。取值范围：
默认值：false。 |
|
recycle
|
boolean
|
否
|
是否放入回收站。取值范围：
|
|
imageName
|
string
|
否
|
实例镜像名称。 |
|
flavorName
|
string
|
否
|
规格名称。可通过查询实例可用规格列表获取。 |
|
tagNeeded
|
boolean
|
否
|
是否查询标签信息。取值范围：
默认值：false。 |
|
zoneId
|
string
|
否
|
可用区，可通过查询属地地域可用区信息接口获取。 |
|
chargeModeNeeded
|
boolean
|
否
|
是否查询实例付费信息。取值范围：
默认值：false。 |
请求示例
POST https://ecloud.10086.cn/api/openapi-instance/v4/list/describe-instances{
"page":1,
"pageSize":1
}返回参数
|
参数名称
|
类型
|
描述
|
|
body
|
PageListResp«InstancePortDetail»
|
请求成功时返回的数据。 |
|
content
|
<InstancePortDetail> array
|
分页查询返回的具体结构体。 |
|
actualSystemImage
|
string
|
实际系统镜像。 |
|
adminPaused
|
boolean
|
主机是否封堵。取值范围：
|
|
adminPausedTip
|
string
|
封堵提示。 |
|
zoneId
|
string
|
可用区ID。 |
|
bootVolumeType
|
string
|
实例系统盘的类型。取值范围：
|
|
createdTime
|
string(date-time)
|
创建时间。 |
|
credibleStatus
|
string
|
实例可信状态。取值范围： - CREDIBLE：可信云主机状态为可信。 - INCREDIBLE：可信云主机状态为不可信。 - UNMEASURED：可信云主机状态为未度量。 - UNOPENED：非可信云主机。 |
|
crossRegionMigrate
|
boolean
|
是否跨可用区迁移中。取值范围：
|
|
dedicatedHostClusterId
|
string
|
专属宿主机集群ID。 |
|
dedicatedHostClusterName
|
string
|
专属宿主机集群名称。 |
|
dedicatedHostId
|
string
|
专属宿主机ID。 |
|
dedicatedHostName
|
string
|
专属宿主机名称。 |
|
description
|
string
|
实例描述。 |
|
status
|
string
|
实例状态。 |
|
groupId
|
string
|
群组ID。 |
|
iaUserId
|
string
|
内循环账号ID。 |
|
instanceId
|
string
|
实例ID。 |
|
imageName
|
string
|
系统镜像名称。 |
|
imageOsType
|
enum(linux,windows,other)
|
镜像操作系统类型。 |
|
imageId
|
string
|
镜像ID。 |
|
ironicNodeId
|
string
|
裸金属node的ID。 |
|
keyName
|
string
|
密钥对名称。 |
|
mainPortId
|
string
|
裸金属主网卡ID。 |
|
maxPorts
|
integer(int32)
|
网卡数量。 |
|
maxVolumes
|
integer(int32)
|
最大可挂载硬盘数量。 |
|
availableZone
|
string
|
底层主机所在az。 |
|
instanceName
|
string
|
实例名称。 |
|
portDetail
|
<PortDetailForServer> array
|
实例绑定的网络信息。 |
|
fipAddress
|
string
|
公网IP地址。 |
|
fipBandwidthSize
|
integer(int32)
|
带宽大小。 |
|
fipV6Address
|
string
|
公网IP v6地址。 |
|
fixedIpDetailResps
|
<FixedIpDetailResp> array
|
fixedIpResps |
|
bandwidthId
|
string
|
v4带宽ID。 |
|
bandwidthSize
|
integer(int32)
|
公网IP带宽，单位：Mbps。 |
|
bandwidthType
|
enum(shared,exclusive,ipv6Qos,ipv6Shared)
|
带宽类型。 |
|
chargeModeEnum
|
enum(bandwidthCharge,trafficCharge)
|
带宽计费方式（按固定带宽计费bandwidthCharge、按流量计费trafficCharge）。 |
|
fipResourceId
|
string
|
v4公网IP的资源ID。 |
|
ipAddress
|
string
|
内网IP。 |
|
ipVersion
|
enum(4,6)
|
IP版本，v4或v6。 |
|
ipv6BandwidthSize
|
integer(int32)
|
IPv6带宽值Mb |
|
nsQosPolicyId
|
string
|
IPv6带宽ID。 |
|
publicIP
|
string
|
公网IP。 |
|
subnetCidr
|
string
|
子网CIDR网段。 |
|
subnetId
|
string
|
子网Id。 |
|
subnetName
|
string
|
子网名称。 |
|
portId
|
string
|
网卡Id。 |
|
portName
|
string
|
网卡名称。 |
|
privateIp
|
string
|
内网IP。 |
|
routerId
|
string
|
routerId。 |
|
sourceDestCheck
|
boolean
|
是否开启源/目的地址检查。 |
|
subnetName
|
string
|
子网名称。 |
|
vpcId
|
string
|
VPC的Id。 |
|
vpcName
|
string
|
VPC名称。 |
|
productType
|
string
|
实例的产品类型。取值范围：
|
|
recycle
|
boolean
|
是否放入回收站。取值范围：
|
|
recycleCount
|
integer(int32)
|
放入回收站的次数。 |
|
recycleStatus
|
string
|
回收站状态。取值范围：
|
|
recycleTime
|
string(date-time)
|
放入回收站的时间。 |
|
releaseProtect
|
boolean
|
实例是否开启实例释放保护。取值范围：
|
|
instanceBackupPolicy
|
InstanceBackupPolicyResp
|
实例备份策略返回体 |
|
policyId
|
string
|
策略ID。 |
|
policyName
|
string
|
策略名称。 |
|
serverType
|
string
|
实例类型。取值范围：
|
|
serverVmType
|
string
|
实例规格族。 |
|
flavorName
|
string
|
规格名称。 |
|
stoppedMode
|
boolean
|
关机模式。取值范围：
|
|
supportVolumeMount
|
boolean
|
是否支持挂卷。取值范围：
|
|
systemDiskId
|
string
|
系统盘ID。 |
|
tags
|
<InstanceTags> array
|
实例标签返回列表。 |
|
tagId
|
string
|
标签ID。 |
|
tagKey
|
string
|
标签键。 |
|
tagValue
|
string
|
标签值。 |
|
userName
|
string
|
订购用户名称。 |
|
vcpu
|
integer(int32)
|
cpu个数（核）。 |
|
vdisk
|
integer(int32)
|
系统盘大小，单位：GB。 |
|
vmemory
|
integer(int32)
|
内存大小，单位：MB。 |
|
chargeMode
|
string
|
付费方式。取值范围：
|
|
archiveStatus
|
string
|
归档状态。取值范围：
|
|
total
|
integer
|
满足查询条件的总个数。 |
|
errorCode
|
string
|
统一错误码。 |
|
errorMessage
|
string
|
页面国际化错误提示。 |
|
errorParams
|
<string> array
|
统一错误码的自定义参数。 |
|
requestId
|
string
|
每个请求的序列号。 |
|
state
|
enum(OK,ERROR,EXCEPTION,ALARM,FORBIDDEN)
|
返回状态码。返回正常：OK，返回错误：ERROR，返回异常：EXCEPTION，需要告警实现的：ALARM，禁止访问：FORBIDDEN。 |
返回示例
{
"requestId":"reqId-37598524-3401-46ff-bdf6-b1067cf13a2a",
"state":"OK",
"body":{
"total":1,
"content":[
{
"actualSystemImage":"",
"adminPaused":false,
"adminPausedTip":null,
"zoneId":"cn-jiangsu-1a",
"bootVolumeType":"highPerformanceyc",
"createdTime":"2025-09-10 00:42:29",
"credibleStatus":"UNOPENED",
"crossRegionMigrate":false,
"dedicatedHostClusterId":null,
"dedicatedHostClusterName":null,
"dedicatedHostId":null,
"dedicatedHostName":null,
"description":null,
"status":"active",
"groupId":"",
"instanceId":"bf5037f5-c7c9-4701-b2b9-b40537327ef6",
"imageName":"BC-Linux 8.6 64位",
"imageOsType":"linux",
"imageId":"e2f73472-97c7-124e-574c-fea377c7dbb3",
"keyName":null,
"mainPortId":null,
"maxPorts":null,
"maxVolumes":null,
"availableZone":"ecloud_normal_s4_zone",
"instanceName":"zrj测试主机名",
"portDetail":null,
"productType":"NORMAL",
"recycle":false,
"recycleCount":0,
"recycleStatus":"UNRECYCLE",
"recycleTime":null,
"releaseProtect":false,
"serverType":"VM",
"serverVmType":"universal",
"flavorName":"u1.large.1",
"stoppedMode":false,
"supportVolumeMount":null,
"systemDiskId":"85ad673e-de41-4187-9b43-2e4740e6eec4",
"userName":"csy_csb_iaas_guochangguang_ext",
"vcpu":2,
"vdisk":40,
"vmemory":2048
}
]
}
}