Python用AnalyticDB for PostgreSQL SDKの使用 - AnalyticDB - Alibaba Cloud ドキュメントセンター

このトピックでは、Alibaba Cloud SDK for Pythonを使用して、AnalyticDB for PostgreSQLのDescribeDBInstances操作を呼び出す方法について説明します。

APIドキュメントの表示

API操作を呼び出す前に、API操作に関するドキュメントを読んで、API操作を呼び出すために必要なパラメーターとアクセス許可について確認することをお勧めします。詳細については、「機能別操作一覧」をご参照ください。

RAMユーザーを作成し、RAMユーザーに権限を付与する

RAM (Resource Access Management) ユーザーを作成し、RAMユーザーに権限を付与している場合は、この手順をスキップしてください。

RAMユーザーを作成するには、次の手順を実行します。
1. RAMコンソールにログインし、[ユーザー] ページに移動し、[ユーザーの作成] をクリックします。
2. [ログイン名] パラメーターをadbpg-openapi-operatorに設定し、[アクセスモード] で [永続的なAccessKeyを使用してアクセス] を選択します。
3. [OK] をクリックします。 RAMユーザーが作成されたら、ユーザーのAccessKey IDとAccessKey secretを保存します。
RAMユーザーに権限を付与するには、次の手順を実行します。
1. [ユーザー] ページに移動し、作成したRAMユーザーを見つけて、[操作] 列の [権限の追加] をクリックします。
2. [ポリシー] セクションで、テキストボックスにAliyunGPDBと入力し、AliyunGPDBReadOnlyAccessポリシーを選択します。
  説明
  AliyunGPDBReadOnlyAccessポリシーには、AnalyticDB for PostgreSQLインスタンスを照会する権限があります。 AnalyticDB for PostgreSQLインスタンスを照会および変更したり、ポリシーをカスタマイズしたりする権限を持つAliyunGPDBFullAccessポリシーを選択することもできます。詳細については、「カスタムポリシーの作成」をご参照ください。
3. [OK] をクリックします。

API操作の呼び出し

この例では、Alibaba Cloud SDK for Pythonを使用してAPI操作を呼び出します。他の言語でもSDKを使用できます。詳細については、「

AnalyticDB for PostgreSQL SDK

Python環境を準備する

Python 3をダウンロードしてインストールします。 Pythonをインストールしている場合は、python -- versionコマンドを実行してPythonのバージョンを照会できます。

環境変数の設定

このセクションでは、オペレーティングシステムでALIBABA_CLOUD_ACCESS_KEY_IDおよびALIBABA_CLOUD_ACCESS_KEY_SECRET環境変数を設定する方法について説明します。

LinuxまたはmacOSオペレーティングシステムを使用している場合は、次のコマンドの <access_key_id> と <access_key_secret> をAccessKey IDとAccessKey secretに置き換えます。次に、デバイスでコマンドを実行します。
```
export ALIBABA_CLOUD_ACCESS_KEY_ID=<ACCESS_KEY_ID>
export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<ACCESS_KEY_SECRET>
```
Windowsオペレーティングシステムを使用している場合は、ALIBABA_CLOUD_ACCESS_KEY_IDおよびALIBABA_CLOUD_ACCESS_KEY_SECRET環境変数を追加するファイルを作成し、環境変数を使用してAccessKey IDおよびAccessKey secretを指定してから、システムを再起動します。

依存関係のインストール

デバイスで次のコマンドを実行して、環境依存関係をインストールします。

pip install alibabacloud_credentials
pip install alibabacloud_gpdb20160503
pip install alibabacloud_tea_console

サンプルコードのダウンロード

DescribeDBInstancesページ。
左側の [パラメーター] タブで、必要なパラメーターを指定します。この例では、RegionIdパラメーターにcn-hangzhouを指定します。
右側の [SDKサンプルコード] タブで、[言語] パラメーターとして [Python] を選択し、[プロジェクトのダウンロード] をクリックしてサンプルコードパッケージをダウンロードします。
デバイスでサンプルコードパッケージを解凍し、alibabacloud_sampleディレクトリに移動します。

Run the code

以下のコマンドを実行します。

python sample.py

サンプル結果:

[
  LOG
] {
  "headers":{
    "date":"Fri, 04 Aug 2023 07:53:15 GMT",
    "content-type":"application/json;charset=utf-8",
    "content-length":"1530","connection":"keep-alive",
    "keep-alive":"timeout=25","vary":"Accept-Encoding",
    "access-control-allow-origin":"*",
    "access-control-expose-headers":"*",
    "x-acs-request-id":"22996ADD-A917-5F47-AA7E-2D9A08****",
    "x-acs-trace-id":"a1f567557dc98fb5f368346302e6****",
    "etag":"1rgk9Fbs7Z+HYg9IhB1****"
  },
  "statusCode":200,
  "body":{
    "Items":{
      "DBCluster":[
        {
         "CreateTime":"2023-07-31T07:09:32Z",
         "DBInstanceCategory":"Basic",
         "DBInstanceDescription":"gp-bp1j20nrgf91****",
         "DBInstanceId":"gp-bp1j20nrgf91****",
         "DBInstanceMode":"StorageElastic",
         "DBInstanceNetType":"2",
         "DBInstanceStatus":"Running",
         "Engine":"gpdb",
         "EngineVersion":"6.0",
         "ExpireTime":"2023-08-31T16:00:00Z",
         "InstanceDeployType":"cluster",
         "InstanceNetworkType":"VPC",
         "LockMode":"Unlock",
         "LockReason":"0",
         "MasterNodeNum":1,
         "PayType":"Prepaid",
         "RegionId":"cn-hangzhou",
         "ResourceGroupId":"rg-acfmz7u4zzr****",
         "SegNodeNum":"2",
         "StorageSize":"50",
         "StorageType":"cloud_essd",
         "Tags":{"Tag":[]},
         "VSwitchId":"vsw-bp1sxxsodv28ey5****",
         "VpcId":"vpc-bp1ov7as4yvz4kxei****",
         "ZoneId":"cn-hangzhou-j"
        }
      ]
    },
    "PageNumber":1,
    "PageRecordCount":1,
    "RequestId":"22996ADD-A917-5F47-AA7E-2D9A08AF1AC2",
    "TotalRecordCount":1
  }
}