查詢輕量型主機詳細信息
更新時間 2024-12-13 18:35:37
最近更新時間: 2024-12-13 18:35:37
分享文章
查詢輕量型主機詳細信息
接口功能介紹
該接口提供用戶輕量型云主機信息查詢功能,用戶可以根據此接口的返回值了解自己輕量型云主機的詳細信息。
URI
GET /v4/ecs/lite/details
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID,您可以調用查看最新的天翼云資源池列表 | 888888c8888888e8a8888888ac888888 | |
| instanceID | 是 | String | 云主機ID | 88f888ea-88ff-88ec-a8bc-888888888fe8 |
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼(800為成功,900為失敗) | 800 | |
| errorCode | String | 業務細分碼,為product.module.code三段式碼,詳見錯誤碼說明 | Openapi.PatternCheck.NotValid | |
| message | String | 失敗時的錯誤描述,一般為英文描述 | SUCCESS | |
| description | String | 失敗時的錯誤描述,一般為中文描述 | 成功 | |
| returnObj | Object | 成功時返回的數據 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| resourceID | String | 云主機資源ID | f88bc88a88a888e8a88bf88888888888 | |
| instanceID | String | 云主機ID | 88f888ea-88ff-88ec-a8bc-888888888fe8 | |
| displayName | String | 云主機顯示名稱 | ecs-8888 | |
| instanceName | String | 云主機名稱 | ecs-8888 | |
| osType | Integer | 操作系統類型,取值范圍:1: linux,2: windows,3: redhat,4: ubuntu,5: centos,6: oracle | 5 | |
| instanceStatus | String | 云主機狀態,取值范圍:backingup: 備份中,creating: 創建中,expired: 已到期,freezing: 凍結中,rebuild: 重裝,restarting: 重啟中,running: 運行中,starting: 開機中,stopped: 已關機,stopping: 關機中,error: 錯誤,snapshotting: 快照創建中 | running | |
| expiredTime | String | 到期時間 | 2023-04-19T09:37:53Z | |
| updatedTime | String | 更新時間 | 2022-10-19T09:37:53Z | |
| createdTime | String | 創建時間 | 2022-10-19T09:37:53Z | |
| attachedVolume | Array of Strings | 附加卷 | ["8e8f8bc8-b8ad-8a8e-8e88-88cd88888e88"] | |
| addresses | Object | 網絡地址信息 | addresses | |
| secGroupList | Array of Objects | 安全組信息 | securityGroup | |
| networkCardList | Array of Objects | 網卡信息 | networkCard | |
| image | Object | 鏡像信息 | image | |
| flavor | Object | 規格信息 | flavor | |
| vpcID | String | vpc ID | b1a5ff70-cdd1-4295-8a17-07b7e53c5759 | |
| vpcName | String | vpc名稱 | liteecs_network | |
| zabbixName | String | 監控對象名稱 | 8a8fdc88-b8a8-88bb-888f-8b88888c88f8 | |
| bandwidth | Integer | 帶寬 | 2 | |
| bootDiskSize | Integer | 系統盤大小 | 40 |
表 addresses
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| addressList | Array of Objects | 網絡地址列表 | addressList |
表 securityGroup
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| securityGroupID | String | 安全組ID | c6e1d96a-cff8-45c0-97db-91fca62b5f26 | |
| securityGroupName | String | 安全組名稱 | VM-79ab13b6 |
表 networkCard
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| IPv4Address | String | IPv4地址 | 10.0.0.1 | |
| subnetID | String | 所處的子網ID | f24f5695-6eaa-4ff9-b986-fb8f33a7fad4 |
表 image
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| imageID | String | 鏡像ID | b88888b8-ff88-8888-b88f-8c8fbc888b88 | |
| imageName | String | 鏡像名稱 | CentOS7.5.v1-20210303 |
表 flavor
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| flavorID | String | 規格ID | 8f8ba888-88e8-ea88-ea8b-888888dded88 | |
| flavorName | String | 規格名稱 | s7.medium.2 | |
| flavorCPU | Integer | VCPU | 1 | |
| flavorRAM | Integer | 內存 | 2048 |
表 addressList
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| addr | String | 地址 | 192.168.0.62 | |
| version | Integer | IP版本 | 4 | |
| type | String | 網絡類型 | fixed |
請求示例
GET .../v4/ecs/lite/details?regionID=41f64827f25f468595ffa3a5deb5d15d&instanceID=7a9acf36-ed22-49e4-8ca2-a9ab6021e8a2
請求頭header
無
請求體body
無
響應示例
{
"returnObj": {
"instanceStatus": "running",
"secGroupList": [{
"securityGroupID": "c6e1d96a-cff8-45c0-97db-91fca62b5f26",
"securityGroupName": "VM-79ab13b6"
}],
"vpcID": "b1a5ff70-cdd1-4295-8a17-07b7e53c5759",
"displayName": "LiteECS-cafd",
"addresses": {
"addressList": [{
"version": 4,
"type": "fixed",
"addr": "172.31.1.8"
}, {
"version": 4,
"type": "floating",
"addr": "100.127.12.88"
}]
},
"updatedTime": "2023-07-07T09:45:12Z",
"instanceID": "7a9acf36-ed22-49e4-8ca2-a9ab6021e8a2",
"resourceID": "ad2ba3d200e54e00850f7f7f9f35205c",
"image": {
"imageName": "CentOS7.6.v1-20020301",
"imageID": "dca942b0-e934-4bd5-b5c1-4f5e1aad56a6"
},
"vpcName": "liteecs_network",
"createdTime": "2023-07-03T06:47:04Z",
"bandwidth": 10,
"expiredTime": "2023-10-03T06:47:04Z",
"bootDiskSize": 80,
"zabbixName": "7a9acf36-ed22-49e4-8ca2-a9ab6021e8a2",
"osType": 5,
"attachedVolume": ["3163fc5e-70ed-4341-8d68-ffd3b3d48379"],
"flavor": {
"flavorCPU": 4,
"flavorID": "6c76c383-586c-4302-aeff-2f891734e8e4",
"flavorRAM": 8192,
"flavorName": "lite1.band.xlarge.2"
},
"networkCardList": [{
"subnetID": "f24f5695-6eaa-4ff9-b986-fb8f33a7fad4",
"IPv4Address": "172.31.1.8"
}],
"instanceName": "VM-79ab13b6"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 表示請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Openapi.PatternCheck.NotValid | 請求參數無效 |
| LiteEcs.RegionInfo.Empty | 查詢資源池信息為空或資源池不存在,請確認資源池ID是否有效 |
| LiteEcs.RegionInfo.AccessFailed | 查詢資源池失敗,請重試。如果多次嘗試失敗,請提交工單 |
| LiteEcs.RegionInfo.DataDamaged | 查詢資源池信息不符預期,請重試。如果多次嘗試失敗,請提交工單 |
| LiteEcs.RegionVersion.NotSupport | 當前API不支持該資源池,請切換資源池重試 |
| Openapi.EcsWorkorder.AccessFailed | 查詢云主機失敗,請重試。如果多次嘗試失敗,請提交工單 |
| LiteEcs.Instance.NotFound | 云主機不存在,請確認云主機ID是否有效 |
| Openapi.EcsFormat.FormatError | 查詢云主機信息格式錯誤,請重試。如果多次嘗試失敗,請提交工單 |