本介面用於查詢一台指定 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. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。