本接口用于查询一台指定ECS实例的属性信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ecs:DescribeInstanceAttribute |
get |
*Instance
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
指定实例的 ID。 |
i-uf6f5trc95ug8t33**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Status |
string |
实例状态。取值范围:
|
Running |
| SerialNumber |
string |
实例序列号。 |
51d1353b-22bf-4567-a176-8b3e12e4**** |
| CreationTime |
string |
实例创建时间。以 ISO 8601 为标准,并使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mmZ。更多信息,请参见ISO 8601。 |
2017-12-10T04:04Z |
| RequestId |
string |
请求 ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
| Description |
string |
实例描述。 |
testDescription |
| InstanceName |
string |
实例名称。 |
testInstanceName |
| InstanceNetworkType |
string |
实例网络类型。取值范围:
|
vpc |
| Memory |
integer |
内存大小,单位为 MiB。 |
16384 |
| ImageId |
string |
实例运行的镜像 ID。 |
m-bp1h46wfpjsjastc**** |
| ClusterId |
string |
实例所在的集群 ID。 说明
该参数即将被弃用,为提高兼容性,请尽量使用其他参数。 |
cls-bp67acfmxazb4p**** |
| VlanId |
string |
实例的 VLAN ID。 说明
该参数即将被弃用,为提高兼容性,请尽量使用其他参数。 |
10 |
| StoppedMode |
string |
实例停机后是否继续收费。可能值:
|
KeepCharging |
| HostName |
string |
实例主机名。 |
testHostName |
| InstanceId |
string |
实例 ID。 |
i-uf6f5trc95ug8t33**** |
| InstanceType |
string |
实例的规格。 |
ecs.g5.large |
| InternetMaxBandwidthIn |
integer |
公网入带宽最大值,单位为 Mbit/s。 |
50 |
| InternetMaxBandwidthOut |
integer |
公网出带宽最大值,单位为 Mbit/s。 |
5 |
| RegionId |
string |
实例所属地域 ID。 |
cn-hangzhou |
| InstanceChargeType |
string |
实例的计费方式。可能值:
|
PrePaid |
| IoOptimized |
string |
是否是 I/O 优化型实例。可能值:
|
optimized |
| Cpu |
integer |
vCPU 处理器核心数量。 |
8 |
| ExpiredTime |
string |
过期时间。以 ISO 8601 为标准,并使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mmZ。更多信息,请参见ISO 8601。 |
2017-12-10T04:04Z |
| ZoneId |
string |
实例所属可用区。 |
cn-hangzhou-g |
| InternetChargeType |
string |
公网带宽计费方式。可能值:
说明
按使用流量计费模式下的出入带宽峰值都是带宽上限,不作为业务承诺指标。当出现资源争抢时,带宽峰值可能会受到限制。如果您的业务需要有带宽的保障,请使用按固定带宽计费模式。 |
PayByTraffic |
| CreditSpecification |
string |
突发性能实例的运行模式。可能值: |
Standard |
| SecurityGroupIds |
object |
||
| SecurityGroupId |
array |
实例所属安全组集合。 |
|
|
string |
实例所属安全组。 |
sg-bp1fg655nh68xyz9i**** |
|
| PublicIpAddress |
object |
||
| IpAddress |
array |
实例公网 IP 地址列表。 |
|
|
string |
实例公网 IP 地址。 |
121.40.**.** |
|
| InnerIpAddress |
object |
||
| IpAddress |
array |
经典网络类型实例的内网 IP 地址列表。 说明
经典网络功能已下线,详情请参见下线公告。 |
|
|
string |
经典网络类型实例的内网 IP 地址。 |
192.168.**.** |
|
| VpcAttributes |
object |
专有网络 VPC 属性。 |
|
| VpcId |
string |
专有网络 VPC ID。 |
vpc-wz9e4e9pmbcnj6ki6**** |
| NatIpAddress |
string |
云产品的 IP,用于 VPC 云产品之间的网络互通。 |
172.17.**.** |
| VSwitchId |
string |
虚拟交换机 ID。 |
vsw-uf6ixacqz8osrwnqb**** |
| PrivateIpAddress |
object |
||
| IpAddress |
array |
私有 IP 地址列表。 |
|
|
string |
私有 IP 地址。 |
192.168.**.** |
|
| EipAddress |
object |
弹性公网 IP 绑定信息。 |
|
| InternetChargeType |
string |
公网带宽计费方式。可能值:
说明
按使用流量计费模式下的出入带宽峰值都是带宽上限,不作为业务承诺指标。当出现资源争抢时,带宽峰值可能会受到限制。如果您的业务需要有带宽的保障,请使用按固定带宽计费模式。 |
PayByTraffic |
| IpAddress |
string |
弹性公网 IP。 |
30.21.**.** |
| Bandwidth |
integer |
弹性公网 IP 的公网带宽限速,单位为 Mbit/s。 |
8 |
| AllocationId |
string |
弹性公网 IP 的 ID。 |
eip-wz9uilio26dfscamm**** |
| DedicatedHostAttribute |
object |
由专有宿主机集群 ID(DedicatedHostClusterId)、专有宿主机 ID(DedicatedHostId)和名称(DedicatedHostName)组成的宿主机属性数组。 |
|
| DedicatedHostName |
string |
专有宿主机的名称。 |
ecs-autoui-create-ddh-temp |
| DedicatedHostId |
string |
专有宿主机 ID。 |
dh-2ze7qrzz6lvbfhr0**** |
| OperationLocks |
object |
||
| LockReason |
array<object> |
锁定原因列表。 |
|
|
object |
锁定原因。 |
||
| LockReason |
string |
锁定原因。可能值:
|
financial |
| EnableJumboFrame |
boolean |
ECS 实例是否开启了 Jumbo frame 特性。 可能值:
更多信息,请参见ECS 实例 MTU。 |
false |
| EnableNetworkEncryption |
boolean |
实例是否开启 VPC 网络流量加密,可能值:
说明
该参数正在邀测中,暂未开放使用。 |
True |
| NetworkOptions |
object |
网络相关属性参数。 说明
该参数正在邀测中,暂未开放使用。 |
|
| EnableJumboFrame |
boolean |
实例是否开启了 Jumbo frame 特性。 可能值:
更多信息,请参见ECS 实例 MTU。 说明
该参数正在邀测中,暂未开放使用。 |
false |
| EnableNetworkEncryption |
boolean |
实例是否开启 VPC 网络流量加密,可能值:
说明
该参数正在邀测中,暂未开放使用。 |
False |
| BandwidthWeighting |
string |
带宽权重。 不同规格支持设置的值不一样,您可以通过 DescribeInstanceTypes 查询当前实例规格支持的带宽权重值。 枚举值:
|
Vpc-L1 |
示例
正常返回示例
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": "optimized",
"Cpu": 8,
"ExpiredTime": "2017-12-10T04:04Z",
"ZoneId": "cn-hangzhou-g",
"InternetChargeType": "PayByTraffic",
"CreditSpecification": "Standard",
"SecurityGroupIds": {
"SecurityGroupId": [
"sg-bp1fg655nh68xyz9i****"
]
},
"PublicIpAddress": {
"IpAddress": [
"121.40.**.**"
]
},
"InnerIpAddress": {
"IpAddress": [
"192.168.**.**"
]
},
"VpcAttributes": {
"VpcId": "vpc-wz9e4e9pmbcnj6ki6****",
"NatIpAddress": "172.17.**.**",
"VSwitchId": "vsw-uf6ixacqz8osrwnqb****",
"PrivateIpAddress": {
"IpAddress": [
"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": [
{
"LockReason": "financial"
}
]
},
"EnableJumboFrame": false,
"EnableNetworkEncryption": true,
"NetworkOptions": {
"EnableJumboFrame": false,
"EnableNetworkEncryption": true,
"BandwidthWeighting": "Vpc-L1"
}
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 500 | InternalError | The request processing has failed due to some unknown error. | |
| 404 | InvalidInstanceId.NotFound | The specified InstanceId does not exist. | 指定的实例ID无效。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。