describeVmInstances

描述

批量查询云主机列表信息
此接口支持分页查询，默认每页20条。

请求方式

GET

请求地址

https://yunding.jdcloud-api.com/v2/regions/{regionId}/ydVmInstances

名称 类型 是否必需 默认值 描述
regionId String True 地域ID

请求参数

名称 类型 是否必需 默认值 描述
pageNumber Integer False 1 页码；默认为1
pageSize Integer False 20 分页大小；默认为20；取值范围[10, 100]
filters Filter[] False instanceId - 云主机ID，精确匹配，支持多个
privateIpAddress - 主网卡内网主IP地址，模糊匹配，支持多个
az - 可用区，精确匹配，支持多个
vpcId - 私有网络ID，精确匹配，支持多个
status - 云主机状态，精确匹配，支持多个，参考云主机状态
name - 云主机名称，模糊匹配，支持单个
imageId - 镜像ID，精确匹配，支持多个
networkInterfaceId - 弹性网卡ID，精确匹配，支持多个
subnetId - 子网ID，精确匹配，支持多个
agId - 使用可用组id，支持单个
faultDomain - 错误域，支持多个

Filter

名称 类型 是否必需 默认值 描述
name String True 过滤条件的名称
operator String False 过滤条件的操作符，默认eq
values String[] True 过滤条件的值

返回参数

名称 类型 描述
result Result
requestId String

Result

名称 类型 描述
instances Instance[]
totalCount Number

Instance

名称 类型 描述
instanceId String 云主机ID
instanceName String 云主机名称
instanceType String 实例规格
vpcId String 主网卡所属VPC的ID
subnetId String 主网卡所属子网的ID
privateIpAddress String 主网卡主IP地址
elasticIpId String 主网卡主IP绑定弹性IP的ID
elasticIpAddress String 主网卡主IP绑定弹性IP的地址
status String 云主机状态，参考云主机状态
description String 云主机描述
imageId String 镜像ID
systemDisk InstanceDiskAttachment 系统盘配置
dataDisks InstanceDiskAttachment[] 数据盘配置
primaryNetworkInterface InstanceNetworkInterfaceAttachment 主网卡配置
secondaryNetworkInterfaces InstanceNetworkInterfaceAttachment[] 辅助网卡配置
launchTime String 创建时间
az String 云主机所在可用区
keyNames String[] 密钥对名称
charge Charge 计费信息
ag Ag 高可用组，如果创建云主机使用了高可用组，此处可展示高可用组名称
faultDomain String 高可用组中的错误域
tags Tag[] Tag信息
vpcName String vpc名称
subnetName String 子网名称
imageOverview VmImageOverview 创建主机所用镜像概览

VmImageOverview

名称 类型 描述
name String 镜像名称
platform String 平台信息

Tag

名称 类型 描述
key String 标签key。长度不能超过127字符，不能以 jrn: 或 jdc- 开头，仅支持中文、大/小写英文、数字及如下符号：\_.,:\/=+-@。
value String 标签value。长度不能超过255字符，仅支持中文、大/小写英文、数字及如下符号：\_.,:\/=+-@。

Ag

名称 类型 描述
name String 高可用组名称。
id String 高可用组ID。

Charge

名称 类型 描述
chargeMode String 支付模式，取值为：prepaid_by_duration，postpaid_by_usage或postpaid_by_duration，prepaid_by_duration表示预付费，postpaid_by_usage表示按用量后付费，postpaid_by_duration表示按配置后付费，默认为postpaid_by_duration
chargeStatus String 费用支付状态，取值为：normal、overdue、arrear，normal表示正常，overdue表示已到期，arrear表示欠费
chargeStartTime String 计费开始时间，遵循ISO8601标准，使用UTC时间，格式为：YYYY-MM-DDTHH:mm:ssZ
chargeExpiredTime String 过期时间，预付费资源的到期时间，遵循ISO8601标准，使用UTC时间，格式为：YYYY-MM-DDTHH:mm:ssZ，后付费资源此字段内容为空
chargeRetireTime String 预期释放时间，资源的预期释放时间，预付费/后付费资源均有此值，遵循ISO8601标准，使用UTC时间，格式为：YYYY-MM-DDTHH:mm:ssZ

InstanceNetworkInterfaceAttachment

名称 类型 描述
deviceIndex Integer 网卡设备Index。创建实例时此参数无须指定且指定无效。
对于主网卡默认Index为1，辅助网卡自动分配。
autoDelete Boolean 是否随实例一起删除。
true：随实例删除。
false（默认值）：不随实例删除。
networkInterface InstanceNetworkInterface 网卡设备详细配置。

InstanceNetworkInterface

名称 类型 描述
networkInterfaceId String 弹性网卡ID。
macAddress String 弹性网卡MAC地址。
vpcId String 弹性网卡所属VPC的ID。
subnetId String 子网ID。
securityGroups SecurityGroupSimple[]
sanityCheck Integer PortSecurity，源和目标IP地址校验，取值为0或者1。
primaryIp NetworkInterfacePrivateIp 网卡主IP配置。
secondaryIps NetworkInterfacePrivateIp[] 网卡辅IP地址列表。
ipv6Addresses NetworkInterfaceIpv6Address[] 弹性网卡的ipv6地址对象列表。

