Alibaba Cloud SDK：泛化調用

特點

1. 輕量級：僅需安裝aliyun-python-sdk-core即可調用所有OpenAPI，無需依賴各產品的獨立SDK。

2. 快速迭代相容性：當雲產品尚未提供相應的SDK，或當新API發布但SDK未能及時更新時，可以使用泛化調用。這樣，無需等待SDK的更新，即可及時調用最新發行的API介面。

更多介紹，請參見泛化調用與特化調用。

使用說明

在使用泛化調用之前，必須手動擷取並配置OpenAPI的版本號碼、請求路徑、參數類型等中繼資料資訊。可以通過查看OpenAPI中繼資料來擷取有關OpenAPI的API風格、請求參數、資源路徑等相關資訊。

安裝核心SDK

在Terminal中執行以下命令安裝核心SDK。

pip install aliyun-python-sdk-core

調用OpenAPI

初始化請求用戶端

通過在aliyunsdkcore包中建立client模組以初始化請求用戶端，並通過該Client發起OpenAPI調用。此處僅列舉使用AccessKey（簡稱：AK）初始化用戶端的方式，更多初始化方式請參見管理訪問憑據。

import os
from aliyunsdkcore.client import AcsClient

# 使用AccessKey直接初始化。
client = AcsClient(
    os.environ['ALIYUN_ACCESS_KEY_ID'],
    os.environ['ALIYUN_ACCESS_KEY_SECRET'],
    region_id='cn-hangzhou',
    # verify=False,  # 忽略對 SSL 憑證的驗證
    # proxy={'http': 'http://127.0.0.1:9898'}, # 設定代理
    # proxy={'https': 'http://<user>:<password>@127.0.0.1:8989'},
    # connect_timeout=10,  # 連線逾時
    # timeout=15  # 讀逾時時間
)

配置OpenAPI資訊及請求參數

通過CommonRequest來配置OpenAPI所需的公用請求參數及介面請求參數。關於更多公用請求參數的介紹及使用請參見進階配置。

# 2.建立CommonRequest對象並配置OpenAPI基本資料和請求參數。
request = CommonRequest()

# 2.1 配置公用請求參數
request.set_domain('ecs-cn-hangzhou.aliyuncs.com')  # API服務地址
request.set_version('2014-05-26')  # API版本號碼
request.set_action_name('DescribeInstanceStatus')  # API名稱，當調用RPC風格API時，必須配置set_action_name()指定介面名稱
request.set_method('POST')  # API請求方式
request.set_protocol_type('HTTPS')  # 請求協議：HTTPS或HTTP，建議使用HTTPS。
# request.set_uri_pattern('/')  # API資源路徑，ROA介面必傳。RPC介面禁止設定該參數。

# 2.2 配置介面請求參數
# 情境一：Query參數通過add_query_param(self, k, v)設定
InstanceIds = [
    "i-bp1axhql4dqXXXXXXXX",
    "i-bp124uve8zqXXXXXXXX"
]
for depth1 in range(len(InstanceIds)):
    request.add_query_param('InstanceId.' + str(depth1 + 1), InstanceIds[depth1])
request.add_query_param('PageNumber', '1')
request.add_query_param('PageSize', '30')

# 情境二：body參數通過add_body_params(self, k, v)設定
# request.add_body_params('key1', 'value1')
# request.add_body_params('key2', 'value2')
# request.add_body_params('key3', 'value3')

# 情境三：檔案上傳set_content(self, content)，content為位元組數群組類型
# file_path = "<FILE_PATH>" # <FILE_PATH>需替換為實際檔案路徑
# with open(file_path, 'rb') as file:
#    讀取圖片內容為位元組數組
#    ByteArray = file.read()
# request.set_content(ByteArray)

發起請求

通過client調用do_action_with_exception發起請求，參數為前一步構造的CommonRequest執行個體。

# 發起請求
response = client.do_action_with_exception(request)
# 傳回值是 bytes 類型，包含RequestId以及OpenAPI的返回參數
print(f"response：\n{response}")
# 解析響應內容（JSON 格式）
response_json = json.loads(response.decode('utf-8'))  # 轉換為Python字典
print("RequestId：", response_json["RequestId"])  # 請求ID

程式碼範例

樣本：調用RPC風格的API

以調用ECS的DescribeInstanceStatus介面為例，展示如何使用泛化調用方式。

import os
from aliyunsdkcore.client import AcsClient
from aliyunsdkcore.request import CommonRequest


class Sample:

    @staticmethod
    def main():
        # 使用AccessKey直接初始化。
        client = AcsClient(os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'], os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
                           'cn-hangzhou')
        # 建立請求對象
        request = CommonRequest()
        request.set_domain('ecs-cn-hangzhou.aliyuncs.com')  # API服務地址
        request.set_version('2014-05-26')  # API版本號碼
        request.set_action_name('DescribeRegions')  # API名稱，當調用RPC風格API時，必須配置set_action_name()指定介面名稱
        request.set_method('POST')  # API請求方式
        request.set_protocol_type('HTTPS')  # 請求協議：HTTPS或HTTP，建議使用HTTPS。
        InstanceIds = [
            "i-bp1axhql4dqXXXXXXXX",
            "i-bp124uve8zqXXXXXXXX"
        ]
        for depth1 in range(len(InstanceIds)):
            request.add_query_param('InstanceId.' + str(depth1 + 1), InstanceIds[depth1])
        request.add_query_param('PageNumber', '1')
        request.add_query_param('PageSize', '30')
        # 發起請求並處理響應
        response = client.do_action_with_exception(request)
        print(response)


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

樣本：調用RESTful（ROA）風格的API

以調用Container Service查詢叢集列表資訊DescribeClustersV1介面為例，展示如何使用泛化調用。

import os
from aliyunsdkcore.client import AcsClient
from aliyunsdkcore.request import CommonRequest


class Sample:

    @staticmethod
    def main():
        # 使用AccessKey直接初始化。
        client = AcsClient(
            os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
            os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
            'cn-hangzhou')
        # 建立請求對象
        request = CommonRequest()
        request.set_domain('cs.aliyuncs.com')  # API服務地址
        request.set_version('2015-12-15')  # API版本號碼
        request.set_uri_pattern(
            f'/api/v1/clusters')  # API資源路徑，當調用ROA風格API時，必須配置set_uri_pattern()指定完整資源路徑。從OpenAPI中繼資料中data.path擷取資源路徑。
        request.set_method('GET')  # API要求方法
        request.add_query_param('name', 'cluster-demo')  # 配置請求參數
        # 發起請求並處理響應
        response = client.do_action_with_exception(request)
        print(response)


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