Gunakan Alibaba Cloud CLI untuk memanggil operasi API RPC dan ROA - Alibaba Cloud CLI

Topik ini menjelaskan sintaks perintah CLI Alibaba Cloud yang umum serta sintaks perintah operasi API dalam gaya panggilan prosedur jarak jauh (RPC) atau arsitektur berorientasi sumber daya (ROA).

Sintaks perintah umum

Dalam CLI Alibaba Cloud, Anda dapat menggunakan sintaks berikut untuk menjalankan perintah umum:

aliyun <Perintah> [SubPerintah] [Opsi dan Parameter]

Perintah: perintah tingkat atas.
- Anda dapat menentukan kode layanan Alibaba Cloud yang didukung oleh CLI Alibaba Cloud, seperti ecs atau rds.
- Anda juga dapat menentukan perintah CLI Alibaba Cloud, seperti configure.

SubPerintah: operasi yang ingin Anda lakukan.
- Jika perintah tingkat atas command diatur ke configure, operasi yang dijelaskan dalam topik Manajemen Kredensial Ganda didukung.
- Jika perintah tingkat atas command diatur ke kode layanan Alibaba Cloud dan operasinya dalam gaya RPC, Anda dapat menentukan nama operasi yang ingin Anda lakukan.

Opsi dan Parameter: opsi atau parameter yang digunakan untuk menentukan tindakan CLI Alibaba Cloud. Anda dapat menentukan angka, string, atau string JSON. Untuk informasi lebih lanjut, lihat Format Parameter.

Periksa gaya API

API layanan Alibaba Cloud diklasifikasikan menjadi dua gaya: RPC dan ROA. Sebagian besar layanan menggunakan gaya RPC. Saat menggunakan CLI Alibaba Cloud untuk memanggil operasi API, Anda harus menentukan gaya operasi tersebut karena metode pemanggilan bervariasi berdasarkan gaya API. Berikut adalah cara menentukan gaya operasi API:

Buka dokumentasi layanan Alibaba Cloud dari API yang ingin Anda panggil dan lihat gaya API dalam topik List of operations by function pada bab Development reference.
Tambahkan --help ke kode layanan Alibaba Cloud dari API yang ingin Anda panggil dalam perintah untuk mendapatkan operasi API dari layanan Alibaba Cloud. Output perintah bervariasi berdasarkan gaya operasi API.
- Jika deskripsi singkat dikembalikan, gaya API adalah RPC.
- Jika parameter PathPattern yang menunjukkan jalur permintaan dikembalikan, gaya API adalah ROA.
Untuk informasi lebih lanjut, lihat Gunakan Perintah Help.
Tambahkan --help ke nama suatu operasi API dalam perintah untuk mendapatkan parameter dari operasi API tersebut. Jika parameter Method dan PathPattern dikembalikan selain parameter dari operasi API, gaya API adalah ROA. Untuk informasi lebih lanjut, lihat bagian "Query the parameters of an API operation" pada topik Use the help command.

Dalam sebagian besar kasus, semua operasi API dari suatu layanan menggunakan gaya API yang sama. Setiap API hanya mendukung satu gaya. Untuk informasi lebih lanjut tentang gaya RPC dan ROA, lihat Gaya API.

Panggil operasi API bergaya RPC

Sintaks

Anda dapat menggunakan sintaks berikut untuk menjalankan perintah yang digunakan untuk memanggil operasi API bergaya RPC dengan menggunakan CLI Alibaba Cloud:

aliyun <KodeProduk> <NamaAPI> [Parameter]

KodeProduk: kode layanan Alibaba Cloud dari API yang ingin Anda panggil. Misalnya, kode Elastic Compute Service (ECS) adalah ecs.
NamaAPI: nama operasi API yang ingin Anda panggil. Misalnya, Anda dapat memanggil operasi DescribeRegions dari Elastic Compute Service.
Parameter: parameter permintaan untuk operasi API. Anda dapat melihat detail parameter permintaan dalam referensi API setiap layanan Alibaba Cloud dan menentukan parameter sebagai opsi.
Anda dapat menggunakan perintah --help untuk mendapatkan informasi bantuan tentang parameter di atas. Untuk informasi lebih lanjut, lihat Gunakan Perintah Help.

Contoh

Contoh ini menunjukkan cara memanggil operasi DescribeRegions dari ECS. Secara default, daftar wilayah terbaru ECS diperiksa. Untuk informasi lebih lanjut, lihat DescribeRegions.
```
aliyun ecs DescribeRegions
```
Contoh ini menunjukkan cara memanggil operasi DescribeInstanceAttribute dari ECS. Atribut instance ECS diperiksa. Untuk informasi lebih lanjut, lihat DescribeInstanceAttribute.
```
aliyun rds DescribeInstanceAttribute --InstanceId 'i-uf6f5trc95ug8t33****'
```

Panggil operasi API bergaya ROA

Sintaks

