文档

DescribeInstances - 查询一台或多台ECS实例的详细信息

更新时间:

调用DescribeInstances查询一台或多台ECS实例的详细信息。

接口说明

  • 请求参数的作用类似于一个过滤器,过滤器为逻辑与(AND)关系。如果某一参数为空,则过滤器不起作用。但是参数 InstanceIds 如果是一个空 JSON 数组,则视为该过滤器有效,且返回空。

  • 如果您使用的是 RAM 用户账号或者 RAM 角色,当用户或者角色缺乏接口权限时,将会返回空列表。您可以在请求中加入DryRun参数,判断是否因权限问题导致的空列表现象。

  • 通过阿里云 CLI 调用 API 时,不同数据类型的请求参数取值必须遵循格式要求。更多信息,请参见 CLI 参数格式说明

  • 支持以下两种方式查看返回数据:

    • 方式一:分页查询首页时,仅需设置MaxResults以限制返回信息的条目数,返回结果中的NextToken将作为查询后续页的凭证。查询后续页时,将NextToken参数设置为上一次返回结果中获取到的NextToken作为查询凭证,并设置MaxResults限制返回条目数。
    • 方式二:通过PageSize设置单页返回的条目数,再通过PageNumber设置页码。

    以上两种方式只能任选其中之一。当返回的条目数较多时,推荐使用方式一。如果设置了MaxResultsNextToken参数,则请求参数PageSizePageNumber将失效,且返回数据中的TotalCount无效。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:DescribeInstancesRead
  • Instance
    acs:ecs:{#regionId}:{#accountId}:instance/*
  • Instance
    acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}
  • ResourceOwner
  • ecs:tag

请求参数

名称类型必填描述示例值
RegionIdstring

实例所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
VpcIdstring

专有网络 VPC ID。

v-bp67acfmxazb4p****
VSwitchIdstring

交换机 ID。

vsw-bp67acfmxazb4p****
ZoneIdstring

可用区 ID。

cn-hangzhou-g
InstanceNetworkTypestring

实例网络类型。取值范围:

  • classic:经典网络。
  • vpc:专有网络 VPC。
vpc
SecurityGroupIdstring

实例所属的安全组。

sg-bp67acfmxazb4p****
InstanceIdsstring

实例 ID。取值可以由多个实例 ID 组成一个 JSON 数组,最多支持 100 个 ID,ID 之间用半角逗号(,)隔开。

["i-bp67acfmxazb4p****", "i-bp67acfmxazb4p****", … "i-bp67acfmxazb4p****"]
PageNumberinteger

实例状态列表的页码。

起始值:1。

默认值:1。

1
PageSizeinteger

分页查询时设置的每页行数。

最大值为 100。

默认值为 10。

10
NextTokenstring

查询凭证(Token),取值为上一次 API 调用返回的NextToken参数值。

caeba0bbb2be03f84eb48b699f0a4883
MaxResultsinteger

分页查询时每页行数。最大值为 100。

默认值:

  • 当不设置值或设置的值小于 10 时,默认值为 10。
  • 当设置的值大于 100 时,默认值为 100。
10
InnerIpAddressesstring

经典网络类型实例的内网 IP 列表。当 InstanceNetworkType=classic 时生效,取值可以由多个 IP 组成一个 JSON 数组,最多支持 100 个 IP,IP 之间用半角逗号(,)隔开。

["10.1.1.1", "10.1.2.1", … "10.1.10.1"]
PrivateIpAddressesstring

VPC 网络类型实例的私有 IP。当 InstanceNetworkType=vpc 时生效,取值可以由多个 IP 组成一个 JSON 数组,最多支持 100 个 IP,IP 之间用半角逗号(,)隔开。

["172.16.1.1", "172.16.2.1", … "172.16.10.1"]
PublicIpAddressesstring

实例的公网 IP 列表。取值可以由多个 IP 组成一个 JSON 数组,最多支持 100 个 IP,IP 之间用半角逗号(,)隔开。

["42.1.1.**", "42.1.2.**", … "42.1.10.**"]
EipAddressesstring

