Python V2.0 SDK泛化調用 - Alibaba Cloud SDK

阿里雲SDK不僅支援使用雲產品SDK提供的特化調用方式調用OpenAPI，還支援使用核心SDK提供的泛化調用方式調用OpenAPI，兩種方式的不同請參見泛化調用與特化調用。本文將從擷取API資訊、安裝SDK和程式碼範例來為您介紹如何使用泛化調用。

擷取API資訊

訪問API文檔選擇雲產品，例如選擇Elastic Compute Service。

單擊雲端服務器名稱下面的擷取中繼資料，在中繼資料中info.style查看雲產品支援的OpenAPI風格（RPC或者ROA）。
說明
該位置擷取的中繼資料中包含了雲產品的所有API資訊，如果您想要查看單個API的中繼資料，請查看步驟2。
選擇將要調用的API，單擊右上方擷取中繼資料。
在中繼資料中，定義了API支援的網路通訊協定、請求方式、參數及參數位置等資訊。如下圖所示的RunInstances中繼資料中：
- 支援的網路通訊協定有HTTP和HTTPS，建議使用HTTPS。
- 支援的請求方式有GET和POST，兩者請求方式調用結果無任何差異，但GET請求只支援 32 KB 以內的請求包，所以推薦使用POST請求。
- 支援的參數有RegionId、ImageId等，參數位置在query，表示參數是要拼接在請求URL後面，例如https://ecs.cn-beijing.aliyuncs.com/?ImageId=aliyun_2_1903_x64_20G_alibase_20231221.vhd&InstanceChargeType=PostPaid&InstanceType=ecs.e-c1m1.large&InternetChargeType=PayByTraffic&MinAmount=1&Password=test%401234&RegionId=cn-beijing&SecurityGroupId=sg-2zec0dm6qi66XXXXXXXX&SystemDisk.Category=cloud_essd&SystemDisk.Size=40&VSwitchId=vsw-2ze3aagwn397gXXXXXXXX。
說明
中繼資料中其他支援的內容對簽名無影響，這裡暫不詳細說明。更多中繼資料的資訊，請參見中繼資料使用指南。

安裝SDK

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

pip install alibabacloud-tea-openapi

程式碼範例

樣本：調用RPC風格的API

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

import os

from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_tea_openapi.client import Client as OpenApiClient
from alibabacloud_tea_util import models as util_models


class Sample:
    @staticmethod
    def main():
        # 從環境變數中擷取存取金鑰
        config = open_api_models.Config(
            access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
            access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
        )
        # 設定服務存取點
        config.endpoint = f'ecs-cn-hangzhou.aliyuncs.com'
        client = OpenApiClient(config)
        params = open_api_models.Params(
            style='RPC',  # API風格
            version='2014-05-26',  # API版本號碼
            action='DescribeRegions',  # API 名稱
            method='POST',  # 要求方法
            pathname='/',  # 介面 PATH
            protocol='HTTPS',  # 介面協議,
            auth_type='AK',
            req_body_type='json',  # 介面請求體內容格式,
            body_type='json'  # 介面響應體內容格式,
        )

        # 添加查詢參數和請求體
        query = {'InstanceChargeType': 'PrePaid'}
        # 建立API請求對象
        request = open_api_models.OpenApiRequest(
            query=query,
        )
        # 建立運行時選項對象
        runtime = util_models.RuntimeOptions()
        # 發起API調用並列印響應
        response = client.call_api(params, request, runtime)
        print(response)

    @staticmethod
    async def main_async():
        """
        非同步主函數，用於示範如何使用非同步方式調用阿里雲 API。
        """
        # 從環境變數中擷取存取金鑰
        config = open_api_models.Config(
            access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
            access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
        )
        # 設定服務存取點
        config.endpoint = f'ecs-cn-hangzhou.aliyuncs.com'
        client = OpenApiClient(config)
        params = open_api_models.Params(
            style='RPC',  # API風格
            version='2014-05-26',  # API版本號碼
            action='DescribeRegions',  # API 名稱
            method='POST',  # 要求方法
            pathname='/',  # 介面 PATH
            protocol='HTTPS',  # 介面協議,
            auth_type='AK',
            req_body_type='json',  # 介面請求體內容格式,
            body_type='json'  # 介面響應體內容格式,
        )

        # 添加query參數
        query = {'InstanceChargeType': 'PrePaid'}
        # 建立API請求對象
        request = open_api_models.OpenApiRequest(
            query=query,
        )
        # 建立運行時選項對象
        runtime = util_models.RuntimeOptions()
        # 發起非同步API調用
        await client.call_api_async(params, request, runtime)


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

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

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

import os

from alibabacloud_openapi_util.client import Client as OpenApiUtilClient
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_tea_openapi.client import Client as OpenApiClient
from alibabacloud_tea_util import models as util_models


class Sample:
    @staticmethod
    def main() -> None:
        # 從環境變數中擷取存取金鑰ID和密鑰Secret
        config = open_api_models.Config(
            access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
            access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
        )
        config.endpoint = f'cs.cn-qingdao.aliyuncs.com'
        client = OpenApiClient(config)
        params = open_api_models.Params(
            # 介面名稱,
            action='DescribeClustersV1',
            # 介面版本,
            version='2015-12-15',
            # 介面協議,
            protocol='HTTPS',
            # 介面 HTTP 方法,
            method='GET',
            auth_type='AK',
            style='ROA',
            # 介面 PATH,
            pathname=f'/api/v1/clusters',
            # 介面請求體內容格式,
            req_body_type='json',
            # 介面響應體內容格式,
            body_type='json'
        )
        # query params
        queries = {'name': 'cluster-demo'}
        request = open_api_models.OpenApiRequest(
            query=OpenApiUtilClient.query(queries)
        )
        # runtime options
        runtime = util_models.RuntimeOptions()
        # 傳回值為 Map 類型，可從 Map 中獲得三類資料：響應體 body、回應標頭 headers、HTTP 返回的狀態代碼 statusCode。
        response = client.call_api(params, request, runtime)
        print(response)

    @staticmethod
    async def main_async() -> None:
        # 從環境變數中擷取存取金鑰ID和密鑰Secret
        config = open_api_models.Config(
            access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
            access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
        )
        config.endpoint = f'cs.cn-qingdao.aliyuncs.com'
        client = OpenApiClient(config)
        params = open_api_models.Params(
            # 介面名稱,
            action='DescribeClustersV1',
            # 介面版本,
            version='2015-12-15',
            # 介面協議,
            protocol='HTTPS',
            # 介面 HTTP 方法,
            method='GET',
            auth_type='AK',
            style='ROA',
            # 介面 PATH,
            pathname=f'/api/v1/clusters',
            # 介面請求體內容格式,
            req_body_type='json',
            # 介面響應體內容格式,
            body_type='json'
        )
        # query params
        queries = {'name': 'cluster-demo'}
        request = open_api_models.OpenApiRequest(
            query=OpenApiUtilClient.query(queries)
        )
        # runtime options
        runtime = util_models.RuntimeOptions()
        # 傳回值為 Map 類型，可從 Map 中獲得三類資料：響應體 body、回應標頭 headers、HTTP 返回的狀態代碼 statusCode。
        await client.call_api_async(params, request, runtime)


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