Tüm Ürünler
Search
Belge Merkezi

Alibaba Cloud SDK:IDE'de Alibaba Cloud Python SDK Kullanımı

Son Güncelleme:Oct 07, 2026

Windows üzerinde PyCharm ile Alibaba Cloud Python SDK'nın nasıl kullanılacağını öğrenin.

Ön Koşullar

SDK'yı Kullanma

OpenAPI Portal'dan Örnek Projeyi Kullanma

Not

OpenAPI Portal'dan örnek projeyi indiremiyorsanız Mevcut Bir Projede SDK Kullanımı bölümündeki adımları uygulayın.

  1. OpenAPI Explorer sayfasına gidin ve bir ürün ile API seçin. Örneğin, ECS'nin DescribeInstanceTypeFamilies API'sini çağırmak için arama kutusuna DescribeInstanceTypeFamilies yazın ve sonuca tıklayarak OpenAPI Explorer sayfasına gidin.

  2. Orta sütundaki Parameters sekmesinde iş gereksinimlerinize göre parametreleri belirtin. Parametreleri belirtirken en sağdaki sütunda yer alan Document sekmesindeki bilgileri okuyun. İşlemin kullanım notlarını ve her bir parametrenin açıklamasını anladığınızdan emin olun. Faturalandırma ile ilgili bilgilere dikkat edin. Bu örnekte DescribeInstanceTypeFamilies işlemi iki istek parametresini destekler. RegionId parametresi için cn-hangzhou gibi bir değer belirtmeniz gerekir. Generation parametresi isteğe bağlıdır. Bu parametreyi V serisi örnek ailesini gösteren ecs-5 olarak ayarlayabilirsiniz. Parametrelerin geçerli değerlerini Document sekmesinde görüntüleyebilirsiniz.

  3. En sağdaki sütunda bulunan SDK Sample Code sekmesinde bir programlama dili seçin ve tam SDK projesini bilgisayarınıza indirmek için Download Project öğesine tıklayın. Ardından paketi açın.

    SDK Version değerini V2.0 Recommended olarak, Language değerini Python olarak ayarlayın ve Download Complete Project öğesine tıklayın.

  4. PyCharm'ı açın. File > Open yolunu izleyin, sıkıştırması açılmış proje klasörünü seçin ve Creating Virtual Environment iletişim kutusunda OK düğmesine tıklayın. PyCharm'ın sanal ortamı oluşturmasını ve bağımlılıkları indirmesini bekleyin.

    Not

    Bağımlılıklar indirilemezse terminalde python3 setup.py install komutunu çalıştırın.

  5. Bu işlemi çağırmadan önce erişim kimlik bilgisi olarak bir AccessKey çifti almanız gerekir. Bir Resource Access Management (RAM) kullanıcısının AccessKey çiftini kullanmanızı öneririz. Daha fazla bilgi için "AccessKey Oluşturma" konusunun RAM Kullanıcısı İçin AccessKey Oluşturma bölümüne bakın.

    Önemli

    Bir RAM kullanıcısının AccessKey çiftini aldıktan sonra bu kimlik bilgilerini ortam değişkenlerinde yapılandırmanız gerekir. Daha fazla bilgi için bkz. Linux, macOS ve Windows'ta Ortam Değişkenlerini Yapılandırma.

  6. Örnek kodu çalıştırın.

    PyCharm'ın alt kısmındaki Terminal sekmesine tıklayın veya Alt + F12 tuşlarına basın. Aşağıdaki komutu çalıştırın:

    python ./alibabacloud_sample/sample.py
    

    sample.py içeriği:

    # -*- 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 çıktısı:

    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}}
    
  7. Sonucu görüntüleyin. Konsolun alt kısmındaki Run penceresinde herhangi bir yere tıklayın ve statusCode ifadesini aramak için Ctrl+F tuşlarına basın. "statusCode":200 ifadesi görüntüleniyorsa çağrı başarılı olmuştur.

    # -*- 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}}
    

Mevcut Bir Projede SDK Kullanımı

  1. SDK'yı edinin.

    SDK Center adresine gidin ve Elastic Compute Service gibi bir ürün seçin. SDK Version değerini V2.0 olarak ve Language değerini Python olarak ayarlayın.

    Quick Start sekmesini seçin, Installation bölümünden pip install alibabacloud_ecs20140526==4.1.5 yükleme komutunu kopyalayın ve yerel terminalinizde çalıştırın.

  2. SDK'yı yükleyin.

    PyCharm'da terminali açmak için Alt+F12 tuşlarına basın. Yükleme komutunu yapıştırın ve Enter tuşuna basın.

    (.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)
    
  3. Bir Python dosyası oluşturun.

    Proje adına sağ tıklayın ve New > Python File seçeneklerini belirleyin. Dosya adı olarak sdk_demo girin, Python File seçeneğini işaretleyin ve Enter tuşuna basın.

  4. İstemciyi başlatın.

    Bir API'yi çağırmadan önce ECS istemcisini başlatın.

    Önemli
    1. İstemciyi başlatırken kimlik doğrulamayı tamamlamak için bir AccessKey çifti kullanmanız gerekir. Bu durumda önceden bir AccessKey çifti edinmeniz gerekir. AccessKey çifti edinme hakkında daha fazla bilgi için bkz. AccessKey Oluşturma.

    2. Bir RAM kullanıcısının AccessKey çiftini aldıktan sonra bu kimlik bilgilerini ortam değişkenlerinde yapılandırmanız gerekir. Daha fazla bilgi için bkz. Linux, macOS ve Windows'ta Ortam Değişkenlerini Yapılandırma.

    3. Uç noktanın nasıl yapılandırılacağı hakkında daha fazla bilgi için bkz. Uç Noktalar.

    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()
    
  5. API'yi çağırın. Hedef API için API Belgeleri inceleyin. Aşağıdaki örnek ECS'nin DescribeRegions API'sini çağırır.

    Not

    Her API, DescribeRegionsRequest gibi ${APIName}${Request} adlandırma kuralını izleyen ayrı bir istek nesnesine sahiptir.

    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)
    
  6. Hataları yönetin.

    Python V2.0 SDK, hataları iki hata türüyle Tea.exceptions aracılığıyla yönetir:

    1. UnretryableException: Ağ sorunları nedeniyle maksimum yeniden deneme sayısına ulaşıldığında tetiklenir.

    2. TeaException: Bir SDK isteği sırasında hizmet hatasını gösterir.

    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)
    
  7. (İsteğe bağlı) OpenAPI Portal'dan örnek kodu bir dosyaya kopyalayın ve çalıştırın. SDK Örnek Kodunu Otomatik Oluşturma.

Referanslar

Gelişmiş Belgeler