实例的弹性公网 IP 列表。当 InstanceNetworkType=vpc 时该参数生效,取值可以由多个 IP 组成一个 JSON 数组,最多支持 100 个 IP,IP 之间用半角逗号(,)隔开。

["42.1.1.**", "42.1.2.**", … "42.1.10.**"]
InstanceChargeTypestring

实例的计费方式。取值范围:

  • PostPaid:按量付费。
  • PrePaid:包年包月。
PostPaid
InternetChargeTypestring

公网带宽计费方式。取值范围:

  • PayByBandwidth:按固定带宽计费。
  • PayByTraffic:按使用流量计费。
说明 按使用流量计费模式下的出入带宽峰值都是带宽上限,不作为业务承诺指标。当出现资源争抢时,带宽峰值可能会受到限制。如果您的业务需要有带宽的保障,请使用按固定带宽计费模式。
PayByTraffic
InstanceNamestring

实例名称,支持使用通配符*进行模糊搜索。

Test
ImageIdstring

镜像 ID。

m-bp67acfmxazb4p****
Statusstring

实例状态。取值范围:

  • Pending:创建中。
  • Running:运行中。
  • Starting:启动中。
  • Stopping:停止中。
  • Stopped:已停止。
Running
LockReasonstring

资源被锁定的原因。取值范围:

  • financial:因欠费被锁定。

  • security:因安全原因被锁定。

  • Recycling:抢占式实例的待释放锁定状态。

  • dedicatedhostfinancial:因为专有宿主机欠费导致 ECS 实例被锁定。

  • refunded:因退款被锁定。

security
Filter.1.Keystring

查询资源时的筛选键,取值必须为CreationStartTime。同时设置Filter.1.KeyFilter.1.Value可以查询在指定时间点后创建的资源信息。

CreationStartTime
Filter.2.Keystring

查询资源时的筛选键,取值必须为CreationEndTime。同时设置Filter.2.KeyFilter.2.Value可以查询在指定时间点前创建的资源信息。

CreationEndTime
Filter.3.Keystring

查询资源时的筛选键,取值必须为ExpiredStartTime。同时设置Filter.3.KeyFilter.3.Value可以查询在指定时间点后到期的资源信息。

ExpiredStartTime
Filter.4.Keystring

查询资源时的筛选键,取值必须为ExpiredEndTime。同时设置Filter.4.KeyFilter.4.Value可以查询在指定时间点前到期的资源信息。

ExpiredEndTime
Filter.1.Valuestring

查询资源时的筛选值。指定该参数时必须同时指定Filter.1.Key参数,格式为:yyyy-MM-ddTHH:mmZ,采用 UTC +0 时区。

2017-12-05T22:40Z
Filter.2.Valuestring

查询资源时的筛选值。指定该参数时必须同时指定Filter.2.Key参数,格式为:yyyy-MM-ddTHH:mmZ,采用 UTC +0 时区。

2017-12-06T22:40Z
Filter.3.Valuestring

查询资源时的筛选值。指定该参数时必须同时指定Filter.3.Key参数,格式为:yyyy-MM-ddTHH:mmZ,采用 UTC +0 时区。

2017-12-07T22:40Z
Filter.4.Valuestring

查询资源时的筛选值。指定该参数时必须同时指定Filter.4.Key参数,格式为:yyyy-MM-ddTHH:mmZ,采用 UTC +0 时区。

2017-12-08T22:40Z
DeviceAvailableboolean
说明 该参数正在邀测中,暂不支持使用。
false
IoOptimizedboolean

是否是 I/O 优化型实例。取值范围:

  • true:是。
  • false:否。
true
NeedSaleCycleboolean
说明 该参数正在邀测中,暂不支持使用。
false
InstanceTypestring

实例的规格。

ecs.g5.large
InstanceTypeFamilystring

实例的规格族。

ecs.g5
KeyPairNamestring

实例使用的 SSH 密钥对名称。

KeyPairNameTest
ResourceGroupIdstring

实例所在的企业资源组 ID。使用该参数过滤资源时,资源数量不能超过 1000 个。

