DescribeFileSystems - File Storage NAS - Alibaba Cloud Documentation Center

Mengkueri informasi sistem file.

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

nas:DescribeFileSystems

get

*FileSystem

acs:nas:{#regionId}:{#accountId}:filesystem/{#FileSystemId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
FileSystemId	string	No	ID sistem file. NAS umum: 31a8e4**. Extreme NAS: harus diawali dengan extreme-, seperti extreme-0015. Cloud Parallel File Storage (CPFS) (redundansi lokal): harus diawali dengan cpfs-, seperti cpfs-125487. CPFS SE (redundansi zona): harus diawali dengan cpfsse-, seperti cpfsse-022c71b134**.	31a8e4****
FileSystemType	string	No	Tipe sistem file. Nilai valid: all (default): mengkueri semua tipe. standard: NAS umum. extreme: Extreme NAS. cpfs: Cloud Parallel File Storage (CPFS) (redundansi lokal). cpfsse: CPFS SE (redundansi zona). Catatan Untuk mengkueri beberapa tipe, pisahkan dengan koma (,).	standard
VpcId	string	No	ID virtual private cloud (VPC). VPC harus sama dengan VPC dari server Elastic Computing Service (ECS) tempat Anda akan memasang sistem file.	vpc-bp1sevsgtqvk5gxbl****
PageSize	integer	No	Jumlah sistem file pada setiap halaman saat melakukan kueri berhalaman. Nilai valid: 1 hingga 100. Nilai default: 10.	1
PageNumber	integer	No	Nomor halaman daftar sistem file. Nilai awal (nilai default): 1.	1
StorageType	string	No
Tag	array<object>	No	Informasi tag.
	object	No	Informasi tag.
Key	string	No	Kunci tag. Batasan: Nilai valid N: 1 hingga 20. Panjang kunci tag maksimal 128 karakter. Kunci tag tidak boleh diawali dengan `aliyun` atau `acs:`. Kunci tag tidak boleh mengandung `http://` atau `https://`.	testKey
Value	string	No	Nilai tag. Batasan: Nilai valid N: 1 hingga 20. Panjang nilai tag maksimal 128 karakter. Nilai tag tidak boleh diawali dengan `aliyun` atau `acs:`. Nilai tag tidak boleh mengandung `http://` atau `https://`.	testValue
ResourceGroupId	string	No	ID kelompok sumber daya. Anda dapat melihat ID kelompok sumber daya di Tampilan Konsol Resource Management.	rg-acfmwavnfef****

Elemen respons

Element	Type	Description	Example
	object
FileSystems	object
FileSystem	array<object>	Daftar sistem file.
	array<object>
Status	string	Status sistem file. Nilai valid: Pending: Sistem file sedang memproses node. Running: Sistem file aktif. Anda dapat melakukan tindakan berikutnya (seperti membuat Titik pemasangan) hanya ketika statusnya Running. Stopped: Sistem file tidak tersedia. Extending: Sistem file sedang diskalakan keluar. Stopping: Sistem file sedang dihentikan. Deleting: Sistem file sedang dihapus.	Pending
MeteredIASize	integer	Penggunaan penyimpanan kelas penyimpanan IA. Unit: byte.	362832
Capacity	integer	Kapasitas sistem file. Unit: GiB.	100
CreateTime	string	Pengatur waktu pembuatan sistem file.	2020-01-05T16:00:00Z
ChargeType	string	Metode penagihan. Nilai valid: Subscription: langganan. PayAsYouGo: bayar sesuai pemakaian. Package: paket penyimpanan terlampir.	PayAsYouGo
Tags	object
Tag	array<object>	Informasi tag sistem file.
	object
Key	string	Kunci tag.	testKey
Value	string	Nilai tag.	testValue
StorageType	string	Jenis penyimpanan. Nilai valid: NAS tujuan umum: Capacity, Performance, Premium Extreme NAS: standard, advance CPFS: advance_100 (garis dasar 100 MB/s/TiB), advance_200 (garis dasar 200 MB/s/TiB), economic CPFS SE: advance_100 (garis dasar 100 MB/s/TiB)	Performance
MeteredSize	integer	Penggunaan penyimpanan standar sistem file. Ini bukan nilai waktu nyata. Ini mewakili penggunaan maksimum pada jam sebelumnya. Unit: byte. Catatan Untuk melihat total kapasitas penyimpanan sistem file, lihat Tampilan Penggunaan sumber daya sistem file.	1611661312
Description	string	Deskripsi sistem file.	test
Bandwidth	integer	Bandwidth sistem file. Unit: MB/s. Bidang ini tidak dikembalikan untuk sistem file NAS tujuan umum.	150
SupportedFeatures	object
SupportedFeature	array	Fitur yang didukung oleh sistem file.
	string	Fitur yang didukung oleh sistem file. Nilai valid: Lifecycle: manajemen siklus hidup. ACL: daftar kontrol akses. Ipv6: IPv6. Catatan Saat ini, hanya sistem file Extreme NAS di wilayah Tiongkok daratan yang mendukung IPv6.	Lifecycle
Version	string	Nomor versi sistem file. Bidang ini berlaku untuk sistem file Extreme NAS dan CPFS.	2.3.4
ProtocolType	string	Jenis protokol sistem file. Nilai valid: NFS: Protokol NFS. SMB: Protokol SMB. cpfs: jenis protokol yang didukung oleh sistem file CPFS atau CPFS SE.	NFS
MountTargets	object
MountTarget	array<object>	Informasi Titik pemasangan.
	array<object>
VpcId	string	ID VPC.	vpc-bp1sevsgtqvk5gxbl****
Status	string	Status Titik pemasangan. Nilai valid: Active: tersedia. Inactive: tidak tersedia. Pending: memproses tugas. Deleting: sedang dihapus. Hibernating: memasuki hibernasi. Hibernated: dalam keadaan hibernasi.	Active
ClientMasterNodes	object
ClientMasterNode	array<object>	Informasi node manajemen klien. Parameter ini hanya dikembalikan untuk sistem file CPFS.
	object
EcsId	string	ID Instance ECS dari node manajemen.	i-hp3i3odi5ory1buo****
DefaultPasswd	string	Kata sandi logon default node manajemen.	123456
EcsIp	string	Alamat IP Instance ECS untuk node manajemen.	192.168.1.0
MountTargetDomain	string	Domain Titik pemasangan.	109c042666-w****.cn-hangzhou.nas.aliyuncs.com
AccessGroupName	string	Nama kelompok izin yang digunakan oleh Titik pemasangan.	test-001
DualStackMountTargetDomain	string	Domain Titik pemasangan dual-stack (IPv4 dan IPv6). Catatan Hanya sistem file Extreme NAS di wilayah Tiongkok daratan yang mendukung IPv6.	174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com
VswId	string	ID vSwitch.	vsw-bp1omfzsszekkvaxn****
Tags	object
Tag	array<object>	Informasi tag Titik pemasangan.
	object
Key	string	Kunci tag.	testKey
Value	string	Nilai tag.	testValue
NetworkType	string	Jenis jaringan. Nilainya adalah vpc, yang menunjukkan VPC.	vpc
KMSKeyId	string	ID kunci KMS.	0e478b7a-4262-4802-b8cb-00d3fb40****
AutoSnapshotPolicyId	string	ID kebijakan Snapshot otomatis.	sp-extreme-09npwxadu1eqvw****
RegionId	string	ID Wilayah.	cn-hangzhou
FileSystemType	string	Jenis sistem file. Nilai valid: standard: NAS tujuan umum. extreme: Extreme NAS. cpfs: Cloud Parallel File Storage (CPFS), redundan lokal. cpfsse: CPFS SE, redundan zona.	standard
FileSystemId	string	ID sistem file.	109c04****
EncryptType	integer	Jenis Enkripsi. Nilai valid: 0: tidak dienkripsi. 1: kunci yang dikelola NAS. 2: Kunci Kustom (KMS).	1
Ldap	object	Informasi konfigurasi LDAP. Parameter ini hanya dikembalikan untuk sistem file CPFS.
BindDN	string	Distinguished Name (DN) yang digunakan untuk mengikat ke server LDAP.	cn=alibaba,dc=com
SearchBase	string	Basis pencarian LDAP.	dc=example
URI	string	Alamat server LDAP.	ldap://ldap.example.example
ExpiredTime	string	Pengatur waktu kedaluwarsa sistem file.	2020-01-05T16:00:00Z
ZoneId	string	Zona tempat sistem file berada.	cn-hangzhou-b
VpcId	string	ID VPC.	vpc-bp1sevsgtqvk5gxbl****
VswIds	object
VswId	array	Informasi vSwitch.
	string	ID vSwitch.	vsw-bp1omfzsszekkvaxn****
Packages	object
Package	array<object>	Informasi Paket penyimpanan.
	object
StartTime	string	Waktu mulai Paket penyimpanan.	2019-12-05T01:40:56Z
ExpiredTime	string	Pengatur waktu kedaluwarsa Paket penyimpanan.	2020-01-05T16:00:00Z
Size	integer	Kapasitas Paket penyimpanan. Unit: byte.	107374182400
PackageId	string	ID Paket penyimpanan.	naspackage-0be9c4b624-37****
PackageType	string	Jenis Paket penyimpanan. Nilai valid: ssd: Performance. hybrid: Capacity.	hybrid
AccessPointCount	string	Jumlah titik akses.	1
ResourceGroupId	string	ID kelompok sumber daya.	rg-acfmwavnfef****
MeteredArchiveSize	integer	Penggunaan penyimpanan kelas penyimpanan arsip. Unit: byte.	1611661312
Options	object	Opsi.
EnableOplock	boolean	Apakah fitur OpLock diaktifkan. Nilai valid: true: Diaktifkan. false: Dinonaktifkan. Catatan Hanya sistem file yang menggunakan Jenis Protokol SMB yang mendukung fitur ini.	true
VscAccessPointAccessOnly	boolean
EnableABE	boolean
QuorumVswId	string	ID vSwitch.	vsw-bp1omfzsszekkvaxn****
VscTarget	string	Catatan Parameter ini belum tersedia.	cpfs-370y1tv921vpuj4****-000001.cn-wulanchabu.cpfs.aliyuncs.com
RedundancyType	string	Jenis redundansi penyimpanan. Bidang ini memiliki nilai hanya untuk sistem file CPFS SE.	LRS
RedundancyVSwitchIds	object
RedundancyVSwitchId	array	Daftar ID vSwitch redundan zona.
	string	Daftar ID vSwitch redundan zona. Bidang ini memiliki nilai ketika RedundancyType diatur ke ZRS.	vsw-123xxx
RequestId	string	ID permintaan.	035B3A3A-E514-4B41-B906-5D906CFB****
TotalCount	integer	Jumlah total sistem file.	1
PageSize	integer	Jumlah sistem file pada setiap halaman.	1
PageNumber	integer	Nomor halaman daftar sistem file.	1

Contoh

Respons sukses

JSONformat

{
  "FileSystems": {
    "FileSystem": [
      {
        "Status": "Pending",
        "MeteredIASize": 362832,
        "Capacity": 100,
        "CreateTime": "2020-01-05T16:00:00Z",
        "ChargeType": "PayAsYouGo",
        "Tags": {
          "Tag": [
            {
              "Key": "testKey",
              "Value": "testValue"
            }
          ]
        },
        "StorageType": "Performance",
        "MeteredSize": 1611661312,
        "Description": "test",
        "Bandwidth": 150,
        "SupportedFeatures": {
          "SupportedFeature": [
            "Lifecycle"
          ]
        },
        "Version": "2.3.4",
        "ProtocolType": "NFS",
        "MountTargets": {
          "MountTarget": [
            {
              "VpcId": "vpc-bp1sevsgtqvk5gxbl****",
              "Status": "Active",
              "ClientMasterNodes": {
                "ClientMasterNode": [
                  {
                    "EcsId": "i-hp3i3odi5ory1buo****",
                    "DefaultPasswd": "123456",
                    "EcsIp": "192.168.1.0"
                  }
                ]
              },
              "MountTargetDomain": "109c042666-w****.cn-hangzhou.nas.aliyuncs.com",
              "AccessGroupName": "test-001",
              "DualStackMountTargetDomain": "174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com",
              "VswId": "vsw-bp1omfzsszekkvaxn****",
              "Tags": {
                "Tag": [
                  {
                    "Key": "testKey",
                    "Value": "testValue"
                  }
                ]
              },
              "NetworkType": "vpc"
            }
          ]
        },
        "KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****",
        "AutoSnapshotPolicyId": "sp-extreme-09npwxadu1eqvw****",
        "RegionId": "cn-hangzhou",
        "FileSystemType": "standard",
        "FileSystemId": "109c04****",
        "EncryptType": 1,
        "Ldap": {
          "BindDN": "cn=alibaba,dc=com",
          "SearchBase": "dc=example",
          "URI": "ldap://ldap.example.example"
        },
        "ExpiredTime": "2020-01-05T16:00:00Z",
        "ZoneId": "cn-hangzhou-b",
        "VpcId": "vpc-bp1sevsgtqvk5gxbl****\n",
        "VswIds": {
          "VswId": [
            "vsw-bp1omfzsszekkvaxn****\n"
          ]
        },
        "Packages": {
          "Package": [
            {
              "StartTime": "2019-12-05T01:40:56Z",
              "ExpiredTime": "2020-01-05T16:00:00Z",
              "Size": 107374182400,
              "PackageId": "naspackage-0be9c4b624-37****",
              "PackageType": "hybrid"
            }
          ]
        },
        "AccessPointCount": "1",
        "ResourceGroupId": "rg-acfmwavnfef****\n",
        "MeteredArchiveSize": 1611661312,
        "Options": {
          "EnableOplock": true,
          "VscAccessPointAccessOnly": false,
          "EnableABE": false
        },
        "QuorumVswId": "vsw-bp1omfzsszekkvaxn****",
        "VscTarget": "cpfs-370y1tv921vpuj4****-000001.cn-wulanchabu.cpfs.aliyuncs.com",
        "RedundancyType": "LRS",
        "RedundancyVSwitchIds": {
          "RedundancyVSwitchId": [
            "vsw-123xxx"
          ]
        }
      }
    ]
  },
  "RequestId": "035B3A3A-E514-4B41-B906-5D906CFB****",
  "TotalCount": 1,
  "PageSize": 1,
  "PageNumber": 1
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	Region.NotSupported	The specified Region is not supported for this API now.	Fitur ini tidak didukung di wilayah saat ini.
404	InvalidFileSystem.NotFound	The specified file system does not exist.	Sistem file yang ditentukan tidak ada.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.