全部产品
Search
文档中心

云服务器 ECS:DescribeInstanceAttribute

更新时间:Oct 16, 2023

调用DescribeInstanceAttribute查询单个ECS实例详情。

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String DescribeInstanceAttribute

系统规定参数。取值:DescribeInstanceAttribute

InstanceId String i-uf6f5trc95ug8t33****

指定实例的ID。

返回数据

名称

类型

示例值

描述

Status String Running

实例状态。取值范围:

  • Pending:创建中。
  • Running:运行中。
  • Starting:启动中。
  • Stopping:停止中。
  • Stopped:已停止。
SerialNumber String 51d1353b-22bf-4567-a176-8b3e12e4****

实例序列号。

CreationTime String 2017-12-10T04:04Z

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

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

请求ID。

Description String testDescription

实例描述。

InstanceName String testInstanceName

实例名称。

InstanceNetworkType String vpc

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

  • classic:经典网络。
  • vpc:专有网络VPC。
Memory Integer 16384

内存大小,单位为MiB。

ImageId String m-bp1h46wfpjsjastc****

实例运行的镜像ID。

ClusterId String cls-bp67acfmxazb4p****

实例所在的集群ID。

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

实例的VLAN ID。

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

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

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

实例主机名。

InstanceId String i-uf6f5trc95ug8t33****

实例ID。

InstanceType String ecs.g5.large

实例的规格。

InternetMaxBandwidthIn Integer 50

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

InternetMaxBandwidthOut Integer 5

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

RegionId String cn-hangzhou

实例所属地域ID。

InstanceChargeType String PrePaid

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

  • PrePaid:包年包月。
  • PostPaid:按量付费。
IoOptimized String true

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

Cpu Integer 8

vCPU处理器核心数量。

ExpiredTime String 2017-12-10T04:04Z

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

ZoneId String cn-hangzhou-g

实例所属可用区。

InternetChargeType String PayByTraffic

公网带宽计费方式。可能值:

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

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

  • Standard:标准模式。有关实例性能的更多信息,请参见性能模式
  • Unlimited:无性能约束模式,有关实例性能的更多信息,请参见性能模式
SecurityGroupIds Array of String sg-bp1fg655nh68xyz9i****

实例所属安全组集合。

PublicIpAddress Array of String 121.40.**.**

实例公网IP地址。

InnerIpAddress Array of String 192.168.**.**

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

VpcAttributes Object

专有网络VPC属性。

VpcId String vpc-wz9e4e9pmbcnj6ki6****

专有网络VPC ID。

NatIpAddress String 172.17.**.**

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

VSwitchId String vsw-uf6ixacqz8osrwnqb****

虚拟交换机ID。

PrivateIpAddress Array of String 192.168.**.**

私有IP地址。

EipAddress Object

弹性公网IP绑定信息。

InternetChargeType String PayByTraffic

公网带宽计费方式。可能值:

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

弹性公网IP。

Bandwidth Integer 8

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

AllocationId String eip-wz9uilio26dfscamm****

弹性公网IP的ID。

DedicatedHostAttribute Object

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

DedicatedHostName String ecs-autoui-create-ddh-temp

专有宿主机的名称。

DedicatedHostId String dh-2ze7qrzz6lvbfhr0****

专有宿主机ID。

OperationLocks Array of LockReason

锁定类型。可能值:

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

锁定类型。可能值:

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

ECS实例是否开启了Jumbo frame特性。 可能值:

  • true:开启。
  • false:不开启。

更多信息,请参见ECS实例MTU

示例

请求示例

