Alibaba Cloud SDK:Use Alibaba Cloud SDKs for Python in an IDE

Go to OpenAPI Explorer. Search for the API operation that you want to use. In this example, the DescribeInstanceTypeFamilies operation of Elastic Compute Service (ECS) is used. Enter DescribeInstanceTypeFamilies in the search box, and click DescribeInstanceTypeFamilies in the search results to go to the API debugging 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.

Open PyCharm, choose File > Open, and select the decompressed project file. In the Creating Virtual Environment dialog box, click OK and wait for the Python virtual environment to be created and dependent resources to be downloaded.

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 SDK demo code.

In the lower part of the PyCharm console, click the Terminal icon or press Alt+F12 to open the terminal. In the terminal, run the following command.

python ./alibabacloud_sample/sample.py

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.

Obtain the SDK.

Go to SDK Center and select the cloud service whose SDK you want to use. In this example, Elastic Compute Service (ECS) is used. Select V2.0 as the SDK version and Python as the programming language.

Install the SDK.

In PyCharm, press ALT+F12 to open the terminal, copy the installation command to the terminal, and then press the Enter key.

Create a .py file.

Right-click the project name and choose New > Python File. In the dialog box that appears, enter the file name, select Python file, and then press the Enter key to create a file. In this example, a file named sdk_demo.py is created.

Initialize the client.

If you want to call the ECS API, you must initialize the ECS client first.

import os

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


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

    This function takes no arguments. 

    Return result:
        ecs_client. Client: an initialized ECS client object that can be used for further operations on ECS. 
    """
    # Create an ECS configuration object and read the AccessKey pair from the 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']
    # Specify the endpoint.
    ecs_config.endpoint = 'ecs-cn-hangzhou.aliyuncs.com'

    # Use the configurations to initialize and return the ECS client.
    return ecs_client.Client(ecs_config)


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

Call the API operation. Before you call an API operation, you must read the corresponding API documentation. In this example, the DescribeRegions operation of ECS is used.

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():
    """
    Initialize the ECS client. 

    This function takes no arguments. 

    Return result:
        ecs_client. Client: an initialized ECS client object that can be used for further operations on ECS. 
    """
    # Create an ECS configuration object and read the AccessKey pair from the 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']
    # Specify the endpoint.
    ecs_config.endpoint = 'ecs-cn-hangzhou.aliyuncs.com'

    # Use the configurations to initialize and return the ECS client.
    return ecs_client.Client(ecs_config)


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

Handle exceptions.

In V2.0 SDKs for Python, exceptions are handled by Tea.exceptions. Exceptions are divided into the following two types:

1. UnretryableException: This type of exceptions are caused by network issues. Such an exception is thrown if the number of retries reaches the upper limit.

2. TeaException: This type of exceptions are caused by business errors.

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():
    """
    Initialize the ECS client. 

    This function takes no arguments. 

    Return result:
        ecs_client. Client: an initialized ECS client object that can be used for further operations on ECS. 
    """
    # Create an ECS configuration object and read the AccessKey pair from the 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']
    # Specify the endpoint.
    ecs_config.endpoint = 'ecs-cn-hangzhou.aliyuncs.com'

    # Use the configurations to initialize and return the ECS client.
    return ecs_client.Client(ecs_config)


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

Optional. You can also copy the sample code provided in OpenAPI Explorer to a file to run the sample code. For more information about how to obtain the sample code, see Automatic generation of SDK examples.