说明 不支持默认资源组过滤。
rg-bp67acfmxazb4p****
HpcClusterIdstring

实例所在的 HPC 集群 ID。

hpc-bp67acfmxazb4p****
RdmaIpAddressesstring

HPC 实例的 RDMA 网络 IP。

10.10.10.102
DryRunboolean

是否只预检此次请求。取值范围:

  • true:发送检查请求,不会查询资源状况。检查项包括 AccessKey 是否有效、RAM 用户的授权情况和是否填写了必需参数。如果检查不通过,则返回对应错误。如果检查通过,会返回错误码 DryRunOperation。
  • false:发送正常请求,通过检查后返回 2XX HTTP 状态码并直接查询资源状况。

默认值:false。

false
HttpEndpointstring

是否启用实例元数据的访问通道。取值范围:

  • enabled:启用。
  • disabled:禁用。

默认值:enabled。

说明 有关实例元数据的更多信息,请参见实例元数据概述
enabled
HttpTokensstring

访问实例元数据时是否强制使用加固模式(IMDSv2)。取值范围:

  • optional:不强制使用。
  • required:强制使用。设置该取值后,普通模式无法访问实例元数据。

默认值:optional。

说明 有关访问实例元数据模式的更多信息,请参见实例元数据访问模式
optional
HttpPutResponseHopLimitinteger
说明 该参数正在邀测中,暂不支持使用。
0
Ipv6Addressarray

为弹性网卡指定的 IPv6 地址。

string

弹性网卡的 IPv6 地址。N 表示可以设置多个 IPv6 地址,N 的取值范围为 1~100。

2408:4321:180:1701:94c7:bc38:3bfa:****
Tagobject []

标签列表。

keystring

标签键。

说明 为提高兼容性,建议您使用另一个Tag.N.Key参数。
keyTest
Keystring

实例的标签键。N 的取值范围为 1~20。

使用一个标签过滤资源,查询到该标签下的资源数量不能超过 1000 个;使用多个标签过滤资源,查询到同时绑定了多个标签的资源数量不能超过 1000 个。如果资源数量超过 1000 个,请使用 ListTagResources 接口进行查询。

TestKey
Valuestring

实例的标签值。N 的取值范围:1~20。

TestValue
valuestring

标签值。

说明 为提高兼容性,建议您使用另一个Tag.N.Value参数。
valueTest
AdditionalAttributesarray

其他属性值。N 的取值范围为 1~20。取值范围:

  • META_OPTIONS:实例元数据。
  • DDH_CLUSTER:专有宿主机集群。
  • NETWORK_PRIMARY_ENI_IP :主网卡辅助 IP。
  • CPU_OPTIONS_TOPOLOGY_TYPE:实例的 CPU 拓扑类型。
string

其他属性值。N 的取值范围为 1~20。取值范围:

  • META_OPTIONS:实例元数据。
  • DDH_CLUSTER:专有宿主机集群。
  • NETWORK_PRIMARY_ENI_IP :主网卡辅助 IP。
  • CPU_OPTIONS_TOPOLOGY_TYPE:实例的 CPU 拓扑类型。
META_OPTIONS

返回参数

名称类型描述示例值
object
NextTokenstring

本次调用返回的查询凭证值。

caeba0bbb2be03f84eb48b699f0a4883
PageSizeinteger

输入时设置的每页行数。

10
PageNumberinteger

实例列表的页码。

1
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCountinteger

查询到的实例总数。

说明 使用MaxResultsNextToken参数进行分页查询时,返回的TotalCount参数值无意义。
1
Instancesobject []

由 Instances 组成的数组格式,返回实例的信息。

CreationTimestring

实例创建时间。以 ISO 8601 为标准,并使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mmZ。更多信息,请参见ISO 8601

2017-12-10T04:04Z
SerialNumberstring

实例序列号。

51d1353b-22bf-4567-a176-8b3e12e4****
Statusstring

实例状态。

Running
DeploymentSetIdstring

部署集 ID。

ds-bp67acfmxazb4p****
KeyPairNamestring

