Persyaratan Format untuk Parameter dari Berbagai Tipe Data di Alibaba Cloud CLI - Alibaba Cloud CLI

Topik ini menjelaskan persyaratan format untuk parameter dari berbagai tipe data yang dimasukkan di Alibaba Cloud CLI.

Persyaratan untuk format parameter

Catatan

Alibaba Cloud CLI menyediakan kode contoh yang dihasilkan secara otomatis oleh OpenAPI Explorer. Untuk informasi lebih lanjut, lihat Hasilkan dan jalankan perintah CLI.

Secara default, kode contoh yang dihasilkan oleh OpenAPI Explorer menggunakan format parameter yang sesuai untuk Linux. Jika Anda ingin menjalankan perintah CLI di lingkungan lain, sesuaikan format parameternya sesuai kebutuhan.

Untuk parameter dari berbagai tipe data dalam operasi API, Anda harus memenuhi format berikut saat memasukkan nama dan nilai parameter di Alibaba Cloud CLI:

Huruf besar/kecil pada nama parameter

Nama parameter dalam operasi API bersifat peka terhadap huruf besar/kecil. Saat memasukkan nama parameter di Alibaba Cloud CLI, pastikan untuk mengikuti konvensi kapitalisasi yang ditentukan.

Kesensitifan huruf besar/kecil pada nilai parameter

Beberapa nilai parameter dalam operasi API tidak peka terhadap huruf besar/kecil. Namun, untuk memastikan konsistensi gaya penulisan, disarankan agar Anda mengikuti konvensi kapitalisasi nilai parameter saat memasukkan nilai tersebut.

Nilai parameter bertipe INTEGER

Anda dapat langsung menuliskan nilai bertipe INTEGER pada parameter.

aliyun ecs DescribeImages --ImageName Example_Image --Pagesize 10

Nilai parameter bertipe STRING dalam dokumentasi API

