Contoh integrasi CLI Alibaba Cloud - ApsaraDB RDS

CLI Alibaba Cloud adalah alat baris perintah serbaguna yang dikembangkan berdasarkan API. Anda dapat menggunakannya untuk berinteraksi dengan ApsaraDB RDS dan mengelola instance ApsaraDB RDS di shell. Topik ini menjelaskan cara menggunakan CLI Alibaba Cloud untuk memanggil operasi API ApsaraDB RDS.

Sebelum Anda mulai

Untuk informasi lebih lanjut tentang CLI Alibaba Cloud, lihat Apa itu CLI Alibaba Cloud?

Instal CLI Alibaba Cloud

Anda harus menginstal CLI Alibaba Cloud sebelum menggunakannya. CLI Alibaba Cloud tersedia untuk sistem operasi Windows, Linux, dan macOS. Pilih paket instalasi sesuai dengan sistem operasi perangkat Anda. Untuk detail lebih lanjut, lihat topik-topik berikut:

Sistem operasi Windows: Instal CLI Alibaba Cloud di Windows.
Sistem operasi Linux: Instal CLI Alibaba Cloud di Linux.
Sistem operasi macOS: Instal CLI Alibaba Cloud di macOS.

Anda juga dapat menggunakan Cloud Shell dari Alibaba Cloud untuk men-debug perintah yang ingin dijalankan di CLI Alibaba Cloud. Untuk informasi lebih lanjut tentang Cloud Shell, lihat Apa itu Cloud Shell?

Konfigurasikan CLI Alibaba Cloud

Penting

Akun Alibaba Cloud memiliki izin penuh untuk mengelola dan mengakses API semua layanan Alibaba Cloud. Namun, penggunaan akun utama untuk memanggil operasi API dapat menimbulkan risiko keamanan. Kami merekomendasikan agar Anda membuat dan menggunakan pengguna RAM untuk memanggil operasi API atau melakukan operasi O&M rutin. Jika Anda ingin menggunakan pengguna RAM untuk mengelola instance RDS, lampirkan kebijakan AliyunRDSReadOnlyAccess ke pengguna RAM untuk memberikan izin hanya-baca pada instance RDS. Atau, lampirkan kebijakan AliyunRDSFullAccess jika diperlukan oleh kebutuhan bisnis Anda untuk memberikan izin penuh pada instance RDS.

Sebelum menggunakan CLI Alibaba Cloud, konfigurasikan informasi seperti kredensial identitas dan ID wilayah. CLI Alibaba Cloud mendukung berbagai jenis kredensial identitas. Untuk informasi lebih lanjut, lihat Jenis-jenis kredensial. Contoh ini menggunakan kredensial AccessKey.

Buat pengguna RAM dan berikan izin untuk mengelola layanan Alibaba Cloud sesuai kebutuhan bisnis Anda. Untuk detail lebih lanjut, lihat Buat pengguna RAM dan Berikan izin kepada pengguna RAM.
Buat pasangan AccessKey untuk pengguna RAM dan catat ID AccessKey serta Rahasia AccessKey untuk konfigurasi kredensial identitas. Untuk informasi lebih lanjut, lihat Buat pasangan AccessKey untuk pengguna RAM.
Peroleh dan catat ID wilayah yang tersedia untuk konfigurasi kredensial identitas. CLI Alibaba Cloud menggunakan ID wilayah tertentu untuk memulai pemanggilan API. Untuk informasi lebih lanjut tentang wilayah yang tersedia, lihat Titik akhir.
Catatan
Saat menggunakan CLI Alibaba Cloud, Anda dapat menggunakan opsi --region untuk menjalankan perintah di wilayah tertentu. Jika Anda menggunakan opsi tersebut, CLI Alibaba Cloud akan mengabaikan informasi wilayah dalam konfigurasi kredensial default dan pengaturan variabel lingkungan. Untuk informasi lebih lanjut, lihat Opsi baris perintah.
Gunakan pasangan AccessKey dari pengguna RAM untuk mengonfigurasi kredensial identitas di file konfigurasi bernama AkProfile. Untuk informasi lebih lanjut, lihat Contoh konfigurasi.

Hasilkan perintah CLI

