Menggambarkan satu atau beberapa disk penyimpanan blok, termasuk cloud disk, local disk, dan elastic temporary disk.
Deskripsi operasi
-
Parameter permintaan seperti
RegionId,ZoneId,DiskIds, danInstanceIdberfungsi sebagai filter. Operasi ini menerapkan logikaANDterhadap parameter-parameter tersebut. -
Parameter
DiskIdsmerupakan array JSON. Jika parameter ini dihilangkan, ia tidak digunakan sebagai filter. Namun, jika Anda memberikan array kosong untukDiskIds, operasi akan mengembalikan daftar kosong. -
Operasi ini mendukung kueri terpaginasi. Tetapkan
NextTokenke nilaiNextTokendari respons sebelumnya untuk mengambil halaman hasil berikutnya, dan gunakanMaxResultsuntuk menentukan jumlah maksimum entri yang dikembalikan per halaman. -
Cloud disk yang memiliki fitur multi-attach diaktifkan dapat disambungkan ke beberapa instans. Semua informasi attachment cloud disk tersebut tersedia dalam daftar
Attachmentpada respons.
Saat menggunakan Alibaba Cloud CLI, nilai parameter harus mengikuti format tertentu sesuai dengan tipe datanya. Untuk informasi selengkapnya, lihat Format parameter di Alibaba Cloud CLI.
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
ecs:DescribeDisks |
list |
Disk
Disk
|
None | None |
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
ID wilayah tempat disk berada. Anda dapat memanggil operasi DescribeRegions untuk melihat daftar wilayah terbaru. |
cn-hangzhou |
| ZoneId |
string |
No |
ID zona. |
cn-hangzhou-g |
| DiskIds |
string |
No |
ID satu atau beberapa cloud disk, local disk, atau Elastic Ephemeral Disk, ditentukan sebagai array JSON. Array ini dapat berisi hingga 100 ID disk. |
["d-bp67acfmxazb4p****", "d-bp67acfmxazb4g****", … "d-bp67acfmxazb4d****"] |
| InstanceId |
string |
No |
ID instans tempat cloud disk, local disk, atau Elastic Ephemeral Disk disambungkan. |
i-bp67acfmxazb4q**** |
| DiskType |
string |
No |
Tipe disk yang akan dikueri. Nilai yang valid:
Nilai default: all. Catatan
Elastic Ephemeral Disk tidak dapat digunakan sebagai disk sistem. |
all |
| Category |
string |
No |
Kategori disk. Nilai yang valid:
Nilai default: all. |
all |
| Status |
string |
No |
Status disk. Untuk informasi selengkapnya, lihat Status disk. Nilai yang valid:
Nilai default: All. |
All |
| SnapshotId |
string |
No |
ID snapshot yang digunakan untuk membuat cloud disk. |
s-bp67acfmxazb4p**** |
| Portable |
boolean |
No |
Menentukan apakah disk dapat dilepas. Nilai yang valid:
Atribut
|
false |
| DeleteWithInstance |
boolean |
No |
Menentukan apakah disk akan dilepas saat instans terkait dilepas. Nilai yang valid:
Nilai default: false. |
false |
| DeleteAutoSnapshot |
boolean |
No |
Menentukan apakah snapshot otomatis cloud disk akan dilepas saat disk dilepas. Nilai yang valid:
Nilai default: false. |
false |
| PageNumber |
integer |
No |
Catatan
Parameter ini sudah tidak digunakan lagi. Kami menyarankan Anda menggunakan |
1 |
| PageSize |
integer |
No |
Catatan
Parameter ini sudah tidak digunakan lagi. Kami menyarankan Anda menggunakan |
10 |
| NextToken |
string |
No |
Token paginasi yang dikembalikan dari kueri sebelumnya. Tentukan token ini untuk mengambil halaman hasil berikutnya. Anda tidak perlu menetapkan parameter ini untuk permintaan pertama. |
AAAAAdDWBF2**** |
| MaxResults |
integer |
No |
Jumlah maksimum hasil yang dikembalikan per halaman. Nilai yang valid: 10 hingga 500. Nilai default:
|
50 |
| DiskName |
string |
No |
Nama disk. Nama harus terdiri dari 2 hingga 128 karakter dan dapat berisi huruf, angka, titik dua (:), garis bawah (_), titik (.), dan tanda hubung (-). |
testDiskName |
| AutoSnapshotPolicyId |
string |
No |
ID kebijakan snapshot otomatis yang diterapkan pada cloud disk. |
sp-m5e2w2jutw8bv31**** |
| EnableAutoSnapshot |
boolean |
No |
Menentukan apakah fitur kebijakan snapshot otomatis diaktifkan untuk cloud disk.
Catatan
Parameter ini sudah tidak digunakan lagi. Fitur snapshot otomatis diaktifkan secara default pada cloud disk. Untuk mencadangkan disk secara otomatis, terapkan kebijakan snapshot otomatis padanya. |
true |
| EnableAutomatedSnapshotPolicy |
boolean |
No |
Menentukan apakah kebijakan snapshot otomatis diterapkan pada cloud disk. Nilai yang valid:
Nilai default: false. |
false |
| DiskChargeType |
string |
No |
Metode penagihan disk. Nilai yang valid:
|
PostPaid |
| LockReason |
string |
No |
Alasan disk dikunci. Nilai yang valid:
|
security |
| Filter.1.Key |
string |
No |
Kunci filter. Tetapkan parameter ini ke |
CreationStartTime |
| Filter.2.Key |
string |
No |
Kunci filter. Tetapkan parameter ini ke |
CreationEndTime |
| Filter.1.Value |
string |
No |
Awal rentang waktu untuk dikueri. Waktu harus dalam format |
2017-12-05T22:40Z |
| Filter.2.Value |
string |
No |
Akhir rentang waktu untuk dikueri. Waktu harus dalam format |
2017-12-06T22:40Z |
| ResourceGroupId |
string |
No |
ID Resource Group tempat disk tersebut berada. Saat Anda melakukan filter berdasarkan parameter ini, maksimal 1.000 hasil dikembalikan. Catatan
Anda tidak dapat memfilter resource yang termasuk dalam Resource Group default. |
rg-bp67acfmxazb4p**** |
| EnableShared |
boolean |
No |
Menentukan apakah hanya akan mengkueri disk Shared Block Storage. |
false |
| Encrypted |
boolean |
No |
Menentukan apakah hanya akan mengkueri cloud disk terenkripsi. Nilai yang valid:
Nilai default: false. |
false |
| DryRun |
boolean |
No |
Menentukan apakah akan menjalankan dry run. Nilai yang valid:
Nilai default: false. |
false |
| KMSKeyId |
string |
No |
ID kunci Key Management Service (KMS) yang mengenkripsi cloud disk. |
0e478b7a-4262-4802-b8cb-00d3fb40**** |
| MultiAttach |
string |
No |
Menentukan apakah fitur multi-attach diaktifkan untuk disk. Nilai yang valid:
|
Disabled |
| Tag |
array<object> |
No |
Tag disk. |
|
|
object |
No |
Tag disk. |
||
| key |
string |
No |
Kunci tag. Catatan
Kami menyarankan Anda menggunakan parameter |
null |
| Key |
string |
No |
Kunci tag. Catatan
Kami menyarankan Anda menggunakan parameter |
TestKey |
| Value |
string |
No |
Nilai tag. |
TestValue |
| value |
string |
No |
Nilai tag. |
null |
| AdditionalAttributes |
array |
No |
Atribut tambahan. Tetapkan nilai ke Catatan
Hanya ESSD zone-redundant yang memiliki lokasi penempatan data. |
IOPS |
|
string |
No |
Atribut tambahan. Tetapkan nilai ke |
Placement |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
|||
| NextToken |
string |
Token yang digunakan untuk mengambil halaman hasil berikutnya. |
AAAAAdDWBF2**** |
| PageSize |
integer |
Catatan
Parameter ini sudah tidak digunakan lagi. Gunakan parameter |
1 |
| PageNumber |
integer |
Catatan
Parameter ini sudah tidak digunakan lagi. Gunakan parameter |
1 |
| RequestId |
string |
ID permintaan. |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| TotalCount |
integer |
Jumlah total entri yang dikembalikan. Catatan
Nilai |
15 |
| Disks |
object |
||
| Disk |
array<object> |
Detail tentang disk. |
|
|
array<object> |
Detail tentang sebuah disk. |
||
| SerialNumber |
string |
Nomor seri disk. |
bp18um4r4f2fve2**** |
| CreationTime |
string |
Waktu saat disk dibuat. |
2021-06-07T06:08:54Z |
| Status |
string |
Status disk. Nilai yang valid:
|
In_use |
| Type |
string |
Tipe disk. Nilai yang valid:
|
system |
| PerformanceLevel |
string |
Tingkat kinerja ESSD. Nilai yang valid:
|
PL0 |
| BdfId |
string |
Parameter ini tersedia hanya berdasarkan undangan. |
null |
| EnableAutoSnapshot |
boolean |
Menunjukkan apakah fitur kebijakan snapshot otomatis diaktifkan untuk disk. Catatan
Parameter ini sudah tidak digunakan lagi. Fitur snapshot otomatis diaktifkan secara default pada disk baru. Untuk menggunakan fitur ini, terapkan kebijakan snapshot otomatis pada disk. |
false |
| StorageSetId |
string |
ID storage set. |
ss-i-bp1j4i2jdf3owlhe**** |
| StorageSetPartitionNumber |
integer |
Jumlah partisi dalam storage set. |
11 |
| DiskId |
string |
ID disk. |
d-bp18um4r4f2fve24**** |
| DeleteAutoSnapshot |
boolean |
Menunjukkan apakah snapshot otomatis disk akan dihapus saat disk dilepas. Nilai yang valid:
Snapshot yang dibuat dengan memanggil operasi CreateSnapshot atau di konsol tidak terpengaruh oleh parameter ini dan selalu dipertahankan. |
false |
| StorageClusterId |
string |
ID kluster penyimpanan blok khusus tempat disk tersebut berada. Jika disk berada di kluster penyimpanan blok publik, parameter ini kosong. |
dbsc-j5e1sf2vaf5he8m2**** |
| Encrypted |
boolean |
Menunjukkan apakah disk dienkripsi. |
false |
| IOPSRead |
integer |
Jumlah maksimum IOPS baca. |
2000 |
| MountInstanceNum |
integer |
Jumlah instans tempat storage device blok bersama disambungkan. |
1 |
| Description |
string |
Deskripsi disk. |
testDescription |
| Device |
string |
Nama perangkat disk pada instans tempat disk tersebut disambungkan, seperti /dev/xvdb. Parameter ini memiliki nilai hanya saat disk berada dalam status
Catatan
Parameter ini sudah tidak digunakan lagi. Untuk memastikan kompatibilitas, kami menyarankan Anda menggunakan parameter lain. |
/dev/xvdb |
| DiskName |
string |
Nama disk. |
testDiskName |
| Portable |
boolean |
Menunjukkan apakah disk dapat dilepas. |
false |
| ImageId |
string |
ID image yang digunakan untuk membuat instans. Parameter ini dikembalikan hanya jika disk dibuat dari image. Jika image yang digunakan untuk membuat disk dihapus, parameter ini kosong. |
m-bp13aqm171qynt3u*** |
| KMSKeyId |
string |
ID kunci Key Management Service (KMS) yang digunakan untuk disk. |
0e478b7a-4262-4802-b8cb-00d3fb408*** |
| DeleteWithInstance |
boolean |
Menunjukkan apakah disk dilepas saat instans tempat disk tersebut disambungkan dilepas. Nilai yang valid:
|
true |
| DetachedTime |
string |
Waktu saat disk terakhir dilepas. |
2021-06-07T21:01:22Z |
| SourceSnapshotId |
string |
ID snapshot yang digunakan untuk membuat disk. Parameter ini kosong jika disk tidak dibuat dari snapshot atau jika snapshot sumber telah dihapus. |
s-bp67acfmxazb4p**** |
| AutoSnapshotPolicyId |
string |
ID kebijakan snapshot otomatis yang diterapkan pada disk. Catatan
Parameter ini sudah tidak digunakan lagi. Jika beberapa kebijakan snapshot otomatis diterapkan pada disk, hanya ID salah satu kebijakan yang dikembalikan. Untuk mengkueri semua kebijakan snapshot otomatis yang diterapkan pada disk, panggil operasi DescribeAutoSnapshotPolicyEx. |
sp-bp67acfmxazb4p**** |
| EnableAutomatedSnapshotPolicy |
boolean |
Menunjukkan apakah kebijakan snapshot otomatis diterapkan pada disk. |
false |
| IOPSWrite |
integer |
Jumlah maksimum IOPS tulis. |
2000 |
| InstanceId |
string |
ID instans tempat disk disambungkan. Parameter ini memiliki nilai hanya saat disk berada dalam status
|
i-bp67acfmxazb4q**** |
| IOPS |
integer |
Jumlah maksimum IOPS baca dan tulis. |
4000 |
| RegionId |
string |
ID wilayah tempat disk berada. |
cn-hangzhou |
| ExpiredTime |
string |
Waktu saat disk subscription berakhir. |
2021-07-07T16:00Z |
| Size |
integer |
Ukuran disk. Satuan: GiB. |
60 |
| ResourceGroupId |
string |
ID kelompok sumber daya tempat disk berada. |
rg-bp67acfmxazb4p**** |
| DiskChargeType |
string |
Metode penagihan disk. Nilai yang valid:
|
PrePaid |
| ZoneId |
string |
ID zona tempat disk berada. |
cn-hangzhou-i |
| AttachedTime |
string |
Waktu saat disk terakhir disambungkan. Waktu mengikuti standar ISO 8601 dalam format |
2021-06-07T06:08:56Z |
| Category |
string |
Kategori disk. Nilai yang valid:
|
cloud_ssd |
| ProductCode |
string |
Kode produk dari Alibaba Cloud Marketplace. |
jxsc000204 |
| MultiAttach |
string |
Menunjukkan apakah fitur multi-attach diaktifkan untuk disk. Nilai yang valid: |
Disabled |
| OperationLocks |
object |
||
| OperationLock |
array<object> |
Alasan disk dikunci. |
|
|
object |
Alasan disk dikunci. |
||
| LockReason |
string |
Alasan disk dikunci. |
security |
| MountInstances |
object |
||
| MountInstance |
array<object> |
Informasi attachment storage device blok bersama. |
|
|
object |
Informasi attachment storage device blok bersama. |
||
| AttachedTime |
string |
Waktu saat disk disambungkan. Waktu mengikuti standar ISO 8601 dalam format |
2017-12-05T2340:00Z |
| InstanceId |
string |
ID instans tempat disk disambungkan. |
i-bp1j4i2jdf3owlhe**** |
| Device |
string |
Titik pemasangan disk. |
/dev/xvda |
| Tags |
object |
||
| Tag |
array<object> |
Tag disk. |
|
|
object |
Tag disk. |
||
| TagValue |
string |
Nilai tag. |
TestValue |
| TagKey |
string |
Kunci tag. |
TestKey |
| Attachments |
object |
||
| Attachment |
array<object> |
Informasi attachment disk. Parameter ini tidak dikembalikan untuk shared block storage. |
|
|
object |
Informasi attachment disk. |
||
| InstanceId |
string |
ID instans tempat disk disambungkan. |
i-bp67acfmxazb4q**** |
| Device |
string |
Nama perangkat. |
/dev/xvda |
| AttachedTime |
string |
Waktu saat disk disambungkan. Waktu mengikuti standar ISO 8601 dalam format |
2021-06-07T06:08:56Z |
| ProvisionedIops |
integer |
IOPS baca/tulis yang disediakan untuk ESSD AutoPL disk. Nilai yang valid: 0 hingga min{50000, 1000 × Kapasitas - Baseline IOPS}. Baseline IOPS = min{1.800 + 50 × Kapasitas, 50.000}. Parameter ini tersedia hanya saat |
40000 |
| BurstingEnabled |
boolean |
Menunjukkan apakah fitur lonjakan performa diaktifkan. Nilai yang valid:
Parameter ini tersedia hanya saat |
false |
| Throughput |
integer |
Throughput disk. Satuan: MB/s. |
100 |
| ThroughputRead |
integer |
Throughput baca disk. Satuan: MB/s. |
100 |
| ThroughputWrite |
integer |
Throughput tulis disk. Satuan: MB/s. |
100 |
| Placement |
object |
Informasi penempatan disk. Parameter ini dikembalikan hanya jika Anda menetapkan Catatan
Parameter ini dikembalikan hanya untuk disk ESSD zone-redundant ( |
|
| ZoneIds |
string |
Daftar zona tempat data disimpan. |
"["cn-hangzhou-b", "cn-hangzhou-j"]" |
| SourceDiskId |
string |
d-123********* |
|
| DataSource |
object |
||
| Id |
string |
||
| Type |
string |
Contoh
Respons sukses
JSONformat
{
"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": ""
}
}
]
}
}
Kode kesalahan
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 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. |
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.