Alibaba Cloud SDK:Use the Alibaba Cloud Python SDK in an IDE

Go to the OpenAPI Explorer page, and select a product and API. For example, to call the DescribeInstanceTypeFamilies API of ECS, enter DescribeInstanceTypeFamilies in the search box and click the result to go to the OpenAPI Explorer page.

On the Parameters tab in the middle column, specify the parameters based on your business requirements. When you specify the parameters, read the information on the Document tab in the rightmost column. Make sure that you understand the usage notes of the operation and the description of each parameter. Pay attention to billing-related information. In this example, the DescribeInstanceTypeFamilies operation supports two request parameters. You must specify a value such as cn-hangzhou for the RegionId parameter. The Generation parameter is optional. You can set this parameter to ecs-5, which indicates the V-series instance family. You can view the valid values of the parameters on the Document tab.

On the SDK Sample Code tab in the rightmost column, select a programming language and click Download Project to download the complete SDK project to your computer. Then, decompress the package.

Set SDK Version to V2.0 Recommended, set Language to Python, and click Download Complete Project.

Open PyCharm. Click File > Open, select the unzipped project folder, and click OK in the Creating Virtual Environment dialog. Wait for PyCharm to create the virtual environment and download dependencies.

Before you call this operation, you must obtain an AccessKey pair as the access credential. We recommend that you use the AccessKey pair of a Resource Access Management (RAM) user. For more information, see the Create an AccessKey pair for a RAM user section of the "Create an AccessKey pair" topic.

Run the sample code.

Click the Terminal tab at the bottom of PyCharm or press Alt + F12. Run the following command:

python ./alibabacloud_sample/sample.py

Contents of sample.py:

# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys

from typing import List

from alibabacloud_ecs20140526.client import Client as Ecs20140526Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_ecs20140526 import models as ecs_20140526_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_console.client import Client as ConsoleClient
from alibabacloud_tea_util.client import Client as UtilClient

class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> Ecs20140526Client:
        """
        Initialize the account client using AccessKey ID and AccessKey Secret.
        """
        pass

Terminal output:

python ./alibabacloud_sample/sample.py
[LOG] {"headers":{"date":"Mon, 20 May 2024 02:41:40 GMT","content-type":"application/json;charset=utf-8","content-length":"139","connection":"keep-alive","keep-alive":"timeout=25","access-control-allow-origin":"*","access-control-expose-headers":"*","x-acs-request-id":"076CAAAD-D942-583B-BEFA-C4DF8CCD60DC","x-acs-trace-id":"b31e569bd03bd37030ba2d9e5b0afbd","etag":"1Kp258uXZ5v+Tj9LKzSIaQ09"},"statusCode":200,"body":{"Instances":{"Instance":[]},"NextToken":"","PageNumber":1,"PageSize":10,"RequestId":"076CAAAD-D942-583B-BEFA-C4DF8CCD60DC","TotalCount":0}}

View the result. Click anywhere in the Run window in the lower part of the console and press Ctrl+F to search for statusCode. If "statusCode":200 is displayed, the call was successful.

# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys

from typing import List

from alibabacloud_ecs20140526.client import Client as Ecs20140526Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_ecs20140526 import models as ecs_20140526_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_console.client import Client as ConsoleClient
from alibabacloud_tea_util.client import Client as UtilClient


class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> Ecs20140526Client:
        """
        Initialize the account client using AccessKey ID and AccessKey Secret.
        """
        pass

python ./alibabacloud_sample/sample.py
[LOG] {"headers":{"date":"Mon, 20 May 2024 02:41:40 GMT","content-type":"application/json;charset=utf-8","content-length":"139","connection":"keep-alive","keep-alive":"timeout=25","access-control-allow-origin":"*","access-control-expose-headers":"*","x-acs-request-id":"076CAAAD-D942-583B-BEFA-C4DF8CCD60DC","x-acs-trace-id":"b31e569bd03bd37030ba62d9e5b0afbd","etag":"1Kp258uXZ5v+Tj9LKzSIaQ09..."},"statusCode":200,"body":{"Instances":{"Instance":[]},"NextToken":"","PageNumber":1,"PageSize":10,"RequestId":"076CAAAD-D942-583B-BEFA-C4DF8CCD60DC","TotalCount":0}}

Obtain the SDK.

Go to SDK Center and select a product, such as Elastic Compute Service. Set SDK Version to V2.0 and Language to Python.

Select the Quick Start tab, copy the installation command pip install alibabacloud_ecs20140526==4.1.5 from the Installation section, and run it in your local terminal.

Install the SDK.

In PyCharm, press Alt+F12 to open the terminal. Paste the installation command and press Enter.

(.venv) PS D:\ide\PythonProjects\pythonProject> pip install alibabacloud_ecs20140526==4.1.5
Collecting alibabacloud_ecs20140526==4.1.5
  Obtaining dependency information for alibabacloud_ecs20140526==4.1.5 from https://files.pythonhosted.org/packages/6e/20/b10ac267a8625257dd846df4574c9c171126fbf6h149385af5dee128d756/alibabacloud_ecs20140526-4.1.5-py3-none-any.whl.metadata
  Using cached alibabacloud_ecs20140526-4.1.5-py3-none-any.whl.metadata (2.3 kB)
