1 つ以上のブロックストレージディスク (クラウドディスク、ローカルディスク、エラスティックテンポラリディスクなど) について説明します。
操作説明
-
RegionId、ZoneId、DiskIds、InstanceIdなどのリクエストパラメーターは、フィルターとして機能します。この操作は、これらのパラメーターに論理ANDを適用します。 -
DiskIdsパラメーターは JSON 配列です。このパラメーターを省略した場合、フィルターとしては機能しません。DiskIdsに空の配列を指定した場合、この操作は空のリストを返します。 -
この操作は、ページ分割されたクエリをサポートします。
NextTokenに前回のレスポンスのNextToken値を設定して、次のページの結果を取得します。MaxResultsを使用して、1 ページあたりに返される最大エントリ数を指定します。 -
マルチアタッチ機能が有効なクラウドディスクは、複数のインスタンスにアタッチできます。レスポンスの
Attachmentリストで、クラウドディスクのすべてのアタッチメント情報を確認できます。
Alibaba Cloud CLI を使用する場合、パラメーター値はデータ型に応じて特定の形式で指定する必要があります。詳細については、「Alibaba Cloud CLI におけるパラメーター形式」をご参照ください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ecs:DescribeDisks |
list |
Disk
Disk
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
ディスクが所在するリージョンの ID です。最新のリージョンリストは、DescribeRegions API を呼び出すことで確認できます。 |
cn-hangzhou |
| ZoneId |
string |
任意 |
ゾーンの ID です。 |
cn-hangzhou-g |
| DiskIds |
string |
任意 |
1 つ以上のクラウドディスク、ローカルディスク、または Elastic Ephemeral Disk の ID です。JSON 配列として指定します。配列には最大 100 個のディスク ID を含めることができます。 |
["d-bp67acfmxazb4p****", "d-bp67acfmxazb4g****", … "d-bp67acfmxazb4d****"] |
| InstanceId |
string |
任意 |
クラウドディスク、ローカルディスク、または Elastic Ephemeral Disk がアタッチされているインスタンスの ID です。 |
i-bp67acfmxazb4q**** |
| DiskType |
string |
任意 |
照会するディスクのタイプです。有効な値:
デフォルト値:all。 説明
Elastic Ephemeral Disk はシステムディスクとして使用できません。 |
all |
| Category |
string |
任意 |
ディスクのカテゴリです。有効な値:
デフォルト値:all。 |
all |
| Status |
string |
任意 |
ディスクのステータスです。詳細については、「Disk states」をご参照ください。有効な値:
デフォルト値: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 |
任意 |
前回の照会で返されたページネーショントークンです。このトークンを指定すると、次のページの結果を取得できます。初回のリクエストでは、このパラメーターを設定する必要はありません。 |
AAAAAdDWBF2**** |
| MaxResults |
integer |
任意 |
ページごとに返す結果の最大数です。有効な値:10 ~ 500。 デフォルト値:
|
50 |
| DiskName |
string |
任意 |
ディスクの名前です。名前は 2 ~ 128 文字で、文字、数字、コロン (:)、アンダースコア (_)、ピリオド (.)、ハイフン (-) を使用できます。 |
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 |
任意 |
照会する期間の開始時刻です。時刻は UTC の |
2017-12-05T22:40Z |
| Filter.2.Value |
string |
任意 |
照会する期間の終了時刻です。時刻は UTC の |
2017-12-06T22:40Z |
| ResourceGroupId |
string |
任意 |
ディスクが属するリソースグループの ID です。このパラメーターでフィルタリングする場合、最大 1,000 件の結果が返されます。 説明
デフォルトのリソースグループに属するリソースはフィルタリングできません。 |
rg-bp67acfmxazb4p**** |
| EnableShared |
boolean |
任意 |
共有ブロックストレージのディスクのみを照会するかどうかを指定します。 |
false |
| Encrypted |
boolean |
任意 |
暗号化済みのクラウドディスクのみを照会するかどうかを指定します。有効な値:
デフォルト値:false。 |
false |
| DryRun |
boolean |
任意 |
ドライランを実行するかどうかを指定します。有効な値:
デフォルト値:false。 |
false |
| KMSKeyId |
string |
任意 |
クラウドディスクの暗号化に使用される Key Management Service (KMS) のキー ID です。 |
0e478b7a-4262-4802-b8cb-00d3fb40**** |
| MultiAttach |
string |
任意 |
ディスクでマルチアタッチ機能が有効になっているかどうかを指定します。有効な値:
|
Disabled |
| Tag |
array<object> |
任意 |
ディスクのタグです。 |
|
|
object |
任意 |
ディスクのタグです。 |
||
| key |
string |
任意 |
タグのキーです。 説明
互換性を高めるため、 |
null |
| Key |
string |
任意 |
タグのキーです。 説明
互換性を高めるため、 |
TestKey |
| Value |
string |
任意 |
タグの値です。 |
TestValue |
| value |
string |
任意 |
タグの値です。 |
null |
| AdditionalAttributes |
array |
任意 |
追加属性です。値を 説明
データ配置場所があるのは、リージョン冗長 ESSD のみです。 |
IOPS |
|
string |
任意 |
追加属性です。値を |
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 API を呼び出して作成されたスナップショット、またはコンソールで作成されたスナップショットは、このパラメーターの影響を受けず、常に保持されます。 |
false |
| StorageClusterId |
string |
ディスクが属する専用ブロックストレージクラスターの ID です。ディスクがパブリックブロックストレージクラスターにある場合、このパラメーターは空です。 |
dbsc-j5e1sf2vaf5he8m2**** |
| Encrypted |
boolean |
ディスクが暗号化済みかどうかを示します。 |
false |
| IOPSRead |
integer |
読み取り IOPS の最大数です。 |
2000 |
| MountInstanceNum |
integer |
共有ブロックストレージデバイスがアタッチされているインスタンス数です。 |
1 |
| Description |
string |
ディスクの説明です。 |
testDescription |
| Device |
string |
アタッチされているインスタンス上のディスクのデバイス名です (/dev/xvdb など)。このパラメーターは、ディスクが
説明
このパラメーターは非推奨です。互換性を確保するため、他のパラメーターを使用することを推奨します。 |
/dev/xvdb |
| DiskName |
string |
ディスクの名前です。 |
testDiskName |
| Portable |
boolean |
ディスクが取り外し可能かどうかを示します。 |
false |
| ImageId |
string |
インスタンスの作成に使用されたイメージの ID です。このパラメーターが返されるのは、ディスクがイメージから作成された場合のみです。ディスクの作成に使用されたイメージが削除されている場合、このパラメーターは空です。 |
m-bp13aqm171qynt3u*** |
| KMSKeyId |
string |
ディスクに使用される Key Management Service (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 です。 説明
このパラメーターは非推奨です。複数の自動スナップショットポリシーがディスクに適用されている場合、ポリシーのうち 1 つの ID のみが返されます。ディスクに適用されているすべての自動スナップショットポリシーを照会するには、DescribeAutoSnapshotPolicyEx API を呼び出してください。 |
sp-bp67acfmxazb4p**** |
| EnableAutomatedSnapshotPolicy |
boolean |
ディスクに自動スナップショットポリシーが適用されているかどうかを示します。 |
false |
| IOPSWrite |
integer |
書き込み IOPS の最大数です。 |
2000 |
| InstanceId |
string |
ディスクがアタッチされているインスタンスの ID です。このパラメーターは、ディスクが
|
i-bp67acfmxazb4q**** |
| IOPS |
integer |
読み取り/書き込み IOPS の最大数です。 |
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 |
ディスクが最後にアタッチされた時刻です。時刻は、ISO 8601 標準に準拠した |
2021-06-07T06:08:56Z |
| Category |
string |
ディスクのカテゴリです。有効な値:
|
cloud_ssd |
| ProductCode |
string |
Alibaba Cloud Marketplace の製品コードです。 |
jxsc000204 |
| MultiAttach |
string |
ディスクでマルチアタッチ機能が有効になっているかどうかを示します。有効な値: |
Disabled |
| OperationLocks |
object |
||
| OperationLock |
array<object> |
ディスクがロックされている理由です。 |
|
|
object |
ディスクがロックされている理由です。 |
||
| LockReason |
string |
ディスクがロックされている理由です。 |
security |
| MountInstances |
object |
||
| MountInstance |
array<object> |
共有ブロックストレージデバイスのアタッチメント情報です。 |
|
|
object |
共有ブロックストレージデバイスのアタッチメント情報です。 |
||
| AttachedTime |
string |
ディスクがアタッチされた時刻です。時刻は、ISO 8601 標準に準拠した |
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 |
ディスクがアタッチされた時刻です。時刻は、ISO 8601 標準に準拠した |
2021-06-07T06:08:56Z |
| ProvisionedIops |
integer |
ESSD AutoPL ディスクのプロビジョンド IOPS (読み取り/書き込み) です。有効な値:0 ~ min{50000, 1000 × Capacity - ベースライン IOPS}。ベースライン IOPS = min{1,800 + 50 × Capacity, 50,000}。 このパラメーターは、 |
40000 |
| BurstingEnabled |
boolean |
パフォーマンスバースト機能が有効かどうかを示します。有効な値:
このパラメーターは、 |
false |
| Throughput |
integer |
ディスクのスループットです。単位:MB/s。 |
100 |
| ThroughputRead |
integer |
ディスクの読み取りスループットです。単位:MB/s。 |
100 |
| ThroughputWrite |
integer |
ディスクの書き込みスループットです。単位:MB/s。 |
100 |
| Placement |
object |
ディスクのプレイスメント情報です。 このパラメーターが返されるのは、リクエストで 説明
このパラメーターが返されるのは、ESSD zone-redundant ディスク ( |
|
| ZoneIds |
string |
データが保存されているゾーンのリストです。 |
"["cn-hangzhou-b", "cn-hangzhou-j"]" |
| SourceDiskId |
string |
d-123********* |
|
| DataSource |
object |
||
| Id |
string |
||
| Type |
string |
例
成功レスポンス
JSONJSON
{
"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*********",
"DataSource": {
"Id": "",
"Type": ""
}
}
]
}
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 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. | |
| 400 | InvalidTagCount | The specified tags are beyond the permitted range. | |
| 400 | InvalidRegion.NotFound | The specified parameter RegionId is not valid. | |
| 400 | InvalidZoneId.NotFound | The zoneId provided does not exist in our records. | |
| 400 | MissingParamter.RegionId | The regionId should not be null. | |
| 400 | InvalidParameter.DiskIds | The specified parameter diskIds is not valid. | |
| 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. | |
| 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. | |
| 403 | InvalidParameter.MultiAttach | The specified param MultiAttach is not valid. | |
| 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. | |
| 404 | InvalidDiskChargeType.NotFound | The DiskChargeType does not exist in our records. | |
| 404 | InvalidLockReason.NotFound | The specified LockReason is not found. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。