Kueri informasi disk menggunakan DescribeDisks - ENS - Alibaba Cloud - ENS

Memanggil DescribeDisks untuk mengkueri informasi tentang satu atau beberapa disk yang telah dibuat.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

ens:DescribeDisks

get

*Disk

acs:ens::{#accountId}:disk/{#DiskId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
EnsRegionId	string	No	ID node ENS.	cn-kunming-telecom
DiskId	string	No	ID disk.	d-5soak1gqa507lyfzvz0xo****
DiskName	string	No	Nama disk.	DiskName
PageNumber	string	No	Nomor halaman daftar kueri. Nilai awal adalah 1. Nilai default: 1.	1
PageSize	string	No	Jumlah baris per halaman yang ditetapkan saat melakukan kueri terpaginasi. Nilai maksimum adalah 50 baris. Nilai default: 10.	10
Status	string	No	Status disk. In-use: Sedang digunakan Available: Menunggu dilampirkan Attaching: Melampirkan Detaching: Melepas Creating: Membuat ReIniting: Menginisialisasi ulang Deleting: Melepaskan Deleted: Telah dilepaskan Expiring: Akan segera kedaluwarsa.	Available
Type	string	No	Atribut disk. system: Disk sistem data: Disk data.	system
Category	string	No	Kategori disk. Disk ultra: cloud_efficiency Disk all-flash: cloud_ssd HDD lokal: local_hdd SSD lokal: local_ssd.	local_ssd
DiskChargeType	string	No	Metode penagihan. prepay: Langganan postpay: Bayar sesuai pemakaian.	prepay
EnsRegionIds	string	No	Daftar node.	["cn-suzhou-telecom","cn-chengdu-telecom"]
DiskIds	string	No	ID disk.	[\"d-wz99njena32z90ki****\"]
OrderByParams	string	No	Urutan pengurutan. Contoh format: {"EnsRegionId":"desc"}. Secara default, hasil diurutkan secara menurun berdasarkan ID node.	{ "DiskNameSort":"desc","EnsRegionIdSort":"asc" }
DiskType	string	No	Metode pembelian disk. ServiceDisk: Disk yang dibuat oleh layanan edge ResoureDisk: Dibeli bersama instans PostPayDisk: Dibeli secara terpisah.	PostPayDisk
InstanceId	string	No	Instans tempat disk dilampirkan.	i-5t77rb0yoz79m28ku60sx****
SnapshotId	string	No	ID snapshot.	s-897654321****

Elemen respons

Element	Type	Description	Example
	object
Code	integer	Kode bisnis yang dikembalikan. 0 menunjukkan keberhasilan.	0
Disks	object
Disks	array<object>	Daftar informasi disk.
	array<object>	Daftar informasi disk.
Category	string	The category of the disk. cloud_efficiency: ultra disk. cloud_ssd: all-flash disk. local_hdd: local HDD. local_ssd: local SSD.	local_ssd
CreationTime	string	The time when the disk was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2021-11-11T14:34:55+08:00
DiskChargeType	string	The billing method of the cloud disk or local disk. Valid values: prepaid: subscription. postpaid: pay-as-you-go.	prepaid
DiskId	string	The ID of the disk.	d-5svum1dx1w4a4spr54lgr****
DiskName	string	The name of the disk.	fvt-ecs-5cf0****
EnsRegionId	string	The ID of the edge node.	cn-guangzhou-10
InstanceId	string	The ID of the instance.	i-5t77rb0yoz79m28ku60sx****
InstanceName	string	The name of the instance.	边缘prod环境串流机器-1063
Description	string	The namespace description.	disk-description
Size	integer	The size of the disk. Unit: MiB.	20
Status	string	The status of the disk. Valid values: In-use: The disk is in use. Available: The disk can be attached. Attaching: The disk is being attached. Detaching: The disk is being detached. Creating: The disk is being created. ReIniting: The disk is being reset.	Available
Type	string	The type of the cloud disk or local disk. Valid values: 1: system disk. 2: data disk.	1
Portable	boolean	Indicates whether the cloud disk or local disk is removable. Valid values: true: The disk is removable. A removable disk can independently exist and can be attached to or detached from an instance within the same zone. false: The disk is not removable. A disk that is not removable cannot independently exist or be attached to or detached from an instance within the same zone. If disks are of the following categories or types, the Portable value is false and the disks have the same lifecycle as their attached instances: Local HDDs Local SSDs Data disks that use the subscription billing method	true
SnapshotId	string	The ID of the snapshot.	s-bp67acfmxazb4p****
SerialId	string	The serial number.	123
Encrypted	boolean	Indicates whether the cloud disk is encrypted. Valid values: true false	false
EncryptedKeyId	string	The ID of the Key Management Service (KMS) key that is used for the cloud disk.	05467897a-4262-4802-b8cb-00d3fb40****
DeleteWithInstance	boolean	Indicates whether the disk is released when the instance to which the disk is attached is released. Valid values: true: The disk is released when the associated instance is released. false: The disk is retained when the associated instance is released.	false
Tags	object
Tags	array<object>
	object
Key	string
Value	string
PageNumber	integer	Nomor halaman kueri saat ini.	1
PageSize	integer	Jumlah baris per halaman saat melakukan kueri terpaginasi. Nilai maksimum adalah 50 dan nilai default adalah 10.	50
RequestId	string	ID permintaan.	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
TotalCount	integer	Jumlah total halaman yang dikembalikan saat melakukan kueri terpaginasi.	13

Contoh

Respons sukses

JSONformat

{
  "Code": 0,
  "Disks": {
    "Disks": [
      {
        "Category": "local_ssd",
        "CreationTime": "2021-11-11T14:34:55+08:00",
        "DiskChargeType": "prepaid",
        "DiskId": "d-5svum1dx1w4a4spr54lgr****",
        "DiskName": "fvt-ecs-5cf0****",
        "EnsRegionId": "cn-guangzhou-10",
        "InstanceId": "i-5t77rb0yoz79m28ku60sx****",
        "InstanceName": "边缘prod环境串流机器-1063",
        "Description": "disk-description",
        "Size": 20,
        "Status": "Available",
        "Type": "1",
        "Portable": true,
        "SnapshotId": "s-bp67acfmxazb4p****",
        "SerialId": "123",
        "Encrypted": false,
        "EncryptedKeyId": "05467897a-4262-4802-b8cb-00d3fb40****",
        "DeleteWithInstance": false,
        "Tags": {
          "Tags": [
            {
              "Key": "",
              "Value": ""
            }
          ]
        }
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 50,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "TotalCount": 13
}

Kode kesalahan

HTTP status code	Error code	Error message
400	MissingParameter	The input parameter domainName that is mandatory for processing this request is not supplied.
400	InstanceIdNotFound	The input parameter instancdId that is not found.
400	NoPermission	Permission denied.
400	CallInterface	Call Interface Happen Error.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.