DescribeProtocolService - Cloud Parallel File Storage - Alibaba Cloud Documentation Center

Mengkueri informasi layanan protokol.

Deskripsi operasi

Operasi ini hanya berlaku untuk sistem file CPFS.

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:DescribeProtocolService

list

*FileSystem

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ProtocolServiceIds	string	No	ID layanan protokol. Format: CSV Batas: Anda dapat menentukan maksimal 10 ID layanan protokol.	ptc-197ed6a00f2b**,ptc-196ed6a00f2b**
Status	string	No	Mencocokkan status layanan protokol. Format: CSV Nilai valid: Creating: Layanan protokol sedang dibuat. Starting: Layanan protokol sedang dimulai. Running: Layanan protokol tersedia. Updating: Layanan protokol sedang diperbarui. Deleting: Layanan protokol sedang dihapus. Stopping: Layanan protokol sedang dihentikan. Stopped: Layanan protokol dihentikan.	Running,Updating
NextToken	string	No	Jika hasil yang dikembalikan terpotong, Anda dapat menggunakan NextToken untuk memulai permintaan lain guna mendapatkan konten setelah bagian yang terpotong.	aBcdg==
MaxResults	integer	No	Jumlah maksimum hasil yang dikembalikan per kueri. Nilai maksimum: 100. Nilai minimum: 10. Nilai default: 20.	20
FileSystemId	string	Yes	ID sistem file.	cpfs-099394bd928c****
Description	string	No	Mencocokkan deskripsi layanan protokol atau sebagian deskripsi. Batas: Panjangnya adalah 2 hingga 128 karakter bahasa Inggris atau bahasa Mandarin. Harus diawali dengan huruf besar, huruf kecil, atau karakter bahasa Mandarin. Tidak dapat diawali dengan `http://` atau `https://`. Dapat berisi angka, titik dua (:), garis bawah (_), atau tanda hubung (-).	此协议服务的描述
ClientToken	string	No	Menjamin idempotensi permintaan. Buat nilai parameter dari klien Anda untuk memastikan nilai tersebut unik di antara berbagai permintaan. ClientToken hanya mendukung karakter ASCII dan tidak boleh melebihi 64 karakter. Untuk informasi lebih lanjut, lihat Cara memastikan idempotensi. Catatan Jika Anda tidak menentukan parameter ini, sistem secara otomatis menggunakan RequestId dari permintaan API sebagai ClientToken. RequestId dari setiap permintaan API mungkin berbeda.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Elemen respons

Element	Type	Description	Example
	object	Skema Respons.
RequestId	string	ID permintaan.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
NextToken	string	Penanda bagi pengguna untuk melanjutkan kueri layanan protokol yang tersisa.	aBcdeg==
ProtocolServices	array<object>	Daftar informasi layanan protokol.
	object	Informasi layanan protokol.
FileSystemId	string	ID sistem file.	cpfs-099394bd928c****
ProtocolServiceId	string	ID layanan protokol.	ptc-197ed6a00f2b****
ProtocolSpec	string	Spesifikasi kluster layanan protokol. Nilai valid: General Nilai default: General.	General
ProtocolThroughput	integer	Throughput layanan protokol. Unit: MB/s.	500
InstanceRAM	integer	Ukuran cache memori node protokol. Unit: GiB.	0
InstanceBaseThroughput	integer	Throughput dasar node protokol. Unit: MB/s.	100
InstanceBurstThroughput	integer	Throughput burst node protokol. Unit: MB/s.	100
MountTargetCount	integer	Jumlah total direktori CPFS dan Fileset yang diekspor dalam layanan protokol ini.	5
ProtocolType	string	Jenis protokol yang didukung oleh layanan protokol. Nilai valid: NFS: Layanan protokol mendukung akses melalui Protokol NFS.	NFS
Status	string	Status layanan protokol. Nilai valid: Creating: Layanan protokol sedang dibuat. Starting: Layanan protokol sedang dimulai. Running: Layanan protokol tersedia. Updating: Layanan protokol sedang diperbarui. Deleting: Layanan protokol sedang dihapus. Stopping: Layanan protokol sedang dihentikan. Stopped: Layanan protokol dihentikan.	Running
Description	string	Deskripsi layanan protokol. Batas: Panjangnya adalah 2 hingga 128 karakter bahasa Inggris atau bahasa Mandarin. Harus diawali dengan huruf besar, huruf kecil, atau karakter bahasa Mandarin. Tidak dapat diawali dengan `http://` atau `https://`. Dapat berisi angka, titik dua (:), garis bawah (_), atau tanda hubung (-).	此协议服务的描述
CreateTime	string	Waktu pembuatan layanan protokol, dalam UTC.	2018-12-12T07:28:38Z
ModifyTime	string	Waktu modifikasi layanan protokol, dalam UTC.	2018-12-12T07:28:38Z
VpcId	string	ID VPC yang terkait dengan layanan protokol.	vpc-123xxx
VSwitchId	string	ID vSwitch yang terkait dengan layanan protokol.	vsw-123xxx

Contoh

Respons sukses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "NextToken": "aBcdeg==",
  "ProtocolServices": [
    {
      "FileSystemId": "cpfs-099394bd928c****",
      "ProtocolServiceId": "ptc-197ed6a00f2b****",
      "ProtocolSpec": "General",
      "ProtocolThroughput": 500,
      "InstanceRAM": 0,
      "InstanceBaseThroughput": 100,
      "InstanceBurstThroughput": 100,
      "MountTargetCount": 5,
      "ProtocolType": "NFS",
      "Status": "Running",
      "Description": "此协议服务的描述",
      "CreateTime": "2018-12-12T07:28:38Z",
      "ModifyTime": "2018-12-12T07:28:38Z",
      "VpcId": "vpc-123xxx",
      "VSwitchId": "vsw-123xxx"
    }
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message
400	MissingFileSystemId	FileSystemId is mandatory for this action.
400	InvalidParam.TooManyProtocolServiceIds	Too many protocol service ids given.
403	InvalidStatus.NotSupported	The specified protocol service status does not support.
404	InvalidFileSystem.NotFound	The specified file system does not exist.
404	InvalidParameter.InvalidNextToken	The specified NextToken is invaild.
404	InvalidParameter.InvalidMaxResults	The specified MaxResults is invalid.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.