查詢一塊或多塊已建立的區塊儲存(包括雲端硬碟、本機磁碟以及彈性臨時磁碟)資訊。
介面說明
-
請求參數
RegionId、ZoneId、DiskIds和InstanceId等都是篩選器的概念,參數間是邏輯與(AND)關係。 -
請求參數
DiskIds是一個 JSON 格式的陣列(Array),如果參數為空,則篩選器不起作用,但是DiskIds如果是一個空陣列,則視為該篩選器有效,且傳回空。 -
支援 Token 分頁查詢:透過
NextToken設定查詢憑證(Token),其取值是上一次呼叫 DescribeDisks 傳回的NextToken參數值,再透過MaxResults設定單頁查詢的最大條目數。 -
開啟多重掛載特性的雲端硬碟可以掛載到多個執行個體上,您可以根據傳回結果的
Attachment列表查看雲端硬碟涉及的所有掛載資訊。
透過阿里雲 CLI 呼叫 API 時,不同資料類型的請求參數取值必須遵循格式要求。更多資訊,請參見 CLI 參數格式說明。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
ecs:DescribeDisks |
list |
Disk
Disk
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
是 |
區塊儲存所屬的地域 ID。您可以呼叫 DescribeRegions 查看最新的阿里雲地域列表。 |
cn-hangzhou |
| ZoneId |
string |
否 |
可用區 ID。 |
cn-hangzhou-g |
| DiskIds |
string |
否 |
雲端硬碟、本機磁碟或彈性臨時磁碟 ID。一個帶有格式的 JSON 陣列,最多支援 100 個 ID,用半形逗號(,)隔開。 |
["d-bp67acfmxazb4p****", "d-bp67acfmxazb4g****", … "d-bp67acfmxazb4d****"] |
| InstanceId |
string |
否 |
雲端硬碟、本機磁碟或彈性臨時磁碟掛載的執行個體 ID。 |
i-bp67acfmxazb4q**** |
| DiskType |
string |
否 |
要查詢的雲端硬碟、本機磁碟或彈性臨時磁碟類型。取值範圍:
預設值:all。 說明
彈性臨時磁碟不支援作為系統磁碟。 |
all |
| Category |
string |
否 |
磁碟種類。取值範圍:
預設值:all。 |
all |
| Status |
string |
否 |
磁碟狀態。更多資訊,請參見雲端硬碟狀態。取值範圍:
預設值:All。 |
All |
| SnapshotId |
string |
否 |
建立雲端硬碟時使用的快照 ID。 |
s-bp67acfmxazb4p**** |
| Portable |
boolean |
否 |
磁碟是否支援卸載。取值範圍:
以下類型區塊儲存的
|
false |
| DeleteWithInstance |
boolean |
否 |
磁碟是否設定了隨執行個體釋放。取值範圍:
預設值:false。 |
false |
| DeleteAutoSnapshot |
boolean |
否 |
釋放雲端硬碟時,是否會同時釋放自動快照。
預設值:false。 |
false |
| PageNumber |
integer |
否 |
說明
該參數即將下線,推薦您使用參數 |
1 |
| PageSize |
integer |
否 |
說明
該參數即將下線,推薦您使用參數 |
10 |
| NextToken |
string |
否 |
查詢憑證(Token),取值為上一次呼叫 API 傳回的 有關本介面查看傳回資料的設定方式,請參見上文介面說明部分。 |
AAAAAdDWBF2**** |
| MaxResults |
integer |
否 |
傳回的最大數。取值範圍:10~500。 預設值:
|
50 |
| DiskName |
string |
否 |
磁碟的名稱。長度為 2~128 個字元,支援 Unicode 中 letter 分類下的字元(其中包括英文、中文和數字等)。可以包含半形冒號(:)、底線(_)、半形句號(.)或者短劃線(-)。 |
testDiskName |
| AutoSnapshotPolicyId |
string |
否 |
根據自動快照策略 ID 查詢雲端硬碟。 |
sp-m5e2w2jutw8bv31**** |
| EnableAutoSnapshot |
boolean |
否 |
雲端硬碟是否啟用自動快照策略功能。
說明
該參數已棄用。建立後的雲端硬碟預設啟用自動快照策略功能,您只需要為雲端硬碟繫結自動快照策略即可正常使用。 |
true |
| EnableAutomatedSnapshotPolicy |
boolean |
否 |
雲端硬碟是否設定了自動快照策略。
預設值:false。 |
false |
| DiskChargeType |
string |
否 |
磁碟的計費方式。取值範圍:
|
PostPaid |
| LockReason |
string |
否 |
磁碟被鎖定的原因。取值範圍:
|
security |
| Filter.1.Key |
string |
否 |
查询资源时的筛选键,取值必须为 |
CreationStartTime |
| Filter.2.Key |
string |
否 |
查询资源时的筛选键,取值必须为 |
CreationEndTime |
| Filter.1.Value |
string |
否 |
查询资源时的筛选值。指定该参数时必须同时指定 |
2017-12-05T22:40Z |
| Filter.2.Value |
string |
否 |
查询资源时的筛选值。指定该参数时必须同时指定 |
2017-12-06T22:40Z |
| ResourceGroupId |
string |
否 |
磁碟所在的企業資源群組 ID。使用該參數篩選資源時,資源數量不能超過 1000 個。 說明
不支援預設資源群組篩選。 |
rg-bp67acfmxazb4p**** |
| EnableShared |
boolean |
否 |
是否是共用區塊儲存。 |
false |
| Encrypted |
boolean |
否 |
是否只篩選出加密雲端硬碟。
預設值:false。 |
false |
| DryRun |
boolean |
否 |
是否只預檢此次請求。取值範圍:
預設值:false。 |
false |
| KMSKeyId |
string |
否 |
雲端硬碟使用的 KMS 密鑰 ID。 |
0e478b7a-4262-4802-b8cb-00d3fb40**** |
| MultiAttach |
string |
否 |
是否開啟了多重掛載特性。取值範圍:
|
Disabled |
| Tag |
array<object> |
否 |
磁碟標籤列表。 |
|
|
object |
否 |
磁碟標籤。 |
||
| key |
string |
否 |
磁碟的標籤鍵。 說明
為提高程式碼相容性,請盡量使用 Tag.N.Key 參數。 |
null |
| Key |
string |
否 |
磁碟的標籤鍵。N 的取值範圍:1~20。 使用一個標籤篩選資源,查詢到該標籤下的資源數量不能超過 1000 個;使用多個標籤篩選資源,查詢到同時繫結了多個標籤的資源數量不能超過 1000 個。如果資源數量超過 1000 個,請使用 ListTagResources 介面進行查詢。 |
TestKey |
| Value |
string |
否 |
磁碟的標籤值。N 的取值範圍:1~20。 |
TestValue |
| value |
string |
否 |
磁碟的標籤值。 說明
為提高程式碼相容性,請盡量使用 Tag.N.Value 參數。 |
null |
| AdditionalAttributes |
array |
否 |
其他屬性值列表。目前僅支援傳入值為 說明
目前僅同城冗餘類型的磁碟有資料存放地。 |
IOPS |
|
string |
否 |
其他屬性值。目前僅支援傳入值為 Placement,表示查詢當前磁碟的資料存放地。 |
Placement |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| NextToken |
string |
本次呼叫傳回的查詢憑證值。 |
AAAAAdDWBF2**** |
| PageSize |
integer |
說明
該參數即將下線,推薦您使用參數 |
1 |
| PageNumber |
integer |
說明
該參數即將下線,推薦您使用參數 |
1 |
| RequestId |
string |
請求 ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| TotalCount |
integer |
查詢結果總條數。 說明
使用 |
15 |
| Disks |
object |
||
| Disk |
array<object> |
磁碟資訊組成的集合。 |
|
|
array<object> |
磁碟資訊。 |
||
| SerialNumber |
string |
磁碟的序號。 |
bp18um4r4f2fve2**** |
| CreationTime |
string |
建立時間。 |
2021-06-07T06:08:54Z |
| Status |
string |
磁碟狀態。可能值:
|
In_use |
| Type |
string |
磁碟類型。可能值:
|
system |
| PerformanceLevel |
string |
ESSD 雲端硬碟的效能等級。可能值:
|
PL0 |
| BdfId |
string |
該參數正在邀測中,暫未開放使用。 |
null |
| EnableAutoSnapshot |
boolean |
雲端硬碟是否啟用自動快照策略功能。 說明
該參數已棄用。建立後的雲端硬碟預設啟用自動快照策略功能,您只需要為雲端硬碟繫結自動快照策略即可正常使用。 |
false |
| StorageSetId |
string |
儲存集 ID。 |
ss-i-bp1j4i2jdf3owlhe**** |
| StorageSetPartitionNumber |
integer |
儲存集中的最大分區數量。 |
11 |
| DiskId |
string |
磁碟 ID。 |
d-bp18um4r4f2fve24**** |
| DeleteAutoSnapshot |
boolean |
是否同時刪除自動快照。可能值:
透過 CreateSnapshot 或者在控制台建立的快照,不受這個參數的影響,會始終保留。 |
false |
| StorageClusterId |
string |
雲端硬碟所屬的專屬區塊儲存叢集 ID。如果您的雲端硬碟在公共雲端區塊儲存叢集中,則該傳回值為空。 |
dbsc-j5e1sf2vaf5he8m2**** |
| Encrypted |
boolean |
是否為加密雲端硬碟。 |
false |
| IOPSRead |
integer |
每秒讀取操作的次數上限,單位:次/s。 |
2000 |
| MountInstanceNum |
integer |
共用儲存掛載的執行個體數量。 |
1 |
| Description |
string |
磁碟描述。 |
testDescription |
| Device |
string |
磁碟掛載的執行個體的裝置名稱,例如/dev/xvdb。您需要注意:
說明
該參數即將停止使用,為提高程式碼相容性,建議您盡量不要使用該參數。 |
/dev/xvdb |
| DiskName |
string |
磁碟名稱。 |
testDiskName |
| Portable |
boolean |
磁碟是否可卸載。 |
false |
| ImageId |
string |
建立 ECS 執行個體時使用的映像 ID,只有透過映像建立的雲端硬碟才有值,否則為空。當建立磁碟的映像被刪除後,該值為空。 |
m-bp13aqm171qynt3u*** |
| KMSKeyId |
string |
雲端硬碟使用的 KMS 密鑰 ID。 |
0e478b7a-4262-4802-b8cb-00d3fb408*** |
| DeleteWithInstance |
boolean |
是否隨執行個體釋放。可能值:
|
true |
| DetachedTime |
string |
該磁碟最後一次卸載時間。 |
2021-06-07T21:01:22Z |
| SourceSnapshotId |
string |
建立雲端硬碟使用的快照 ID。 如果建立雲端硬碟時,沒有指定快照,則該參數值為空。如果建立雲端硬碟的快照被刪除,該參數值為空。 |
s-bp67acfmxazb4p**** |
| AutoSnapshotPolicyId |
string |
雲端硬碟採用的自動快照策略 ID。 說明
該參數即將被棄用。如果雲端硬碟套用了多條自動快照策略,只會傳回其中一條。建議您使用 DescribeAutoSnapshotPolicyAssociations 查詢雲端硬碟套用的所有自動快照策略。 |
sp-bp67acfmxazb4p**** |
| EnableAutomatedSnapshotPolicy |
boolean |
雲端硬碟是否設定了自動快照策略。 |
false |
| IOPSWrite |
integer |
每秒寫入操作的次數上限,單位:次/s。 |
2000 |
| InstanceId |
string |
磁碟掛載的執行個體 ID。您需要注意:
|
i-bp67acfmxazb4q**** |
| IOPS |
integer |
每秒讀寫(I/O)操作的次數上限,單位:次/s。 |
4000 |
| RegionId |
string |
磁碟所屬的地域 ID。 |
cn-hangzhou |
| ExpiredTime |
string |
包年包月磁碟的到期時間。 |
2021-07-07T16:00Z |
| Size |
integer |
磁碟大小,單位 GiB。 |
60 |
| ResourceGroupId |
string |
磁碟所在的企業資源群組 ID。 |
rg-bp67acfmxazb4p**** |
| DiskChargeType |
string |
磁碟的計費方式。可能值:
|
PrePaid |
| ZoneId |
string |
磁碟所屬的可用區 ID。 |
cn-hangzhou-i |
| AttachedTime |
string |
該磁碟最後一次掛載的時間。按照 ISO8601 標準表示,使用 UTC+0 時間。格式為:yyyy-MM-ddThh:mmZ。 |
2021-06-07T06:08:56Z |
| Category |
string |
磁碟種類。可能值:
|
cloud_ssd |
| ProductCode |
string |
雲端市場的商品標識。 |
jxsc000204 |
| MultiAttach |
string |
雲端硬碟是否開啟了多重掛載特性。 |
Disabled |
| OperationLocks |
object |
||
| OperationLock |
array<object> |
磁碟鎖定原因列表。 |
|
|
object |
磁碟鎖定原因。 |
||
| LockReason |
string |
磁碟被安全鎖定的原因。 |
security |
| MountInstances |
object |
||
| MountInstance |
array<object> |
共用儲存掛載到執行個體上的資訊集合。 |
|
|
object |
共用儲存掛載到執行個體上的資訊。 |
||
| AttachedTime |
string |
掛載時間。按照ISO 8601標準表示,使用 UTC +0 時間,格式為 yyyy-MM-ddTHH:mm:ssZ。 |
2017-12-05T2340:00Z |
| InstanceId |
string |
磁碟掛載的執行個體 ID。 |
i-bp1j4i2jdf3owlhe**** |
| Device |
string |
磁碟的掛載點。 |
/dev/xvda |
| Tags |
object |
||
| Tag |
array<object> |
磁碟的標籤集合。 |
|
|
object |
磁碟的標籤。 |
||
| TagValue |
string |
標籤值。 |
TestValue |
| TagKey |
string |
標籤鍵。 |
TestKey |
| Attachments |
object |
||
| Attachment |
array<object> |
磁碟所涉及的掛載資訊。由 |
|
|
object |
磁碟所涉及的掛載資訊。 |
||
| InstanceId |
string |
所掛載的執行個體 ID。 |
i-bp67acfmxazb4q**** |
| Device |
string |
裝置名稱。 |
/dev/xvda |
| AttachedTime |
string |
掛載的時間,以 UTC +0 時間為準。 |
2021-06-07T06:08:56Z |
| ProvisionedIops |
integer |
ESSD AutoPL 雲端硬碟預配置的讀寫 IOPS。可能值:0~min{50000, 1000容量-基準效能}。 基準效能=min{1,800+50容量, 50,000}。 當 |
40000 |
| BurstingEnabled |
boolean |
是否開啟 Burst(效能突發)。可能值:
當 |
false |
| Throughput |
integer |
單位時間內可以成功傳輸的資料數量,單位:MB/s。 |
100 |
| ThroughputRead |
integer |
單位時間內系統可以成功讀取的資料數量,單位:MB/s。 |
100 |
| ThroughputWrite |
integer |
單位時間內系統可以成功寫入的資料數量,單位:MB/s。 |
100 |
| Placement |
object |
資料存放地集合。 只有入參指定 說明
當前僅有 ESSD 同城冗餘類型(cloud_regional_disk_auto)磁碟具有有效值。 |
|
| ZoneIds |
string |
實際資料存放的可用區列表。 |
"["cn-hangzhou-b", "cn-hangzhou-j"]" |
| SourceDiskId |
string |
d-123********* |
|
| DataSource |
object |
||
| Id |
string |
||
| Type |
string |
樣本
正常返回樣本
JSON格式
{
"NextToken": "AAAAAdDWBF2****",
"PageSize": 1,
"PageNumber": 1,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"TotalCount": 15,
"Disks": {
"Disk": [
{
"SerialNumber": "bp18um4r4f2fve2****",
"CreationTime": "2021-06-07T06:08:54Z",
"Status": "In_use",
"Type": "system",
"PerformanceLevel": "PL0",
"BdfId": "null",
"EnableAutoSnapshot": false,
"StorageSetId": "ss-i-bp1j4i2jdf3owlhe****",
"StorageSetPartitionNumber": 11,
"DiskId": "d-bp18um4r4f2fve24****",
"DeleteAutoSnapshot": false,
"StorageClusterId": "dbsc-j5e1sf2vaf5he8m2****",
"Encrypted": false,
"IOPSRead": 2000,
"MountInstanceNum": 1,
"Description": "testDescription",
"Device": "/dev/xvdb",
"DiskName": "testDiskName",
"Portable": false,
"ImageId": "m-bp13aqm171qynt3u***",
"KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb408***",
"DeleteWithInstance": true,
"DetachedTime": "2021-06-07T21:01:22Z",
"SourceSnapshotId": "s-bp67acfmxazb4p****",
"AutoSnapshotPolicyId": "sp-bp67acfmxazb4p****",
"EnableAutomatedSnapshotPolicy": false,
"IOPSWrite": 2000,
"InstanceId": "i-bp67acfmxazb4q****",
"IOPS": 4000,
"RegionId": "cn-hangzhou",
"ExpiredTime": "2021-07-07T16:00Z",
"Size": 60,
"ResourceGroupId": "rg-bp67acfmxazb4p****",
"DiskChargeType": "PrePaid",
"ZoneId": "cn-hangzhou-i",
"AttachedTime": "2021-06-07T06:08:56Z",
"Category": "cloud_ssd",
"ProductCode": "jxsc000204",
"MultiAttach": "Disabled",
"OperationLocks": {
"OperationLock": [
{
"LockReason": "security"
}
]
},
"MountInstances": {
"MountInstance": [
{
"AttachedTime": "2017-12-05T2340:00Z",
"InstanceId": "i-bp1j4i2jdf3owlhe****",
"Device": "/dev/xvda"
}
]
},
"Tags": {
"Tag": [
{
"TagValue": "TestValue",
"TagKey": "TestKey"
}
]
},
"Attachments": {
"Attachment": [
{
"InstanceId": "i-bp67acfmxazb4q****",
"Device": "/dev/xvda",
"AttachedTime": "2021-06-07T06:08:56Z"
}
]
},
"ProvisionedIops": 40000,
"BurstingEnabled": false,
"Throughput": 100,
"ThroughputRead": 100,
"ThroughputWrite": 100,
"Placement": {
"ZoneIds": "\"[\"cn-hangzhou-b\",\n\"cn-hangzhou-j\"]\""
},
"SourceDiskId": "d-123*********"
}
]
}
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidDiskType.ValueNotSupported | The specified disk type is not supported. | 指定的磁盘属性不支持。 |
| 400 | InvalidCategory.ValueNotSupported | The specified disk category is not supported. | 不支持指定的磁盘种类。 |
| 400 | InvalidStatus.ValueNotSupported | The specified disk status is not supported. | 指定的磁盘状态不支持此类操作。 |
| 400 | InvalidTag.Mismatch | The specified Tag.n.Key and Tag.n.Value are not match. | 指定的 Tag.N.Key 和 Tag.N.Value 不匹配。 |
| 400 | InvalidTagCount | The specified tags are beyond the permitted range. | 指定的标记超出取值范围。 |
| 400 | InvalidRegion.NotFound | The specified parameter RegionId is not valid. | RegionId 参数不合法。 |
| 400 | InvalidZoneId.NotFound | The zoneId provided does not exist in our records. | 指定的可用区 ID 不存在。 |
| 400 | MissingParamter.RegionId | The regionId should not be null. | 参数 RegionId 不得为空。 |
| 400 | InvalidParameter.DiskIds | The specified parameter diskIds is not valid. | 指定的参数 diskIds 无效。 |
| 400 | IncompleteParamter | Some fields can not be null in this request. | 请求中缺失参数。 |
| 400 | InvalidParamter | Some parameters are invalid in this request. | 请求中包含非法参数。 |
| 400 | InvalidSnapshot.NotFound | The specified parameter SnapshotId is not valid. | 指定的 SnapshotId 不合法。 |
| 500 | InternalError | The request processing has failed due to some unknown error. | |
| 403 | InvalidDiskIds.Malformed | The amount of specified disk Ids exceeds the limit. | |
| 403 | InvalidCategory.ValueNotSupported | The specified disk category is not supported. | |
| 403 | UserNotInTheWhiteList | The user is not in volume white list. | |
| 403 | InvalidParameter.MultiAttachAndEnableSharedNotMatch | The parameter MultiAttach and EnableShared are not match. | 设置的 MultiAttach 参数和 EnableShared 参数的值不兼容。 |
| 403 | InvalidParameter.MultiAttach | The specified param MultiAttach is not valid. | MultiAttach 参数的取值有误。 |
| 404 | InvalidFilterKey.NotFound | The filter key is not found. | |
| 404 | InvalidFilterValue | The filter value is not valid. | |
| 404 | InvalidDiskIds.ValueNotSupported | The specified parameter "DiskIds" is not supported. | 指定的 DiskIds 参数值无效或格式非法 |
| 404 | InvalidDiskChargeType.NotFound | The DiskChargeType does not exist in our records. | 指定的磁盘计费方式不存在。 |
| 404 | InvalidLockReason.NotFound | The specified LockReason is not found. | 所指定的锁定原因不存在 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。