alibaba cloud cli rds api examples - ApsaraDB RDS - Alibaba Cloud ドキュメントセンター

Alibaba Cloud CLI は、OpenAPI をベースにしたコマンドラインツールです。シェルから ApsaraDB RDS インスタンスを管理できます。本ドキュメントでは、CLI のインストールと設定、および ApsaraDB RDS API の呼び出し方法について説明します。

前提条件

Alibaba Cloud CLI を初めて使用する場合は、「Alibaba Cloud CLI とは」をご参照ください。

Alibaba Cloud CLI のインストール

お使いのオペレーティングシステムに Alibaba Cloud CLI をインストールします。

Windows：「Windows への CLI のインストール」をご参照ください。
Linux：「CLI のインストールまたは更新」をご参照ください。
macOS：「macOS への CLI のインストール」をご参照ください。

「Cloud Shell」で CLI コマンドをデバッグすることもできます。「Cloud Shell とは」をご参照ください。

Alibaba Cloud CLI の設定

重要

Alibaba Cloud アカウントは完全な API アクセス権限を持つため、セキュリティ上のリスクがあります。代わりに RAM ユーザーを作成して使用してください。ApsaraDB RDS への読み取り専用アクセスには [AliyunRDSReadOnlyAccess] を、フルコントロールには [AliyunRDSFullAccess] をアタッチしてください。

CLI を使用する前に、ID 認証情報、デフォルトのリージョン ID、その他の設定を行います。CLI は複数の認証情報タイプをサポートしています (「ID 認証情報の設定と管理」をご参照ください)。この例では AccessKey 認証情報を使用します。

「RAM ユーザーを作成」し、必要なサービス権限を付与します (「RAM ユーザー権限の管理」をご参照ください)。
RAM ユーザー用の「AccessKey ペアを作成」します。認証情報の設定のために AccessKey ID と AccessKey シークレット を記録してください。
リージョン ID を選択します。CLI は指定されたリージョンに API コールを送信します。利用可能なリージョン：「エンドポイント」をご参照ください。

説明
--region オプションは、認証情報の設定と環境変数のデフォルトリージョンを上書きします。「コマンドラインオプション」をご参照ください。
RAM ユーザーの AccessKey ペアを使用して、AkProfile という名前のプロファイルで AccessKey 認証情報を設定します。「ID 認証情報の設定と管理」をご参照ください。

サンプル CLI コマンドの生成

OpenAPI Explorer の「ApsaraDB RDS API リファレンス」にアクセスします。
[左側の検索ボックス] で API を検索します。[パラメーター] タブで、必要な値を入力します。次に、[パラメーター] タブの横にある [CLI の例] をクリックして、サンプルコマンドを生成します。
- アイコンをクリックして「Cloud Shell」を開き、コマンドをデバッグします。
- アイコンをクリックして、CLI の例をクリップボードにコピーします。その後、ローカルシェルに貼り付けて実行できます。
  - CLI の例をローカルシェルに貼り付ける際は、パラメータの形式を確認してください。「コマンドパラメータの理解」をご参照ください。
  - OpenAPI Explorer は、デフォルトでサンプルコマンドに --region オプションを追加します。これにより、認証情報と環境変数のリージョンが上書きされます。必要に応じて保持または削除してください。

クラウドサービス API の呼び出し

コマンド構造

CLI コマンドは次の形式です (「コマンドの生成と呼び出し」をご参照ください)：

aliyun <command> <subcommand> [options and parameters]

一般的なコマンドラインオプション

コマンドラインオプションを使用して、コマンドの動作を変更したり、機能を追加したりできます。

--profile<profileName>：指定されたプロファイルを使用し、デフォルトの認証情報と環境変数を上書きします。
--help：コマンドのヘルプ情報を表示します。「ヘルプの取得」をご参照ください。

「コマンドラインオプション」をご参照ください。

例

例 1：--help を使用して、利用可能な ApsaraDB RDS API を一覧表示します。「API の概要」も確認できます。

次のコマンドを実行します：
```
aliyun rds --help
```

コマンド出力を確認します：

コマンド出力

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             ソース PostgreSQL インスタンスから宛先の ApsaraDB RDS for PostgreSQL インスタンスにワークロードを切り替えます。
  AddTagsToResource                           インスタンスにタグを追加します。
  AllocateInstancePublicConnection            ApsaraDB RDS インスタンスのパブリックエンドポイントを申請します。
  AllocateReadWriteSplittingConnection        インスタンスの読み取り専用ルーティングエンドポイントを申請します。
  AttachWhitelistTemplateToInstance           ホワイトリストテンプレートをインスタンスに関連付けます。
  CalculateDBInstanceWeight                   システムが割り当てた読み取りの重みを照会します。
...

例 2: DescribeDBInstanceAttribute API を呼び出してインスタンスの詳細を照会します。

次のコマンドを実行します：

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

コマンド出力を確認します：

コマンド出力

{
        "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"
}

説明

API コールが失敗した場合は、エラーコードを確認してリクエストパラメータを検証してください。

リクエスト ID またはエラーメッセージを使用して、「Alibaba Cloud OpenAPI Diagnostics」で問題を診断してください。