https://ecs.aliyuncs.com/?Action=DescribeInstanceAttribute
&InstanceId=i-uf6f5trc95ug8t33****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeInstanceAttributeResponse>
    <Status>Running</Status>
    <SerialNumber>51d1353b-22bf-4567-a176-8b3e12e4****</SerialNumber>
    <CreationTime>2017-12-10T04:04Z</CreationTime>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
    <Description>testDescription</Description>
    <InstanceName>testInstanceName</InstanceName>
    <InstanceNetworkType>vpc</InstanceNetworkType>
    <Memory>16384</Memory>
    <ImageId>m-bp1h46wfpjsjastc****</ImageId>
    <ClusterId>cls-bp67acfmxazb4p****</ClusterId>
    <VlanId>10</VlanId>
    <StoppedMode>KeepCharging</StoppedMode>
    <HostName>testHostName</HostName>
    <InstanceId>i-uf6f5trc95ug8t33****</InstanceId>
    <InstanceType>ecs.g5.large</InstanceType>
    <InternetMaxBandwidthIn>50</InternetMaxBandwidthIn>
    <InternetMaxBandwidthOut>5</InternetMaxBandwidthOut>
    <RegionId>cn-hangzhou</RegionId>
    <InstanceChargeType>PrePaid</InstanceChargeType>
    <IoOptimized>true</IoOptimized>
    <Cpu>8</Cpu>
    <ExpiredTime>2017-12-10T04:04Z</ExpiredTime>
    <ZoneId>cn-hangzhou-g</ZoneId>
    <InternetChargeType>PayByTraffic</InternetChargeType>
    <CreditSpecification>Standard</CreditSpecification>
    <SecurityGroupIds>sg-bp1fg655nh68xyz9i****</SecurityGroupIds>
    <PublicIpAddress>121.40.**.**</PublicIpAddress>
    <InnerIpAddress>192.168.**.**</InnerIpAddress>
    <VpcAttributes>
        <VpcId>vpc-wz9e4e9pmbcnj6ki6****</VpcId>
        <NatIpAddress>172.17.**.**</NatIpAddress>
        <VSwitchId>vsw-uf6ixacqz8osrwnqb****</VSwitchId>
        <PrivateIpAddress>192.168.**.**</PrivateIpAddress>
    </VpcAttributes>
    <EipAddress>
        <InternetChargeType>PayByTraffic</InternetChargeType>
        <IpAddress>30.21.**.**</IpAddress>
        <Bandwidth>8</Bandwidth>
        <AllocationId>eip-wz9uilio26dfscamm****</AllocationId>
    </EipAddress>
    <DedicatedHostAttribute>
        <DedicatedHostName>ecs-autoui-create-ddh-temp</DedicatedHostName>
        <DedicatedHostId>dh-2ze7qrzz6lvbfhr0****</DedicatedHostId>
    </DedicatedHostAttribute>
    <OperationLocks>
        <LockReason>financial</LockReason>
    </OperationLocks>
    <EnableJumboFrame>false</EnableJumboFrame>
</DescribeInstanceAttributeResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Status" : "Running",
  "SerialNumber" : "51d1353b-22bf-4567-a176-8b3e12e4****",
  "CreationTime" : "2017-12-10T04:04Z",
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "Description" : "testDescription",
  "InstanceName" : "testInstanceName",
  "InstanceNetworkType" : "vpc",
  "Memory" : 16384,
  "ImageId" : "m-bp1h46wfpjsjastc****",
  "ClusterId" : "cls-bp67acfmxazb4p****",
  "VlanId" : "10",
  "StoppedMode" : "KeepCharging",
  "HostName" : "testHostName",
  "InstanceId" : "i-uf6f5trc95ug8t33****",
  "InstanceType" : "ecs.g5.large",
  "InternetMaxBandwidthIn" : 50,
  "InternetMaxBandwidthOut" : 5,
  "RegionId" : "cn-hangzhou",
  "InstanceChargeType" : "PrePaid",
  "IoOptimized" : "true",
  "Cpu" : 8,
  "ExpiredTime" : "2017-12-10T04:04Z",
  "ZoneId" : "cn-hangzhou-g",
  "InternetChargeType" : "PayByTraffic",
  "CreditSpecification" : "Standard",
  "SecurityGroupIds" : [ "sg-bp1fg655nh68xyz9i****" ],
  "PublicIpAddress" : [ "121.40.**.**" ],
  "InnerIpAddress" : [ "192.168.**.**" ],
  "VpcAttributes" : {
    "VpcId" : "vpc-wz9e4e9pmbcnj6ki6****",
    "NatIpAddress" : "172.17.**.**",
    "VSwitchId" : "vsw-uf6ixacqz8osrwnqb****",
    "PrivateIpAddress" : [ "192.168.**.**" ]
  },
  "EipAddress" : {
    "InternetChargeType" : "PayByTraffic",
    "IpAddress" : "30.21.**.**",
    "Bandwidth" : 8,
    "AllocationId" : "eip-wz9uilio26dfscamm****"
  },
  "DedicatedHostAttribute" : {
    "DedicatedHostName" : "ecs-autoui-create-ddh-temp",
    "DedicatedHostId" : "dh-2ze7qrzz6lvbfhr0****"
  },
  "OperationLocks" : [ {
    "LockReason" : "financial"
  } ],
  "EnableJumboFrame" : false
}

错误码

HttpCode

错误码

错误信息

描述

404 InvalidInstanceId.NotFound The specified InstanceId does not exist. 指定的实例不存在,请您检查实例ID是否正确。
500 InternalError The request processing has failed due to some unknown error. 内部错误,请重试。

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