密钥对名称。

testKeyPairName
SaleCyclestring
说明 该参数已弃用,不再返回有意义的数据。
month
SpotStrategystring

按量实例的竞价策略。可能值:

  • NoSpot:正常按量付费实例。
  • SpotWithPriceLimit:设置上限价格的抢占式实例。
  • SpotAsPriceGo:系统自动出价,最高按量付费价格的抢占式实例。
NoSpot
DeviceAvailableboolean

实例是否可以挂载数据盘。

  • true:可以挂载数据盘。
  • false:不可以挂载数据盘。
true
LocalStorageCapacitylong

实例挂载的本地存储容量。单位:GiB。

1000
Descriptionstring

实例描述。

testDescription
SpotDurationinteger

抢占式实例的保留时长,单位为小时。可能值:

  • 1:创建后阿里云会保证实例运行 1 小时不会被自动释放;超过 1 小时后,系统会自动比较出价与市场价格、检查资源库存,来决定实例的持有和回收。
  • 0:创建后,阿里云不保证实例运行 1 小时,系统会自动比较出价与市场价格、检查资源库存,来决定实例的持有和回收。

实例回收前 5 分钟阿里云会通过 ECS 系统事件向您发送通知。抢占式实例按秒计费,建议您结合具体任务执行耗时来选择合适的保留时长。

说明 当 SpotStrategy 值为 SpotWithPriceLimit 或 SpotAsPriceGo 时返回该参数。
1
InstanceNetworkTypestring

实例网络类型。可能值:

  • classic:经典网络。
  • vpc:专有网络 VPC。
vpc
InstanceNamestring

实例名称。

InstanceNameTest
OSNameEnstring

实例操作系统的英文名称。

CentOS 7.4 64 bit
HpcClusterIdstring

实例所属的 HPC 集群 ID。

hpc-bp67acfmxazb4p****
SpotPriceLimitfloat

实例的每小时最高价格。支持最大 3 位小数,参数 SpotStrategy=SpotWithPriceLimit 时,该参数生效。

0.98
Memoryinteger

内存大小,单位为 MiB。

16384
OSNamestring

实例的操作系统名称。

CentOS 7.4 64 位
DeploymentSetGroupNointeger

ECS 实例绑定部署集分散部署时,实例在部署集中的分组位置。

1
ImageIdstring

实例运行的镜像 ID。

m-bp67acfmxazb4p****
VlanIdstring

实例的 VLAN ID。

说明 该参数即将被弃用,为提高兼容性,请尽量使用其他参数。
10
ClusterIdstring

实例所在的集群 ID。

说明 该参数即将被弃用,为提高兼容性,请尽量使用其他参数。
c-bp67acfmxazb4p****
GPUSpecstring

实例规格附带的 GPU 类型。

NVIDIA V100
AutoReleaseTimestring

按量付费实例的自动释放时间。

2017-12-10T04:04Z
DeletionProtectionboolean

实例释放保护属性,指定是否支持通过控制台或 API(DeleteInstance)释放实例。

  • true:已开启实例释放保护。
  • false:未开启实例释放保护。
说明 该属性仅适用于按量付费实例,且只能限制手动释放操作,对系统释放操作不生效。
false
StoppedModestring

实例停机后是否继续收费。可能值:

  • KeepCharging:停机后继续收费,为您继续保留库存资源。
  • StopCharging:停机后不收费。停机后,我们释放实例对应的资源,例如 vCPU、内存和公网 IP 等资源。重启是否成功依赖于当前地域中是否仍有资源库存。
  • Not-applicable:本实例不支持停机不收费功能。
KeepCharging
GPUAmountinteger

实例规格附带的 GPU 数量。

4
HostNamestring

实例主机名。

testHostName
InstanceIdstring

实例 ID。

i-bp67acfmxazb4p****
InternetMaxBandwidthOutinteger

公网出带宽最大值,单位:Mbit/s。

5
InternetMaxBandwidthIninteger

公网入带宽最大值,单位:Mbit/s。

50
InstanceTypestring

实例规格。

ecs.g5.large
InstanceChargeTypestring

