Simple Log Service SDK for Pythonを使用してAPI操作を呼び出す例

このトピックでは、Simple Log Service SDK for Pythonを使用してSimple Log ServiceのListProject操作を呼び出してプロジェクトを照会する方法について説明します。

APIドキュメントの表示

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

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

重要

Alibaba CloudアカウントのAccessKeyペアには、すべてのAPI操作に対する権限があります。 Resource Access Management (RAM) ユーザーを作成して使用し、API操作を呼び出したり、ルーチンのO&Mを実行したりすることを推奨します。

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

RAMコンソールにログインします。
RAM ユーザーを作成します。
1. 左側のナビゲーションウィンドウで、[ID] > [ユーザー] を選択します。
2. [ユーザー] ページで、[ユーザーの作成] をクリックします。
3. [ユーザーの作成] ページで、[ログイン名] と [表示名] を [config-openapi-operator] に設定し、[アクセスモード] で [OpenAPIアクセス] を選択します。
4. [OK] をクリックします。
  RAMユーザーを作成すると、RAMユーザーのAccessKey IDとAccessKeyシークレットが自動的に生成されます。詳細については、「AccessKey の作成」をご参照ください。 AccessKeyペアを記録することを推奨します。 RAMユーザーを使用してAPI操作を呼び出す場合は、AccessKeyペアを入力する必要があります。
RAMユーザーに権限を付与します。
説明
RAM ユーザーにはデフォルトでは権限がありません。 RAMユーザーを作成した後、AliyunLogFullAccessやAliyunLogReadOnlyAccessなどのシステムポリシー、またはカスタムポリシーをRAMユーザーにアタッチする必要があります。詳細については、「概要」をご参照ください。この例では、AliyunLogReadOnlyAccessポリシーがRAMユーザーにアタッチされています。 AliyunLogReadOnlyAccessポリシーは、Simple Log Serviceリソースに対する読み取り専用権限を付与します。
1. [ユーザー] ページで、config-openapi-operator RAMユーザーを見つけ、[操作] 列の [権限の追加] をクリックします。
2. [権限の追加] パネルで、[AliyunLogReadOnlyAccess] を選択し、[OK] をクリックします。
3. 承認結果を確認します。次に、[完了] をクリックします。

API操作の呼び出し

この例では、Simple Log Service SDK for Pythonを使用してAPI操作を呼び出します。異なるプログラミング言語でSimple Log Service SDKを使用する場合、次の手順も適用されます。詳細については、次をご参照ください：シンプルなLog Service SDK。

Python環境を準備する

Python のインストール詳細については、Pythonの公式ウェブサイトをご覧ください。

説明

Python用Simple Log Service SDKは、Python 3以降をサポートしています。

python -Vコマンドを実行して、インストールされているPythonのバージョンを表示できます。

環境変数を設定します。

AccessKeyペアをビジネスコードにハードコーディングすることによって引き起こされるセキュリティリスクを防ぐために、AccessKeyペアを管理するように環境変数を設定することを推奨します。

LinuxまたはmacOSオペレーティングシステム
次のコマンドの <access_key_id> および <access_key_secret> を、RAMユーザーの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環境変数を追加し、RAMユーザーのAccessKey IDとAccessKeyシークレットを書き込みます。次に、Windowsオペレーティングシステムを再起動します。

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

訪問 ListProjectを使用します。
[パラメーター] タブで、パラメーターを設定します。たとえば、情報を照会するプロジェクトの名前をprojectNameフィールドに入力します。
[SDKサンプルコード] タブで、[Python] を選択し、[プロジェクトのダウンロード] をクリックしてサンプルコードパッケージをダウンロードします。
コンピューター上のサンプルコードパッケージを解凍し、alibabacloud_sampleディレクトリに移動します。

依存関係のインストール

説明

サンプルコードをダウンロードした後、README.mdファイルを開いて、SDKのバージョンや依存関係などの情報を表示できます。

pip install alibabacloud-sls20201230

実行コード

sample.pyファイルを実行します。次のサンプル応答が返されます。

[ログ]
{
  "headers"：{
    "サーバー": "AliyunSLS" 、
    "content-type": "application/json" 、
    "content-length": "230" 、
    "connection": "keep-alive" 、
    "access-control-allow-origin": "*" 、
    "date": "火曜日、7月25日2023 10:08:25 GMT" 、
    "x-log-time": "1690279705" 、
    "x-log-requestid": "64BF9F199ED2B749708E5445"
  },
  "statusCode"： "20"、
  "body": {
    "count": 1,
    "projects": [
      {
        "createTime": "1656666120" 、
        &quot;description&quot;： &quot;&quot;、
        "lastModifyTime": "1665978308" 、
        "owner": "",
        "projectName": "re ****-nginx" 、
        &quot;region&quot;： &quot;cn-hangzhou&quot;、
        "resourceGroupId": "rg-a **** a" 、
        "status": "Normal"
      }
    ],
    "total": 1
  }
}