Anda dapat menggunakan sintaks berikut untuk menjalankan perintah yang digunakan untuk memanggil operasi API bergaya ROA dengan menggunakan CLI Alibaba Cloud:

 aliyun <KodeProduk> <Metode> <PolaJalur> [BadanPermintaan] [Parameter]

KodeProduk: kode layanan Alibaba Cloud dari API yang ingin Anda panggil. Misalnya, kode Container Service for Kubernetes (ACK) adalah cs.
Metode: metode permintaan. Anda dapat memilih metode permintaan yang sesuai berdasarkan referensi API. Metode permintaan umum termasuk GET, PUT, POST, dan DELETE.
PolaJalur: jalur permintaan. Anda dapat menentukan jalur permintaan yang valid berdasarkan referensi API.
BadanPermintaan: badan permintaan. Anda dapat menggunakan salah satu opsi berikut berdasarkan referensi API untuk menentukan badan permintaan.
- Gunakan opsi --body untuk menentukan string atau variabel sebagai badan permintaan.
- Gunakan opsi --body-file untuk menentukan jalur file. File tersebut digunakan sebagai badan permintaan.
Untuk informasi lebih lanjut, lihat Opsi Baris Perintah.
Parameter: parameter permintaan untuk operasi API. Anda dapat melihat detail parameter permintaan dalam referensi API dan menentukan parameter sebagai opsi.
Anda dapat menggunakan opsi --help untuk mendapatkan informasi bantuan tentang parameter di atas. Untuk informasi lebih lanjut, lihat Gunakan Perintah Help.

Contoh

Permintaan GET

Contoh ini menunjukkan cara memanggil operasi DescribeClustersForRegion dari ACK untuk menanyakan klaster khusus ACK di wilayah China (Hangzhou). Untuk informasi lebih lanjut, lihat DescribeClustersForRegion.

aliyun cs GET /regions/cn-hangzhou/clusters --cluster_type Kubernetes

Permintaan PUT

Contoh ini menunjukkan cara memanggil operasi ModifyCluster dari ACK untuk memodifikasi alamat IP elastis (EIP) yang terkait dengan klaster. Untuk informasi lebih lanjut, lihat ModifyCluster.

aliyun cs PUT /api/v2/clusters/cb95aa626a47740afbf6aa099b65**** --body "{\"api_server_eip\":true,\"api_server_eip_id\":\"eip-wz9fnasl6dsfhmvci****\"}"

Permintaan POST

Contoh ini menunjukkan cara memanggil operasi CreateCluster dari ACK untuk membuat klaster khusus ACK menggunakan file create.json. Untuk informasi lebih lanjut, lihat CreateCluster.

aliyun cs POST /clusters --body-file create.json

Contoh Kode File JSON

{
    "cluster_type":"Kubernetes",
    "name":"webService",
    "region_id":"cn-beijing",
    "disable_rollback":true,
    "timeout_mins":60,
    "kubernetes_version":"1.14.8-aliyun.1",
    "snat_entry":true,
    "endpoint_public_access":true,
    "ssh_flags":true,
    "cloud_monitor_flags":true,
    "deletion_protection":false,
    "node_cidr_mask":"26",
    "proxy_mode":"ipvs",
    "tags":[],
    "addons":[{"name":"flannel"},{"name":"arms-prometheus"},{"name":"flexvolume"},{"name":"alicloud-disk-controller"},{"name":"logtail-ds","config":"{"IngressDashboardEnabled":"false"}"},{"name":"ack-node-problem-detector","config":"{"sls_project_name":""}"},{"name":"nginx-ingress-controller","config":"{"IngressSlbNetworkType":"internet"}"}],
    "os_type":"Linux",
    "platform":"CentOS",
    "node_port_range":"30000-32767",
    "key_pair":"sian-sshkey",
    "cpu_policy":"none",
    "master_count":3,
    "master_vswitch_ids":["vsw-2zete8s4qocqg0mf6****","vsw-2zete8s4qocqg0mf6****","vsw-2zete8s4qocqg0mf6****"],
    "master_instance_types":["ecs.n4.large","ecs.n4.large","ecs.n4.large"],
    "master_system_disk_category":"cloud_ssd",
    "master_system_disk_size":120,
    "runtime":{"name":"docker","version":"18.09.2"},
    "worker_instance_types":["ecs.i1.xlarge"],
    "num_of_nodes":1,
    "worker_system_disk_category":"cloud_efficiency",
    "worker_system_disk_size":120,
    "vpcid":"vpc-2zecuu62b9zw7a7q****",
    "worker_vswitch_ids":["vsw-2zete8s4qocqg0mf6****"],
    "container_cidr":"172.20.0.0/16",
    "service_cidr":"172.21.0.0/20"
}

Permintaan DELETE

Contoh ini menunjukkan cara memanggil operasi DeleteClusterNodepool dari ACK untuk menghapus node pool tertentu dari klaster. Untuk informasi lebih lanjut, lihat DeleteClusterNodepool.

aliyun cs DELETE /clusters/cb95aa626a47740afbf6aa099b65****/nodepools/np30db56bcac7843dca90b999c8928****