实例的计费方式。可能值:

  • PrePaid:包年包月。
  • PostPaid:按量付费。
PostPaid
RegionIdstring

实例所属地域 ID。

cn-hangzhou
IoOptimizedboolean

是否为 I/O 优化型实例。

  • true:是。
  • false:否。
true
StartTimestring

实例最近一次的启动时间。以 ISO 8601 为标准,并使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mmZ。更多信息,请参见ISO 8601

2017-12-10T04:04Z
Cpuinteger

vCPU 数。

8
LocalStorageAmountinteger

实例挂载的本地存储数量。

2
ExpiredTimestring

过期时间。以 ISO 8601 为标准,并使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mmZ。更多信息,请参见ISO 8601

2017-12-10T04:04Z
ResourceGroupIdstring

实例所属的企业资源组 ID。

rg-bp67acfmxazb4p****
InternetChargeTypestring

网络计费类型。可能值:

  • PayByBandwidth:按固定带宽计费。
  • PayByTraffic:按使用流量计费。
PayByTraffic
ZoneIdstring

实例所属可用区。

cn-hangzhou-g
Recyclableboolean

实例是否可以回收。

false
ISPstring
说明 该参数正在邀测中,暂未开放使用。
null
CreditSpecificationstring

突发性能实例的运行模式。可能值:

  • Standard:标准模式。有关实例性能的更多信息,请参见什么是突发性能实例中的性能约束模式章节。
  • Unlimited:无性能约束模式,有关实例性能的更多信息,请参见什么是突发性能实例中的无性能约束模式章节。
Standard
InstanceTypeFamilystring

实例规格族。

ecs.g5
OSTypestring

实例的操作系统类型,分为 Windows Server 和 Linux 两种。可能值:

  • windows。
  • linux。
linux
NetworkInterfacesobject []

实例包含的弹性网卡集合。

Typestring

弹性网卡类型。可能值:

  • Primary:主网卡。
  • Secondary:辅助弹性网卡。
Primary
MacAddressstring

弹性网卡的 MAC 地址。

00:16:3e:32:b4:**
PrimaryIpAddressstring

弹性网卡主私有 IP 地址。

172.17.**.***
NetworkInterfaceIdstring

弹性网卡的 ID。

eni-2zeh9atclduxvf1z****
PrivateIpSetsobject []

PrivateIpSet 组成的集合。

PrivateIpAddressstring

实例的私网 IP 地址。

172.17.**.**
Primaryboolean

是否是主私网 IP 地址。

  • true:是。
  • false:否。
true
Ipv6Setsobject []

弹性网卡已分配的 IPv6 地址集合。仅当请求参数AdditionalAttributes.N取值为NETWORK_PRIMARY_ENI_IP时,才会返回该参数值。

Ipv6Addressstring

弹性网卡已分配的 IPv6 地址。

2408:4321:180:1701:94c7:bc38:3bfa:***
Ipv4PrefixSetsobject []

弹性网卡已分配的 IPv4 前缀集合。仅当请求参数AdditionalAttributes.N取值为NETWORK_PRIMARY_ENI_IP时,才会返回该参数值。

Ipv4Prefixstring

弹性网卡已分配的 IPv4 前缀。

192.168.*.*/28
Ipv6PrefixSetsobject []

弹性网卡已分配的 IPv6 前缀集合。仅当请求参数AdditionalAttributes.N取值为NETWORK_PRIMARY_ENI_IP时,才会返回该参数值。

Ipv6Prefixstring

弹性网卡已分配的 IPv6 前缀。

2001:1111:*:*::/80
OperationLocksobject []

实例的锁定原因。

LockMsgstring

实例被锁定的描述信息。

The specified instance is locked due to financial reason.
LockReasonstring

锁定类型。可能值:

  • financial:因欠费被锁定。
  • security:因安全原因被锁定。
  • Recycling:抢占式实例的待释放锁定状态。
  • dedicatedhostfinancial:因为专有宿主机欠费导致 ECS 实例被锁定。
  • refunded:因退款被锁定。
