Alibaba Cloud SDK：整合SDK

環境要求

Python版本 >= 3.7。

1. 登入SDK Center，選擇將要使用產品，例如您將要調用Short Message Service (SMS)的API。

2. 在安裝頁面，所有語言選擇Python。然後在快速入門頁簽中，您可以擷取Short Message Service (SMS)的SDK安裝方式。

特殊情境：檔案上傳 Advance 介面配置

在使用Image Search、視覺智能開放平台等雲產品處理本地圖片或上傳圖片時，官方文檔中提供的OpenAPI介面不支援直接上傳檔案。若需上傳檔案，可以使用雲產品提供的Advance介面，該介面支援傳遞檔案流對象。其底層實現機製為：雲產品會將上傳的檔案臨時儲存於阿里雲OSS上，預設儲存地區為cn-shanghai，並通過讀取該OSS中的臨時檔案來實現相關功能。以阿里雲提供的視覺智能開放平台-人臉人體的DetectBodyCount介面為例：

1. 初始化請求用戶端

   請注意需同時設定region_id和雲產品的endpoint。其中，region_id表示臨時檔案在OSS中所儲存的地區。如果未設定region_id，可能會由於雲產品與OSS所在地區不同，導致在調用OpenAPI時出現逾時等問題。

   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. 建立請求對象

   通過建立<OpenAPI名稱>AdvanceRequest請求對象傳遞檔案流，參數名固定為ImageURLObject。

   # 開啟檔案為二進位流
   with open('<FILE_PATH>', "rb") as f:  # 需替換檔案路徑
        # 佈建要求參數
        detect_body_count_advance_request = facebody_20191230_models.DetectBodyCountAdvanceRequest(
                  image_urlobject = f,
        )

3. 發起請求

   需調用函數<介面名稱>Advance發起請求，其中<介面名稱>為OpenAPI名稱的首字母小寫格式。

   # 運行時配置
   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()

常見問題

1. 調用OpenAPI時報錯，提示“You are not authorized to perform this operation”。

   問題原因及解決方案

   問題原因：您所使用的AccessKey對應的RAM使用者沒有許可權調用該API。

   解決方案：請為該RAM使用者授予相應OpenAPI許可權。關於如何為RAM使用者進行授權，請參見為RAM使用者授權。

   例如，當您在調用SendMessageToGlobe時提示“You are not authorized to perform this operation”，您可以建立如下所示的自訂權限原則，並為該RAM使用者授予相應的許可權。

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

2. 調用OpenAPI時報錯，提示“SDK.EndpointResolvingError”，該錯誤與'Endpoint'相關。

   問題原因及解決方案

   問題原因：您所調用的OpenAPI不支援在初始化請求用戶端時填寫的Endpoint。

   解決方案：請查看Endpoint配置，修改Endpoint後重新調用OpenAPI。

3. 調用OpenAPI時報錯，提示：AttributeError: “AttributeError' object has no attribute 'message'或”KeyError: “ALIBABA_CLOUD_ACCESS_KEY_ID”，該錯誤與'AccessKey'相關。

   問題原因及解決方案

   問題原因：您的AccessKey未正確傳遞。

   解決方案：在初始化請求用戶端時，檢查是否正確傳遞AccessKey。請注意os.environ("XXX")表示從環境變數中擷取XXX的值。

更多SDK使用過程中的報錯問題解決方案，請參見常見問題。