Python SDK の使用方法 - Server Migration Center - Alibaba Cloud ドキュメントセンター

このトピックでは、Python 環境をセットアップし、サンプルコードを使用して API オペレーションを呼び出す方法について説明します。インストール方法を網羅し、クラウドサービスを迅速に構築・統合できるようサポートします。

前提条件

Python 3 をダウンロードしてインストール済みであること。

ターミナルを開き、python --version を実行して Python のバージョンを確認します。
Python コードエディタがインストール済みであること。

このトピックでは、PyCharm を例として使用します。
AccessKey ペアを取得済みであること。

API リクエストを認証するには、AccessKey ペアを使用する必要があります。AccessKey ペアは、AccessKey ID と AccessKey シークレットで構成されます。AccessKey ペアの作成方法と取得方法については、「AccessKey ペアの作成」をご参照ください。

操作手順

ステップ 1：環境変数の設定

AccessKey ペアのハードコーディングによるセキュリティリスクを回避するため、この例では環境変数を使用して管理します。詳細については、「Linux、macOS、および Windows で環境変数を設定する」をご参照ください。

ステップ 2：依存関係のインストール

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

説明

お使いの環境に pip がインストールされていない場合は、pip 公式サイトでインストール手順をご確認ください。

pip install alibabacloud_credentials
pip install alibabacloud_smc20190601==1.0.2
pip install alibabacloud_tea_console==0.0.1
pip install alibabacloud_tea_util==0.3.11
pip install alibabacloud_tea_openapi==0.3.8

ステップ 3：SDK サンプルプロジェクトのダウンロード

OpenAPI ポータルのAPI デバッグページに移動し、左側のナビゲーションウィンドウで API オペレーションを選択します。

このトピックでは、DescribeSourceServers API オペレーションを例として使用します。
左側の [パラメーター] タブで [リージョン] を選択し、必須パラメーターを指定します。API オペレーション、そのパラメーター、および請求情報などの重要な注意事項の詳細については、右側の [ドキュメント] タブをご参照ください。
右側の [SDK サンプル] タブで Python を選択し、[プロジェクト全体をダウンロード] をクリックします。ダウンロードした SDK プロジェクトをローカルマシンに解凍します。
説明
- SDK サンプルコードをコピーするには、「SDK サンプルを自動的に生成する」をご参照ください。
- Python SDK サンプルコードの詳細については、「SDK クイックスタート」をご参照ください。

ステップ 4：解凍したプロジェクトのインポート

PyCharm を開きます。
トップメニューバーで、を選択します。
表示されるダイアログボックスで、解凍した SDK プロジェクトのフォルダを選択します。

ステップ 5：SDK サンプルコードの実行

PyCharm の左側のナビゲーションウィンドウで、Python SDK サンプルコードファイルを開きます。
トップメニューバーで、を選択します。

出力を確認します。

C:\Demo\python-sdk\venv\Scripts\python.exe C:/Demo/python-sdk/alibabacloud_sample...
[LOG] {"headers": {"date": "Fri, 30 Jun 2023 05:26:00 GMT", "content-type": "appl...}}
Process finished with exit code 0

SDK は、HTTPS リクエスト、プロキシ、タイムアウト、リトライメカニズムなどの高度な設定もサポートしています。詳細については、「高度な構成」をご参照ください。