Recycling
Tagsobject []

实例的标签集合。

TagValuestring

实例的标签值。

TestValue
TagKeystring

实例的标签键。

TestKey
RdmaIpAddressarray

HPC 实例的 RDMA 网络 IP 列表。

string

HPC 实例的 RDMA 网络 IP。

10.10.10.102
SecurityGroupIdsarray

实例所属安全组 ID 列表。

string

安全组 ID。

sg-bp67acfmxazb4p****
PublicIpAddressarray

实例公网 IP 地址列表。

string

实例公网 IP 地址。

121.40.**.**
InnerIpAddressarray

经典网络类型实例的内网 IP 地址列表。

string

经典网络类型实例的内网 IP 地址。

10.170.**.**
VpcAttributesobject

专有网络 VPC 属性。

VpcIdstring

专有网络 VPC ID。

vpc-2zeuphj08tt7q3brd****
NatIpAddressstring

云产品的 IP,用于 VPC 云产品之间的网络互通。

172.17.**.**
VSwitchIdstring

虚拟交换机 ID。

vsw-2zeh0r1pabwtg6wcs****
PrivateIpAddressarray

私有 IP 地址列表。

string

私有 IP 地址。

172.17.**.**
EipAddressobject

弹性公网 IP 绑定信息。

IsSupportUnassociateboolean

是否可以解绑弹性公网 IP。

true
InternetChargeTypestring

弹性公网 IP 的计费方式。

  • PayByBandwidth:按带宽计费。

  • PayByTraffic:按流量计费。

PayByTraffic
IpAddressstring

弹性公网 IP。

42.112.**.**
Bandwidthinteger

弹性公网 IP 的公网带宽限速,单位为 Mbit/s。

5
AllocationIdstring

弹性公网 IP 的 ID。

eip-2ze88m67qx5z****
HibernationOptionsobject
说明 该参数正在邀测中,暂未开放使用。
Configuredboolean
说明 该参数正在邀测中,暂未开放使用。
false
DedicatedHostAttributeobject

由专有宿主机集群 ID(DedicatedHostClusterId)、专有宿主机 ID(DedicatedHostId)和名称(DedicatedHostName)组成的宿主机属性数组。

DedicatedHostIdstring

专有宿主机 ID。

dh-bp67acfmxazb4p****
DedicatedHostNamestring

专有宿主机名称。

testDedicatedHostName
DedicatedHostClusterIdstring

专有宿主机集群 ID。

dc-bp67acfmxazb4h****
EcsCapacityReservationAttrobject

云服务器 ECS 的容量预留相关参数。

CapacityReservationPreferencestring

容量预留偏好。

cr-bp67acfmxazb4p****
CapacityReservationIdstring

容量预留 ID。

cr-bp67acfmxazb4p****
DedicatedInstanceAttributeobject

专有宿主机实例的属性。

Affinitystring

专有宿主机实例是否与专有宿主机关联。可能值:

  • default:专有宿主机实例不与专有宿主机关联。停机不收费实例重启后,可能会放置在自动资源部署池中的其它专有宿主机上。

  • host:专有宿主机实例与专有宿主机关联。停机不收费实例重启后,仍放置在原专有宿主机上。

default
Tenancystring

实例的宿主机类型是否为专有宿主机。可能值:

  • default:实例的宿主机类型不是专有宿主机。

  • host:实例的宿主机类型为专有宿主机。

default
CpuOptionsobject

CPU 配置详情。

Numastring

分配的线程数。可能值:2。

2
CoreCountinteger

物理 CPU 核心数。

2
ThreadsPerCoreinteger

CPU 线程数。

4
TopologyTypestring

实例的 CPU 拓扑类型。可能值:

  • HT 离散模式:ContinuousCoreToHTMapping
  • HT 连续模式:DiscreteCoreToHTMapping
DiscreteCoreToHTMapping
MetadataOptionsobject

元数据选项集合。

HttpEndpointstring

是否启用实例元数据的访问通道。可能值:

  • enabled:启用。
  • disabled:禁用。
