Alibaba Cloud SDK:Alibaba Cloud SDK V2.0 for Python と統合する

前提条件

Python 3.7 以降がインストールされている。

1. SDK Center にログインし、SDK を使用したいサービスを選択します。 この例では、Short Message Service (SMS) を選択します。

2. [Short Message Service] ページ、[すべての言語] セクションで [Python] を選択します。 [クイックスタート] タブで、Short Message Service (SMS) SDK のインストール方法を取得します。

特殊なシナリオ: Advance オペレーションによるファイルアップロード

オンプレミス機器の画像を処理したり、画像をアップロードしたりするために Image Search または Visual Intelligence API (VIAPI) を使用する場合、ドキュメントに記載されている Image Search または VIAPI の API は直接アップロードをサポートしていません。 画像をアップロードするには、ファイルストリームの送信をサポートする Advance オペレーションを使用する必要があります。 クラウドサービスは、アップロードされたファイルを一時的に Object Storage Service (OSS) に保存し、必要に応じて OSS から一時ファイルを読み取ります。 OSS のデフォルトリージョンは cn-shanghai です。 次の例は、VIAPI の DetectBodyCount オペレーションを呼び出す方法を示しています。

1. リクエストクライアントを初期化する

   region_id パラメータとクラウドサービスの endpoint の両方が指定されていることを確認します。 region_id は、一時ファイルが保存される OSS リージョンを示します。 region_id パラメータを構成しないと、クラウドサービスが OSS とは異なるリージョンを使用する可能性があり、API タイムアウトが発生する可能性があります。

   def create_client() -> facebody20191230Client:
       config = open_api_models.Config(
           # 必須。 ALIBABA_CLOUD_ACCESS_KEY_ID 環境変数がコードで指定されていることを確認します。,
           access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
           # 必須。 ALIBABA_CLOUD_ACCESS_KEY_SECRET 環境変数が構成されていることを確認します。,
           access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
       )
       # endpoint パラメータと regionId パラメータに同じリージョンを指定します。
       config.region_id = 'cn-shanghai'
       config.endpoint = 'facebody.cn-shanghai.aliyuncs.com'
       return facebody20191230Client(config)

2. リクエストオブジェクトを作成する

   <API オペレーション>AdvanceRequest リクエストオブジェクトを作成して、ファイルストリームを渡します。 リクエストオブジェクトで、パラメータ名を ImageURLObject に設定します。

   # バイナリファイルを開きます。
   with open('<FILE_PATH>', "rb") as f:  # ファイルパスを置き換えます。
        # リクエストパラメータを指定します。
        detect_body_count_advance_request = facebody_20191230_models.DetectBodyCountAdvanceRequest(
                  image_urlobject = f,
        )

3. リクエストを開始する

   <API オペレーション名>Advance 関数を呼び出して、リクエストを開始します。 <API オペレーション名> をキャメルケースで指定します。

   /# ランタイムパラメータを構成します。
   runtime = util_models.RuntimeOptions()
   client = create_client()
   # リクエストを開始します。
   res = client.detect_body_count_advance(detect_body_count_advance_request, runtime)

import os

from alibabacloud_facebody20191230 import models as facebody_20191230_models
from alibabacloud_facebody20191230.client import Client as facebody20191230Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_tea_util import models as util_models


class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> facebody20191230Client:
        config = open_api_models.Config(
            # 必須。 ALIBABA_CLOUD_ACCESS_KEY_ID 環境変数がコードで指定されていることを確認します。 ,
            access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
            # 必須。 ALIBABA_CLOUD_ACCESS_KEY_SECRET 環境変数が構成されていることを確認します。 ,
            access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
        )
        config.region_id = 'cn-shanghai'
        return facebody20191230Client(config)

    @staticmethod
    def main() -> None:
        client = Sample.create_client()
        # バイナリファイルを開きます。
        with open('<FILE_PATH>', "rb") as f:  # <FILE_PATH> のファイルパスを置き換えます。
            # リクエストパラメータを指定します。
            detect_body_count_advance_request = facebody_20191230_models.DetectBodyCountAdvanceRequest(
                image_urlobject=f,
            )
            runtime = util_models.RuntimeOptions()
            try:
                # リクエストを開始します。
                res = client.detect_body_count_advance(detect_body_count_advance_request, runtime)
                print(res)
            except Exception as error:
                # 実際のビジネスシナリオに基づいて例外を慎重に処理し、プロジェクトで例外を無視しないでください。 この例に表示されているエラーメッセージは参照用です。
                print(error)


if __name__ == '__main__':
    Sample.main()

FAQ

1. API オペレーションによってスローされた「このオペレーションを実行する権限がありません」エラーを処理するにはどうすればよいですか?

   考えられる原因と解決策

   考えられる原因: Resource Access Management (RAM) ユーザーの AccessKey ペアに、API オペレーションを呼び出す権限がありません。

   解決策: RAM ユーザーに必要な権限を付与します。 詳細については、「RAM ユーザーに権限を付与する」をご参照ください。

   たとえば、SendMessageToGlobe API オペレーションによって「このオペレーションを実行する権限がありません」エラーがスローされた場合は、次のカスタムポリシーを作成して、必要な権限を RAM ユーザーに付与します。

   {
     "Version": "1",
     "Statement": [
       {
         "Effect": "Allow",
         "Action": "dysms:SendMessageToGlobe",
         "Resource": "*"
       }
     ]
   }

2. API オペレーションによってスローされた「SDK.EndpointResolvingError」エンドポイントエラーを処理するにはどうすればよいですか?

   考えられる原因と解決策

   考えられる原因: リクエストクライアントを初期化するときに指定したエンドポイントは、API オペレーションでサポートされていません。

   解決策: サポートされているエンドポイントを指定して、再試行します。 詳細については、「エンドポイントを構成する」をご参照ください。

3. AttributeError: "AttributeError' object has no attribute 'message'」または「KeyError: "ALIBABA_CLOUD_ACCESS_KEY_ID"」AccessKey エラーを処理するにはどうすればよいですか?

   考えられる原因と解決策

   考えられる原因: AccessKey ペアがリクエストに正しく渡されていません。

   解決策: リクエストクライアントを初期化するときに、AccessKey ペアが正しく渡されていることを確認します。 os.environ("XXX") の XXX 値は、環境変数から取得されます。

SDK エラーの処理方法の詳細については、「FAQ」をご参照ください。