Collecting alibabacloud-tea-util<1.0.0,>=0.3.12 (from alibabacloud_ecs20140526==4.1.5)
  Using cached alibabacloud_tea_util-0.3.12-py3-none-any.whl
Collecting alibabacloud-tea-openapi<1.0.0,>=0.3.9 (from alibabacloud_ecs20140526==4.1.5)
  Using cached alibabacloud_tea_openapi-0.3.9-py3-none-any.whl
Collecting alibabacloud-openapi-util<1.0.0,>=0.2.1 (from alibabacloud_ecs20140526==4.1.5)
  Using cached alibabacloud_openapi_util-0.2.2-py3-none-any.whl
Collecting alibabacloud-endpoint-util<1.0.0,>=0.0.3 (from alibabacloud_ecs20140526==4.1.5)

Create a Python file.

Right-click the project name and select New > Python File. Enter `sdk_demo` as the file name, select Python File, and press Enter.

Initialize the client.

Initialize the ECS client before calling an API.

import os

from alibabacloud_ecs20140526 import client as ecs_client
from alibabacloud_tea_openapi import models as open_api_models


def init_ecs_client():
    """
    Initializes the ECS client.

    This function takes no arguments.

    Returns:
        ecs_client.Client: An initialized ECS client object for further ECS operations.
    """
    # Create an ECS configuration object and read the AccessKey pair from environment variables.
    ecs_config = open_api_models.Config()
    ecs_config.access_key_id = os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID']
    ecs_config.access_key_secret = os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
    # Set the endpoint.
    ecs_config.endpoint = 'ecs-cn-hangzhou.aliyuncs.com'

    # Initialize the ECS client with the configuration and return it.
    return ecs_client.Client(ecs_config)


if __name__ == '__main__':
    client = init_ecs_client()

Call the API. Review the API Documentation for the target API. The following example calls the `DescribeRegions` API of ECS.

import os

from alibabacloud_ecs20140526 import client as ecs_client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_ecs20140526 import models as ecs_20140526_models


def init_ecs_client():
    """
    Initializes the ECS client.

    This function takes no arguments.

    Returns:
        ecs_client.Client: An initialized ECS client object for further ECS operations.
    """
    # Create an ECS configuration object and read the AccessKey pair from environment variables.
    ecs_config = open_api_models.Config()
    ecs_config.access_key_id = os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID']
    ecs_config.access_key_secret = os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
    # Set the endpoint.
    ecs_config.endpoint = 'ecs-cn-hangzhou.aliyuncs.com'

    # Initialize the ECS client with the configuration and return it.
    return ecs_client.Client(ecs_config)


if __name__ == '__main__':
    # Initialize the ECS client.
    client = init_ecs_client()
    # Create a DescribeRegionsRequest object.
    describeRegions_request = ecs_20140526_models.DescribeRegionsRequest()
    # Send a describeRegions request to get region information.
    response = client.describe_regions(describeRegions_request)
    print(response.body)

Handle exceptions.

The Python V2.0 SDK handles exceptions through `Tea.exceptions` with two exception types:

1. `UnretryableException`: Thrown when the maximum number of retries is reached due to network issues.

2. `TeaException`: Indicates a service error during an SDK request.

import os

from Tea.exceptions import UnretryableException, TeaException
from alibabacloud_ecs20140526 import client as ecs_client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_ecs20140526 import models as ecs_20140526_models


def init_ecs_client():
    """
    Initializes the ECS client.

    This function takes no arguments.

    Returns:
        ecs_client.Client: An initialized ECS client object for further ECS operations.
    """
    # Create an ECS configuration object and read the AccessKey pair from environment variables.
    ecs_config = open_api_models.Config()
    ecs_config.access_key_id = os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID']
    ecs_config.access_key_secret = os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
    # Set the endpoint.
    ecs_config.endpoint = 'ecs-cn-hangzhou.aliyuncs.com'

    # Initialize the ECS client with the configuration and return it.
    return ecs_client.Client(ecs_config)


if __name__ == '__main__':
    try:
        # Initialize the ECS client.
        client = init_ecs_client()
        # Create a DescribeRegionsRequest object.
        describeRegions_request = ecs_20140526_models.DescribeRegionsRequest()
        # Send a describeRegions request to get region information.
        response = client.describe_regions(describeRegions_request)
        # Print the response.
        print(response.body)
    except UnretryableException as e:
        # Handle network exceptions.
        print(e)
    except TeaException as e:
        # Handle service exceptions.
        print(e)
    except Exception as e:
        # Handle other exceptions.
        print(e)

(Optional) Copy sample code from OpenAPI Portal into a file and run it. Auto-generate SDK sample code.