enabled
HttpPutResponseHopLimitinteger
说明 该参数暂未开放使用。
0
HttpTokensstring

访问实例元数据时是否强制使用加固模式(IMDSv2)。可能值:

  • optional:不强制使用。
  • required:强制使用。
optional
ImageOptionsobject

镜像相关属性信息。

LoginAsNonRootboolean

使用该镜像的实例是否支持使用 ecs-user 用户登录。可能值:

  • true:是。

  • false:否。

false
SpotInterruptionBehaviorstring

平台发起抢占式实例中断时,抢占式实例的中断模式。可能值:

  • Terminate:释放。

  • Stop:节省停机。

Terminate

示例

正常返回示例

JSON格式

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "PageSize": 10,
  "PageNumber": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1,
  "Instances": {
    "Instance": [
      {
        "CreationTime": "2017-12-10T04:04Z",
        "SerialNumber": "51d1353b-22bf-4567-a176-8b3e12e4****",
        "Status": "Running",
        "DeploymentSetId": "ds-bp67acfmxazb4p****",
        "KeyPairName": "testKeyPairName",
        "SaleCycle": "month",
        "SpotStrategy": "NoSpot",
        "DeviceAvailable": true,
        "LocalStorageCapacity": 1000,
        "Description": "testDescription",
        "SpotDuration": 1,
        "InstanceNetworkType": "vpc",
        "InstanceName": "InstanceNameTest",
        "OSNameEn": "CentOS  7.4 64 bit",
        "HpcClusterId": "hpc-bp67acfmxazb4p****",
        "SpotPriceLimit": 0.98,
        "Memory": 16384,
        "OSName": "CentOS  7.4 64 位",
        "DeploymentSetGroupNo": 1,
        "ImageId": "m-bp67acfmxazb4p****",
        "VlanId": "10",
        "ClusterId": "c-bp67acfmxazb4p****",
        "GPUSpec": "NVIDIA V100",
        "AutoReleaseTime": "2017-12-10T04:04Z",
        "DeletionProtection": false,
        "StoppedMode": "KeepCharging",
        "GPUAmount": 4,
        "HostName": "testHostName",
        "InstanceId": "i-bp67acfmxazb4p****",
        "InternetMaxBandwidthOut": 5,
        "InternetMaxBandwidthIn": 50,
        "InstanceType": "ecs.g5.large",
        "InstanceChargeType": "PostPaid",
        "RegionId": "cn-hangzhou",
        "IoOptimized": true,
        "StartTime": "2017-12-10T04:04Z",
        "Cpu": 8,
        "LocalStorageAmount": 2,
        "ExpiredTime": "2017-12-10T04:04Z",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "InternetChargeType": "PayByTraffic",
        "ZoneId": "cn-hangzhou-g",
        "Recyclable": false,
        "ISP": "null",
        "CreditSpecification": "Standard",
        "InstanceTypeFamily": "ecs.g5",
        "OSType": "linux",
        "NetworkInterfaces": {
          "NetworkInterface": [
            {
              "Type": "Primary",
              "MacAddress": "00:16:3e:32:b4:**",
              "PrimaryIpAddress": "172.17.**.***",
              "NetworkInterfaceId": "eni-2zeh9atclduxvf1z****",
              "PrivateIpSets": {
                "PrivateIpSet": [
                  {
                    "PrivateIpAddress": "172.17.**.**",
                    "Primary": true
                  }
                ]
              },
              "Ipv6Sets": {
                "Ipv6Set": [
                  {
                    "Ipv6Address": "2408:4321:180:1701:94c7:bc38:3bfa:***"
                  }
                ]
              },
              "Ipv4PrefixSets": {
                "Ipv4PrefixSet": [
                  {
                    "Ipv4Prefix": "192.168.*.*/28"
                  }
                ]
              },
              "Ipv6PrefixSets": {
                "Ipv6PrefixSet": [
                  {
                    "Ipv6Prefix": "2001:1111:*:*::/80"
                  }
                ]
              }
            }
          ]
        },
        "OperationLocks": {
          "LockReason": [
            {
              "LockMsg": "The specified instance is locked due to financial reason.",
              "LockReason": "Recycling"
            }
          ]
        },
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "RdmaIpAddress": {
          "IpAddress": [
            "10.10.10.102"
          ]
        },
        "SecurityGroupIds": {
          "SecurityGroupId": [
            "sg-bp67acfmxazb4p****"
          ]
        },
        "PublicIpAddress": {
          "IpAddress": [
            "121.40.**.**"
          ]
        },
        "InnerIpAddress": {
          "IpAddress": [
            "10.170.**.**"
          ]
        },
        "VpcAttributes": {
          "VpcId": "vpc-2zeuphj08tt7q3brd****",
          "NatIpAddress": "172.17.**.**",
          "VSwitchId": "vsw-2zeh0r1pabwtg6wcs****",
          "PrivateIpAddress": {
            "IpAddress": [
              "172.17.**.**"
            ]
          }
        },
        "EipAddress": {
          "IsSupportUnassociate": true,
          "InternetChargeType": "PayByTraffic",
          "IpAddress": "42.112.**.**",
          "Bandwidth": 5,
          "AllocationId": "eip-2ze88m67qx5z****"
        },
        "HibernationOptions": {
          "Configured": false
        },
        "DedicatedHostAttribute": {
          "DedicatedHostId": "dh-bp67acfmxazb4p****",
          "DedicatedHostName": "testDedicatedHostName",
          "DedicatedHostClusterId": "dc-bp67acfmxazb4h****"
        },
        "EcsCapacityReservationAttr": {
          "CapacityReservationPreference": "cr-bp67acfmxazb4p****",
          "CapacityReservationId": "cr-bp67acfmxazb4p****"
        },
        "DedicatedInstanceAttribute": {
          "Affinity": "default",
          "Tenancy": "default"
        },
        "CpuOptions": {
          "Numa": "2",
          "CoreCount": 2,
          "ThreadsPerCore": 4,
          "TopologyType": "DiscreteCoreToHTMapping"
        },
        "MetadataOptions": {
          "HttpEndpoint": "enabled",
          "HttpPutResponseHopLimit": 0,
          "HttpTokens": "optional"
        },
        "ImageOptions": {
          "LoginAsNonRoot": false
        },
        "SpotInterruptionBehavior": "Terminate"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidTag.MismatchThe specified Tag.n.Key and Tag.n.Value are not match.指定的 Tag.N.Key 和 Tag.N.Value 不匹配。
400InvalidTagCountThe specified tags are beyond the permitted range.指定的标记超出取值范围。
400InvalidHpcClusterId.NotFoundThe specified HpcClusterId is not found.指定的参数 HpcClusterId 不存在。
400InvalidHpcClusterId.CreatingThe specified HpcClusterId is creating.指定的 HPC 集群正在创建中。
400InternalErrorThe request processing has failed due to some unknown error, exception or failure.内部错误,请重试。
404InvalidInstanceChargeType.NotFoundThe InstanceChargeType does not exist in our records.指定的实例计费方式不存在。
404InvalidInternetChargeType.ValueNotSupportedThe specified InternetChargeType is not valid.暂不支持指定的网络付费类型的实例,请确认相关参数是否正确。
404InvalidLockReason.NotFoundThe specified LockReason is not found.所指定的锁定原因不存在
404InvalidFilterKey.NotFoundInvalid filter.%s.-
404InvalidFilterValueInvalid filter.%s.-
404InvalidNetworkType.NotFoundThe specified InstanceNetworkType is not found.-
404InvalidStatus.NotFoundThe specified Status is not found.指定的资源状态不存在。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-12-14OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
出参OpenAPI 返回结构发生变更
2023-12-11OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
出参OpenAPI 返回结构发生变更
2021-12-13OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
出参OpenAPI 返回结构发生变更
2021-05-20OpenAPI 去除了 deprecated 标记、OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
API 弃用说明(deprecated)OpenAPI 去除了 deprecated 标记
错误码OpenAPI 错误码发生变更
    错误码 404 变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:Ipv6Address
  • 本页导读 (1)
文档反馈