Kunjungi halaman Debugging dari API ApsaraDB RDS.
Di left-side search box halaman yang muncul, cari operasi yang ingin dipanggil. Pada tab Parameters, konfigurasikan parameter berdasarkan dokumentasi API. Anda dapat melihat contoh perintah CLI yang dihasilkan di tab CLI Example di sebelah kanan.
- Klik ikon untuk melihat informasi tentang Cloud Shell. Untuk informasi lebih lanjut, lihat Apa itu Cloud Shell? Kemudian, selesaikan pen-debug-an perintah.
- Klik ikon untuk menyalin contoh perintah ke clipboard. Anda juga dapat menempelkan contoh perintah ke shell Anda untuk dijalankan.
  - Saat menempelkan contoh perintah ke shell Anda untuk pen-debug-an, perhatikan format parameter. Untuk informasi lebih lanjut tentang format parameter CLI Alibaba Cloud, lihat Format parameter.
  - Secara default, OpenAPI Explorer menambahkan opsi --region ke perintah CLI yang dihasilkan. Saat menyalin perintah ke shell Anda, CLI Alibaba Cloud mengabaikan informasi wilayah dalam konfigurasi kredensial default dan pengaturan variabel lingkungan, dan secara prioritas menjalankan perintah di wilayah yang ditentukan. Anda dapat menghapus atau menyimpan opsi tersebut sesuai kebutuhan bisnis Anda.

Panggil operasi API layanan cloud

Sintaksis

Di CLI Alibaba Cloud, gunakan sintaksis berikut untuk menjalankan perintah. Untuk informasi lebih lanjut, lihat Struktur perintah.

aliyun <command> <subcommand> [opsi dan parameter]

Opsi perintah

Saat menggunakan CLI Alibaba Cloud, Anda dapat menentukan opsi perintah untuk mengubah perilaku perintah atau menerapkan fitur tambahan. Berikut adalah beberapa opsi perintah yang umum digunakan:

--profile<profileName>: Gunakan opsi --profile dan parameter profileName untuk menentukan profil konfigurasi. Setelah menentukan profil konfigurasi yang valid, CLI Alibaba Cloud akan mengabaikan informasi dalam konfigurasi kredensial default dan pengaturan variabel lingkungan, serta menggunakan konfigurasi yang Anda tentukan untuk menjalankan perintah.
--help: Gunakan opsi --help untuk mendapatkan informasi bantuan tentang perintah. Untuk informasi lebih lanjut, lihat Gunakan perintah bantuan.

Untuk informasi lebih lanjut, lihat Opsi baris perintah.

Contoh kode

Contoh 1: Contoh kode berikut menjelaskan cara menggunakan opsi --help untuk mendapatkan daftar operasi API ApsaraDB RDS yang didukung oleh CLI Alibaba Cloud. Anda juga dapat melihat operasi API yang dapat dipanggil di Daftar operasi berdasarkan fungsi.

Jalankan perintah berikut:
```
aliyun rds --help
```

Lihat hasilnya.

Keluaran perintah

Alibaba Cloud Command Line Interface Versi 3.0.216

Penggunaan:
  aliyun rds <ApiName> --parameter1 nilai1 --parameter2 nilai2 ...

Produk: Rds (ApsaraDB for RDS)
Versi: 2014-08-15

Daftar Api Tersedia:
  ActivateMigrationTargetInstance             Mengalihkan beban kerja dari instance PostgreSQL sumber ke instance ApsaraDB RDS for PostgreSQL tujuan.
  AddTagsToResource                           Menambahkan tag ke instance.
  AllocateInstancePublicConnection            Meminta endpoint publik untuk instance ApsaraDB RDS
  AllocateReadWriteSplittingConnection        Meminta endpoint routing baca-saja untuk instance.
  AttachWhitelistTemplateToInstance           Mengasosiasikan template whitelist dengan instance.
  CalculateDBInstanceWeight                   Menanyakan bobot baca yang ditetapkan sistem.

...

Contoh 2: Contoh kode berikut menjelaskan cara menggunakan CLI Alibaba Cloud untuk memanggil operasi DescribeDBInstanceAttribute dari ApsaraDB RDS.

Jalankan perintah berikut:

aliyun rds DescribeDBInstanceAttribute --region cn-hangzhou --DBInstanceId 'pgm-bp16k272p478****'

Lihat hasilnya.

Keluaran perintah

