Alibaba Cloud SDK:SDK Entegrasyonu

İstek istemcisini başlatma

Tüm OpenAPI çağrıları SDK tarafından sağlanan istek istemcisi (Client) aracılığıyla yapılır. Herhangi bir OpenAPI işlemi çağırmadan önce istek istemcisini başlatın. İstek istemcisi birden çok başlatma yöntemini destekler. Bu örnekte bir AccessKey çifti kullanılmaktadır. Daha fazla başlatma yöntemi için bkz. Erişim kimlik bilgilerini yönetme.

• İstemci nesneleri iş parçacığı güvenlidir. Örneğin, çok iş parçacıklı bir ortamda tek bir Dysmsapi20180501Client örneğini güvenle paylaşabilirsiniz. Her iş parçacığı için ayrı bir örnek oluşturmanız gerekmez.

• İstemci nesnelerini sık sık oluşturmayın. Sık oluşturmak kaynak israfına neden olur ve performansı düşürür. (Önerilen) İstemciyi sarmak için singleton desenini kullanın ve uygulama yaşam döngüsü boyunca aynı erişim kimlik bilgileri ve uç nokta için yalnızca bir istemci örneğinin başlatıldığından emin olun.

@staticmethod
def create_client() -> Dysmsapi20180501Client:
    config = open_api_models.Config(
        # Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID environment variable is set.
        access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
        # Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variable is set.
        access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
    )
    # See https://api.alibabacloud.com/product/Dysmsapi.
    config.endpoint = f'dysmsapi.aliyuncs.com'
    return Dysmsapi20180501Client(config)

İstek nesnesi oluşturma

Bir OpenAPI işlemi çağrılırken parametreleri iletmek için SDK tarafından sağlanan istek nesnesini kullanın. İstek nesneleri <API operation name>Request biçiminde adlandırılır. İstek parametreleri hakkında daha fazla bilgi için ilgili API belgelerine bakın. Bu örnekte kullanılan API belgeleri için bkz. SendMessageToGlobe.

Bir OpenAPI işlemi istek parametrelerini desteklemiyorsa istek nesnesi oluşturmanız gerekmez. Örneğin, DescribeCdnSubList işlemi istek parametrelerini desteklemez.

# Create a request object and set the required input parameters.
send_message_to_globe_request = dysmsapi_20180501_models.SendMessageToGlobeRequest(
    # Replace with the recipient number.
    to='<YOUR_NUMBER>',
    # Replace with the SMS content.
    message='<YOUR_MESSAGE>'
)

İsteği gönderme

(Önerilen) İsteği göndermek için <api_name>_with_options işlevini çağırın; burada <api_name> snake_case biçimindeki OpenAPI adıdır. İşlev iki parametre alır: önceki adımda oluşturulan istek nesnesi ve bir çalışma zamanı seçenekleri nesnesi. Çalışma zamanı seçenekleri nesnesi zaman aşımı ayarları ve proxy ayarları gibi istek davranışını yapılandırır. Daha fazla bilgi için bkz. Gelişmiş Yapılandırmalar.

İstek başarılı olursa işlev bir yanıt nesnesi döndürür. Çağrı sonucunu doğrulamak için yanıtı yazdırın veya günlüğe kaydedin.

Bir OpenAPI işlemi istek parametrelerini desteklemiyorsa isteği gönderirken bir istek nesnesi iletmeniz gerekmez. Örneğin, DescribeCdnSubList işlemini çağırırken yalnızca çalışma zamanı seçeneklerini iletirsiniz.

# Create runtime parameters.
runtime = util_models.RuntimeOptions()
client = create_client()
# Send the request.
client.send_message_to_globe_with_options(send_message_to_globe_request, runtime)

Özel durumları işleme

V2.0 Python SDK özel durumları iki ana türe ayırır:

• TeaUnretryableException: Ağ sorunları nedeniyle, ağ yeniden denemeleri maksimum yeniden deneme sayısına ulaştığında oluşturulur.

• TeaException: Temel olarak sunucu tarafındaki iş hataları için oluşturulur.

  Özel durum işleme hakkında daha fazla bilgi için bkz. Özel durum işleme.

Tam kod örneği

Aşağıdaki örnek önceki adımları birleştirir: istek istemcisini başlatma, istek nesnesi oluşturma, isteği gönderme ve özel durumları işleme.

import os
import sys
from typing import List
from alibabacloud_dysmsapi20180501.client import Client as Dysmsapi20180501Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dysmsapi20180501 import models as dysmsapi_20180501_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient

class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> Dysmsapi20180501Client:
        config = open_api_models.Config(
            # Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID environment variable is set.
            access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
            # Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variable is set.
            access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
        )
        # See https://api.alibabacloud.com/product/Dysmsapi.
        config.endpoint = f'dysmsapi.aliyuncs.com'
        return Dysmsapi20180501Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        # Create a request object and set the required input parameters.
        send_message_to_globe_request = dysmsapi_20180501_models.SendMessageToGlobeRequest(
            # Replace with the recipient number.
            to='<YOUR_NUMBER>',
            # Replace with the SMS content.
            message='<YOUR_MESSAGE>'
        )
        # Create runtime parameters.
        runtime = util_models.RuntimeOptions()
        try:
            # Send the request.
            send_message_to_globe_response = client.send_message_to_globe_with_options(send_message_to_globe_request, runtime)
            # Print the API response to verify the result.
            print(send_message_to_globe_response)
        except Exception as error:
            # For demonstration purposes only. Handle exceptions with care and never ignore exceptions in your project.
            # The error message.
            error_message = getattr(error, 'message', str(error))
            print(error_message)
            # The diagnostic URL.
            print(getattr(error, 'data', {}).get("Recommend"))
            UtilClient.assert_as_string(error_message)

if __name__ == '__main__':
    Sample.main(sys.argv[1:])

def create_client() -> facebody20191230Client:
    config = open_api_models.Config(
        # Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID environment variable is set in your code execution environment.
        access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
        # Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variable is set in your code execution environment.
        access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
    )
    # The endpoint and regionId must be set to the same region.
    config.region_id = 'cn-shanghai'
    config.endpoint = 'facebody.cn-shanghai.aliyuncs.com'
    return facebody20191230Client(config)

# Open the file as a binary stream.
with open('<FILE_PATH>', "rb") as f:  # Replace with your file path.
    # Set request parameters.
    detect_body_count_advance_request = facebody_20191230_models.DetectBodyCountAdvanceRequest(
        image_urlobject=f,
    )

# Runtime configuration.
runtime = util_models.RuntimeOptions()
client = create_client()
# Send the request.
res = client.detect_body_count_advance(detect_body_count_advance_request, runtime)

import os

from alibabacloud_facebody20191230 import models as facebody_20191230_models
from alibabacloud_facebody20191230.client import Client as facebody20191230Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_tea_util import models as util_models

class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> facebody20191230Client:
        config = open_api_models.Config(
            # Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID environment variable is set in your code execution environment.
            access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
            # Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variable is set in your code execution environment.
            access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
        )
        config.region_id = 'cn-shanghai'
        config.endpoint = 'facebody.cn-shanghai.aliyuncs.com'
        return facebody20191230Client(config)

    @staticmethod
    def main() -> None:
        client = Sample.create_client()
        # Open the file as a binary stream.
        with open('<FILE_PATH>', "rb") as f:  # Replace <FILE_PATH> with your file path.
            # Set request parameters.
            detect_body_count_advance_request = facebody_20191230_models.DetectBodyCountAdvanceRequest(
                image_urlobject=f,
            )
            runtime = util_models.RuntimeOptions()
            try:
                # Send the request.
                res = client.detect_body_count_advance(detect_body_count_advance_request, runtime)
                print(res)
            except Exception as error:
                # This is for printing and demonstration purposes only. Handle exceptions with care and do not ignore them in your project.
                print(error)

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

"You are not authorized to perform this operation"

Neden: AccessKey çiftinizle ilişkili RAM kullanıcısının bu API işlemini çağırma izni yok.

Çözüm: Gerekli OpenAPI izinlerini RAM kullanıcısına verin. Bir RAM kullanıcısına izin verme hakkında daha fazla bilgi için bkz. RAM kullanıcı izinlerini yönetme.

Örneğin, RAM kullanıcısı ilgili izne sahip değilse SendMessageToGlobe işlemi çağrıldığında bu hata döndürülür. Aşağıdakine benzer özel bir izin ilkesi oluşturun ve ilgili izinleri RAM kullanıcısına verin.

{
  "Version": "1",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": "dysms:SendMessageToGlobe",
      "Resource": "*"
    }
  ]
}

"SDK.EndpointResolvingError"

Neden: Çağırdığınız OpenAPI işlemi istek istemcisini başlatırken belirtilen uç noktayı desteklemiyor.

Çözüm: Uç nokta yapılandırması kontrol edin, uç noktayı desteklenen bir değerle güncelleyin ve ardından OpenAPI işlemini tekrar çağırın.

AccessKey ile İlgili AttributeError veya KeyError

Bir OpenAPI çağrısı AttributeError: 'AttributeError' object has no attribute 'message' veya KeyError: 'ALIBABA_CLOUD_ACCESS_KEY_ID' hatası bildiriyor.

Neden: AccessKey çifti doğru şekilde iletilmemiş.

Çözüm: İstek istemcisini başlatırken AccessKey çiftinin doğru şekilde iletildiğini kontrol edin. os.environ["XXX"] ifadesinin XXX değerini ortam değişkenlerinden aldığını unutmayın.

SDK kullanırken karşılaştığınız hatalara ilişkin diğer çözümler için bkz. SSS.