contoh alibaba cloud cli rds api - ApsaraDB RDS - Alibaba Cloud Documentation Center

Alibaba Cloud CLI adalah alat command-line yang dibangun di atas OpenAPI. Anda dapat menggunakannya untuk mengelola instans ApsaraDB RDS dari shell. Pelajari cara menginstal dan mengonfigurasi CLI serta memanggil API ApsaraDB RDS.

Prasyarat

Baru menggunakan Alibaba Cloud CLI? Mulailah dengan Apa itu Alibaba Cloud CLI?.

Instal Alibaba Cloud CLI

Instal Alibaba Cloud CLI sesuai sistem operasi Anda:

Anda juga dapat men-debug perintah CLI di Cloud Shell. Apa itu Cloud Shell?

Konfigurasi Alibaba Cloud CLI

Penting

Akun Alibaba Cloud Anda memiliki akses API penuh, yang menimbulkan risiko keamanan. Sebagai gantinya, buat dan gunakan RAM user. Lampirkan AliyunRDSReadOnlyAccess untuk akses read-only atau AliyunRDSFullAccess untuk kontrol penuh terhadap ApsaraDB RDS.

Konfigurasikan kredensial identitas, ID wilayah default, dan pengaturan lainnya sebelum menggunakan CLI. CLI mendukung beberapa jenis kredensial (Konfigurasi dan kelola kredensial identitas). Contoh ini menggunakan kredensial AccessKey.

Buat RAM user dan berikan izin layanan yang diperlukan (Kelola izin RAM user).
Buat pasangan AccessKey untuk RAM user tersebut. Catat AccessKey ID dan AccessKey secret untuk konfigurasi kredensial.
Pilih ID wilayah. CLI mengirim panggilan API ke wilayah yang ditentukan. Wilayah yang tersedia: Endpoints.

Catatan
Opsi --region menggantikan wilayah default dalam konfigurasi kredensial dan variabel lingkungan Anda. Opsi command-line.
Konfigurasikan kredensial AccessKey dalam profil bernama AkProfile menggunakan pasangan AccessKey RAM user tersebut. Konfigurasi dan kelola kredensial identitas.

Buat contoh perintah CLI

Buka Referensi API ApsaraDB RDS di OpenAPI Explorer.
Cari API di left-side search box. Di tab Parameters, masukkan nilai yang diperlukan. Di samping tab Parameters, klik CLI Example untuk membuat contoh perintah.
- Klik ikon untuk membuka Cloud Shell dan men-debug perintah tersebut.
- Klik ikon untuk menyalin contoh CLI ke clipboard. Anda kemudian dapat menempelkannya ke shell lokal untuk menjalankannya.
  - Saat menempelkan contoh CLI ke shell lokal, verifikasi format parameternya. Pahami parameter perintah.
  - OpenAPI Explorer secara default menambahkan opsi --region ke contoh perintah, yang menggantikan wilayah dalam kredensial dan variabel lingkungan Anda. Pertahankan atau hapus sesuai kebutuhan.

Panggil API layanan cloud

Struktur perintah

Perintah CLI mengikuti struktur berikut (Buat dan panggil perintah):

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

Opsi command-line umum

Gunakan opsi command-line untuk mengubah perilaku perintah atau menambahkan fungsionalitas.

--profile<profileName>: Menggunakan profil yang ditentukan, menggantikan kredensial default dan variabel lingkungan.
--help: Menampilkan informasi bantuan untuk suatu perintah. Dapatkan bantuan.

Opsi command-line.

Contoh

Contoh 1: Daftar API ApsaraDB RDS yang tersedia dengan --help. Anda juga dapat memeriksa Ikhtisar API.

Jalankan perintah.
```
aliyun rds --help
```

Lihat output perintah.

Output perintah

Alibaba Cloud Command Line Interface Version 3.0.216
Usage:
  aliyun rds <ApiName> --parameter1 value1 --parameter2 value2 ...
Product: Rds (ApsaraDB for RDS)
Version: 2014-08-15
Available API List:
  ActivateMigrationTargetInstance             Switches workloads over from the source PostgreSQL instance to the destination ApsaraDB RDS for PostgreSQL instance.
  AddTagsToResource                           Adds tags to an instance.
  AllocateInstancePublicConnection            Applies for a public endpoint for an ApsaraDB RDS instance
  AllocateReadWriteSplittingConnection        Applies for a read-only routing endpoint for an instance.
  AttachWhitelistTemplateToInstance           Associates a whitelist template with an instance.
  CalculateDBInstanceWeight                   Queries system-assigned read weights.
...

Contoh 2: Panggil API DescribeDBInstanceAttribute untuk mengkueri detail instans.

Jalankan perintah.

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

Lihat output perintah.

Output 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 pemanggilan API gagal, periksa kode kesalahan untuk memverifikasi parameter permintaan Anda.

Gunakan ID permintaan atau pesan kesalahan dengan Alibaba Cloud OpenAPI Diagnostics untuk mendiagnosis masalah tersebut.