{
        "Items": {
                "DBInstanceAttribute": [
                        {
                                "AccountMaxQuantity": 99999,
                                "AccountType": "Mix",
                                "AdvancedFeatures": "LinkedServer,DistributeTransaction",
                                "AutoUpgradeMinorVersion": "Auto",
                                "AvailabilityValue": "100.0%",
                                "BabelfishConfig": {},
                                "CanTempUpgrade": false,
                                "Category": "HighAvailability",
                                "ColdDataEnabled": false,
                                "ConnectionMode": "Standard",
                                "ConnectionString": "pgm-bp16k272p478****.pg.rds.aliyuncs.com",
                                "ConsoleVersion": "2",
                                "CreationTime": "2024-08-06T06:18:48Z",
                                "CurrentKernelVersion": "rds_postgres_1400_20240530",
                                "DBClusterNodes": {
                                        "DBClusterNode": []
                                },
                                "DBInstanceCPU": "2",
                                "DBInstanceClass": "pg.n4.2c.2m",
                                "DBInstanceClassType": "x",
                                "DBInstanceDescription": "DB-test",
                                "DBInstanceDiskUsed": 3520069632,
                                "DBInstanceId": "pgm-bp16k272p478****",
                                "DBInstanceMemory": 8192,
                                "DBInstanceNetType": "Intranet",
                                "DBInstanceStatus": "Running",
                                "DBInstanceStorage": 100,
                                "DBInstanceStorageType": "cloud_essd",
                                "DBInstanceType": "Primary",
                                "DBMaxQuantity": 99999,
                                "DedicatedHostGroupId": "",
                                "DeletionProtection": false,
                                "DispenseMode": "MultiAVZDispenseMode",
                                "Engine": "PostgreSQL",
                                "EngineVersion": "14.0",
                                "ExpireTime": "",
                                "Extra": {
                                        "DBInstanceIds": {
                                                "DBInstanceId": []
                                        }
                                },
                                "IPType": "IPv4",
                                "InsId": 1,
                                "InstanceNetworkType": "VPC",
                                "InstructionSetArch": "x86",
                                "IoAccelerationEnabled": "0",
                                "LatestKernelVersion": "rds_postgres_1400_20240530",
                                "LockMode": "Unlock",
                                "MaintainTime": "18:00Z-22:00Z",
                                "MasterZone": "cn-hangzhou-j",
                                "MaxConnections": 800,
                                "MaxIOMBPS": 0,
                                "MaxIOPS": 6800,
                                "OriginConfiguration": "{\"KindCode\":\"18\"}",
                                "PayType": "Postpaid",
                                "Port": "5432",
                                "ProxyType": 2,
                                "ReadOnlyDBInstanceIds": {
                                        "ReadOnlyDBInstanceId": []
                                },
                                "RegionId": "cn-hangzhou",
                                "ResourceGroupId": "rg-acfmz7u4zzrngoa",
                                "SecurityIPList": "0.0.0.0/0,172.16.0.0/12",
                                "SecurityIPMode": "normal",
                                "ServerlessConfig": {},
                                "SlaveZones": {
                                        "SlaveZone": [
                                                {
                                                        "ZoneId": "cn-hangzhou-k"
                                                }
                                        ]
                                },
                                "SuperPermissionMode": "",
                                "SupportCreateSuperAccount": "Yes",
                                "SupportUpgradeAccountType": "Yes",
                                "Tips": "ok",
                                "TipsLevel": 1,
                                "VSwitchId": "vsw-bp1sxxsodv28ey5dl****",
                                "VpcCloudInstanceId": "pgm-bp16k272p478****-20240806141842",
                                "VpcId": "vpc-bp1ov7as4yvz4kxei****",
                                "ZoneId": "cn-hangzhou-j",
                                "kindCode": "18"
                        }
                ]
        },
        "RequestId": "14B99E32-4ECD-5B8E-A9C8-6738C8C95910"
}

Catatan

Jika terjadi kesalahan setelah memanggil operasi API ApsaraDB RDS, periksa apakah parameter input dan nilainya valid berdasarkan kode kesalahan.

Anda juga dapat menggunakan Diagnostik OpenAPI Alibaba Cloud untuk melakukan diagnosa mandiri berdasarkan ID permintaan yang dikembalikan atau informasi kesalahan SDK.