NetworkInterfaceIpv6Address

名称 类型 描述
ipv6Id String 弹性网卡ipv6地址ID
ipv6Address String 弹性网卡ipv6地址

NetworkInterfacePrivateIp

名称 类型 描述
privateIpAddress String 私有IP的IPV4地址
elasticIpId String 弹性IP实例ID
elasticIpAddress String 弹性IP实例地址

SecurityGroupSimple

名称 类型 描述
groupId String 安全组ID。
groupName String 安全组名称。

InstanceDiskAttachment

名称 类型 描述
diskCategory String 磁盘类型。
系统盘：取值为：local 本地系统盘 或 cloud 云盘系统盘。
数据盘：取值为：local 本地数据盘 或 cloud 云盘数据盘。
autoDelete Boolean 是否随实例一起删除，即删除实例时是否自动删除此磁盘。此参数仅对按配置计费的非多点挂载云硬盘生效。
true：随实例删除。
false：不随实例删除。
localDisk LocalDisk 本地磁盘配置，对应 diskCategory=local。
cloudDisk Disk 云硬盘配置，对应 diskCategory=cloud。
deviceName String 磁盘逻辑挂载点。
系统盘：默认为vda。
数据盘：取值范围：[vdb~vdbm]。
status String 磁盘挂载状态。
取值范围：attaching、detaching、attached、detached、error_attach、error_detach。

Disk

名称 类型 描述
diskId String 云硬盘ID
az String 云硬盘所属AZ
name String 云硬盘名称，只允许输入中文、数字、大小写字母、英文下划线“_”及中划线“-”，不允许为空且不超过32字符。
description String 云硬盘描述，允许输入UTF-8编码下的全部字符，不超过256字符。
diskType String 云硬盘类型，取值为 ssd,premium-hdd,ssd.gp1,ssd.io1,hdd.std1
diskSizeGB Integer 云硬盘大小，单位为 GiB
iops Integer 该云硬盘实际应用的iops值
throughput Integer 该云硬盘实际应用的吞吐量的数值
status String 云硬盘状态，取值为 creating、available、in-use、extending、restoring、deleting、deleted、error_create、error_delete、error_restore、error_extend、in-recyclebin 之一
attachments DiskAttachment[] 挂载信息
snapshotId String 创建该云硬盘的快照ID
multiAttachable Boolean 云盘是否支持多挂载
encrypted Boolean 云盘是否为加密盘
enabled Boolean 云盘是否被暂停（IOPS限制为极低）
createTime String 创建云硬盘时间
charge Charge 云硬盘计费配置信息
tags Tag[]
snapshotPolicies SnapshotPolicy[]
resourceGroupId String 资源组ID
canPutInRecycleBin Boolean 云盘是否可以加入回收站
trashTime String 加入回收站的时间

SnapshotPolicy

名称 类型 描述
id String 策略id
name String 策略名称
pin String 用户pin
interval Integer 策略执行间隔，单位:秒
effectiveTime String 策略生效时间。格式YYYY-MM-DDTHH:mm:ss+xx:xx。如2020-02-02T20:02:00+08:00
lastTriggerTime String 策略上次执行时间。格式YYYY-MM-DDTHH:mm:ss+xx:xx。如2020-02-02T20:02:00+08:00
nextTriggerTime String 策略下次执行时间。格式YYYY-MM-DDTHH:mm:ss+xx:xx。如2020-02-02T20:02:00+08:00
snapshotLifecycle Integer 快照保留时间。单位:秒。0：永久保留
contactInfo ContactInfo 联系人信息
createTime String 策略下次执行时间。格式YYYY-MM-DDTHH:mm:ss+xx:xx。如2020-02-02T20:02:00+08:00
updateTime String 策略下次执行时间。格式YYYY-MM-DDTHH:mm:ss+xx:xx。如2020-02-02T20:02:00+08:00
status Integer 策略状态。1：启用 2：禁用
diskCount Integer 策略绑定的disk数量

ContactInfo

名称 类型 描述
sms Integer 是否发送短信。0:不发送 1:发送
email Integer 是否发送短信。0:不发送 1:发送
personIds Integer[] 联系人id,默认为空
groupIds Integer[] 联系组id,默认为空

Tag

名称 类型 描述
key String Tag键
value String Tag值

DiskAttachment

名称 类型 描述
attachmentId String 挂载ID
diskId String 云硬盘ID
instanceType String 挂载实例的类型，取值为 vm、nc
instanceId String 挂载实例的ID
status String 挂载状态，取值为 "attaching", "attached", "detaching", "detached"
attachTime String 挂载时间

LocalDisk

名称 类型 描述
diskType String 磁盘类型，取值范围：ssd、premium-hdd、hdd.std1、ssd.gp1、ssd.io1。
diskSizeGB Integer 磁盘大小。

返回码

HTTP状态码 错误码 描述
200 OK

results matching ""

    No results matching ""

    results matching ""

      No results matching ""