Anda dapat langsung menulis nilai bertipe STRING di parameter jika nilai-nilai tersebut tidak mengandung karakter khusus seperti tanda dolar ($), aksen grave (`), garis miring terbalik (\), atau spasi. Jika nilai bertipe STRING mengandung karakter khusus, apit nilai-nilai tersebut dengan tanda kutip tunggal (' ') atau tanda kutip ganda (" ") saat memasukkan nilai-nilai tersebut.

Skenario umum
Saat Alibaba Cloud CLI menerima string sebagai parameter, karakter khusus dalam string dikonversi menjadi karakter biasa. Di Linux, macOS, atau Windows PowerShell, gunakan tanda kutip tunggal (' ') untuk mengapit parameter. Di Windows Shell, gunakan tanda kutip ganda (" ") untuk mengapit parameter.
- Tanpa karakter khusus:
```
aliyun ecs DescribeImages --ImageName Example_Image
```
- Dengan karakter khusus:
  - Windows Command Prompt:
```
aliyun ecs DescribeImages --ImageName "Example Image"
```
  - Linux, macOS, dan Windows PowerShell:
```
aliyun ecs DescribeImages --ImageName 'Example Image'
```
Skema khusus
Saat Anda memanggil operasi API bergaya ROA, jika Anda perlu menggunakan opsi --body untuk menentukan string yang mengandung karakter escape atau variabel sebagai badan permintaan, penggunaan tanda kutip berbeda dari skenario umum. Di Linux, macOS, dan Windows Command Prompt, gunakan tanda kutip ganda (" ") untuk mengapit parameter. Di Windows PowerShell, gunakan tanda kutip tunggal (' ') untuk mengapit parameter.
- Windows Command Prompt, Linux, dan macOS:
```
aliyun cs PUT /clusters/<ClusterId>/nodepools/<NodepoolId> --body "{\"nodepool_info\":{\"name\":\"default-nodepool\",\"resource_group_id\":\"rg-acfmyvw****\"}}"
```
- Windows PowerShell:
```
aliyun cs PUT /clusters/<ClusterId>/nodepools/<NodepoolId> --body '{\"nodepool_info\":{\"name\":\"default-nodepool\",\"resource_group_id\":\"rg-acfmyvw****\"}}'
```

Daftar bertipe STRING

Jika parameter bertipe STRING mendukung beberapa nilai, seperti ImageId, pisahkan nilai-nilai tersebut dengan koma (,) dan apit dengan tanda kutip tunggal (' ') atau tanda kutip ganda (" ") saat memasukkan nilai-nilai tersebut.

Windows Command Prompt:
Di Windows Command Prompt, pisahkan nilai-nilai tersebut dengan koma (,) dan apit dengan tanda kutip ganda (" ").
```
aliyun ecs DescribeImages --ImageId "m-23e0o****,m-23wae****"
```
Linux, macOS, dan Windows PowerShell:
Di Linux, macOS, dan Windows PowerShell, pisahkan nilai-nilai tersebut dengan koma (,) dan apit dengan tanda kutip tunggal (' ').
```
aliyun ecs DescribeImages --ImageId 'm-23e0o****,m-23wae****'
```

Array JSON bertipe STRING

Untuk menetapkan parameter bertipe STRING sebagai array JSON yang diformat, gunakan format berikut:

Windows:
Di Windows Command Prompt dan PowerShell, apit array dalam tanda kurung siku ([ ]) dan apit tanda kurung siku ([ ]) dalam tanda kutip ganda (" "). Di dalam tanda kurung siku ([ ]), pisahkan nilai-nilai dalam array dengan koma (,) dan apit setiap nilai dalam tanda kutip tunggal (' ').
```
aliyun ecs DescribeDisks --DiskIds "['d-23rss****','d-23vsi****','d-23sfq****']"
```
Linux dan macOS:
Di Linux dan macOS, apit array dalam tanda kurung siku ([ ]) dan apit tanda kurung siku ([ ]) dalam tanda kutip tunggal (' '). Di dalam tanda kurung siku ([ ]), pisahkan nilai-nilai dalam array dengan koma (,) dan apit setiap nilai dalam tanda kutip ganda (" ").
```
aliyun ecs DescribeDisks --DiskIds '["d-23rss****","d-23vsi****","d-23sfq****"]'
```

Daftar array JSON bertipe STRING

Untuk menetapkan parameter bertipe STRING sebagai daftar array JSON, gunakan format berikut:

Windows:
Di Windows Command Prompt dan Windows Command Prompt, apit daftar dalam tanda kurung siku ([ ]) dan apit tanda kurung siku ([ ]) dalam tanda kutip ganda (" "). Di dalam tanda kurung siku ([ ]), pisahkan array dengan koma (,) dan apit setiap array dalam tanda kurung kurawal ({ }). Di dalam setiap pasangan tanda kurung kurawal ({ }), pisahkan kunci dan nilai array dengan titik dua (:) dan apit kunci dan nilai array dalam tanda kutip tunggal (' ').
```
aliyun slb AddBackendServers --LoadBalancerId 15157b19f18-cn-hangzhou-dg**** --BackendServers "[{'ServerId':'i-23g8a****'},{'ServerId':'i-23bb0****'}]"
```
Linux dan macOS:
Di Linux dan macOS, apit daftar dalam tanda kurung siku ([ ]) dan apit tanda kurung siku ([ ]) dalam tanda kutip tunggal (' '). Di dalam tanda kurung siku ([ ]), pisahkan array dengan koma (,) dan apit setiap array dalam tanda kurung kurawal ({ }). Di dalam setiap pasangan tanda kurung kurawal ({ }), pisahkan kunci dan nilai array dengan titik dua (:) dan apit kunci dan nilai array dalam tanda kutip ganda (" ").
```
aliyun slb AddBackendServers --LoadBalancerId 15157b19f18-cn-hangzhou-dg**** --BackendServers '[{"ServerId":"i-23g8a****"},{"ServerId":"i-23bb0****"}]'
```

Nilai DateTime bertipe STRING

Untuk menetapkan parameter bertipe STRING sebagai cap waktu UTC dalam standar ISO 8601, masukkan nilai parameter dalam format YYYY-MM-DDThh:mm:ssZ.

aliyun ecs DescribeInstanceMonitorData --InstanceId i-94ola4btx**** --StartTime 2015-11-28T15:00:00Z --EndTime 2015-11-28T18:00:00Z

Karakter khusus

Jika Anda memasukkan nilai parameter yang mengandung karakter khusus, kesalahan penguraian dapat terjadi meskipun nilai tersebut diapit dalam tanda kutip. Untuk mengatasi masalah ini, masukkan nilai parameter dalam format key=value.

Contoh

Pada perintah berikut, Alibaba Cloud CLI tidak dapat mengenali -1/-1 sebagai nilai dari PortRange.

aliyun ecs AuthorizeSecurityGroup --SecurityGroupId 'sg-bp67acfmxazb4p****' --Permissions.1.PortRange "-1/-1" --method POST --force

Untuk menyelesaikan masalah ini, ganti --PortRange -1/-1 dengan --PortRange=-1/-1, seperti yang ditunjukkan dalam blok kode berikut:

aliyun ecs AuthorizeSecurityGroup --SecurityGroupId 'sg-bp67acfmxazb4p****' --Permissions.1.PortRange=-1/-1 --method POST --force