Python用のシンプルなLog Service SDKの初期化 - Simple Log Service

LogClientは、Simple Log Serviceへのアクセスに使用できるSDKクライアントです。プロジェクトの作成、Logstoreの作成、ログの書き込み、およびログの読み取りを行うためのさまざまな方法を提供します。 Simple Log Service SDK for Pythonを使用してリクエストを開始するには、LogClientインスタンスを初期化し、ビジネス要件に基づいてLogClientインスタンスのデフォルト設定を変更する必要があります。

前提条件

Python用のSimple Log Service SDKがインストールされています。詳細については、「Simple Log Service SDK For Pythonのインストール」をご参照ください。
必要なアクセス資格情報が設定されます。詳細については、「アクセス資格情報の設定」をご参照ください。
必要なエンドポイントが取得されます。
エンドポイントは、Alibaba Cloudサービスへのアクセスに使用されます。ほとんどの場合、エンドポイントはURLです。エンドポイントは、アクセスプロトコル、ホスト名、ポート、パスなど、サービスに関する情報を指定します。クライアントはこの情報を使用してサービスにアクセスできます。詳細については、「エンドポイント」をご参照ください。 Simple Log Serviceは、パブリックエンドポイント、仮想プライベートクラウド (VPC) エンドポイント、およびアクセラレーションエンドポイントをサポートします。
- パブリックエンドポイント: データがパブリックSimple Log Serviceエンドポイントにプルされると、インターネット経由の読み取りトラフィックが生成されます。課金の詳細については、「従量課金データの課金項目」および「従量課金機能の課金項目」をご参照ください。エンドポイントの詳細については、「エンドポイント」をご参照ください。
- VPCエンドポイント: プロジェクトと同じリージョンにある他のAlibaba CloudサービスからSimple Log Serviceにアクセスする場合は、VPCエンドポイントを使用することを推奨します。詳細については、「エンドポイント」をご参照ください。
- 高速化エンドポイント: サーバーとSimple Log Serviceが中国内外などの異なるリージョンにある場合、インターネット経由でデータを送信するときにネットワークの待ち時間が長くなり、送信が不安定になります。この場合、アクセラレーションエンドポイントを使用できます。詳細については、「転送アクセラレーション機能の使用」をご参照ください。

LogClientインスタンスの初期化

API操作

class LogClient(object):
    """ Construct the LogClient with endpoint, accessKeyId, accessKey.

    :type endpoint: string
    :param endpoint: log service host name, for example, ch-hangzhou.log.aliyuncs.com or https://cn-beijing.log.aliyuncs.com

    :type accessKeyId: string
    :param accessKeyId: aliyun accessKeyId

    :type accessKey: string
    :param accessKey: aliyun accessKey
    """

    __version__ = API_VERSION
    Version = __version__

    def __init__(self, endpoint, accessKeyId=None, accessKey=None, securityToken=None, source=None,
                 auth_version=AUTH_VERSION_1, region='', credentials_provider=None):

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
endpoint	String	対象	エンドポイント。詳細は、「前提条件 (Prerequisites)」をご参照ください。	`cn-hangzhou.log.aliyuncs.com`
accessKeyId	String	対象	AccessKeyペアを使用してアクセス資格情報を設定する場合、このパラメーターをAlibaba CloudアカウントまたはResource access Management (RAM) ユーザーのAccessKey IDに設定します。 AccessKey IDは、ユーザーを識別するために使用されます。詳細については、「アクセス資格情報の設定」をご参照ください。警告 Alibaba CloudアカウントのAccessKeyペアには、リソースに対する完全な権限があります。 AccessKeyペアのリークによるリスクを回避するため、Alibaba CloudアカウントのAccessKeyペアを使用しないことを推奨します。最小権限の原則に基づいて権限が付与されたRAMユーザーのAccessKeyペアを使用することを推奨します。 Security Token Service (STS) を使用してアクセス資格情報を設定する場合、このパラメーターを、AssumeRole操作によって返されるcredentialsパラメーターの下のAccessKeyIdパラメーターの値に設定します。	`LTAI****************`
accessKey	String	対象	AccessKeyペアを使用してアクセス資格情報を設定する場合、このパラメーターをAlibaba CloudアカウントまたはRAMユーザーのAccessKeyシークレットに設定します。 AccessKeyシークレットは、AccessKey IDの検証に使用されます。詳細については、「アクセス資格情報の設定」をご参照ください。 STSを使用してアクセス資格情報を設定する場合、このパラメーターを、AssumeRole操作によって返されるcredentialsパラメーターの下のAccessKeySecretパラメーターの値に設定します。	`yourAccessKeySecret`
securityToken	String	任意	このパラメーターは、STSを使用してアクセス資格情報を設定する場合にのみ必要です。このパラメーターを、AssumeRole操作によって返されるCredentialsパラメーターの下のSecurityTokenパラメーターの値に設定します。 Alibaba Cloud STSは、STSトークンの長さに制限を課していません。 STSトークンの最大長を指定しないことを推奨します。 STSトークンの取得方法の詳細については、「AssumeRole」をご参照ください。	`********`
source	String	任意	ソース。このパラメーターを設定しないと、サーバーのIPアドレスが自動的に使用されます。	`10.105.214.**`
auth_version	String	任意	認証のプロトコルバージョンを指定します。有効な値: `AUTH_VERSION_1`および`AUTH_VERSION_4`。デフォルト値: `AUTH_VERSION_1` このパラメーターを`AUTH_VERSION_4`に設定することを推奨します。これにより、セキュリティが向上します。 `AUTH_VERSION_4`を使用する場合は、regionパラメーターも設定する必要があります。	`AUTH_VERSION_1`
region	String	任意	プロジェクトのリージョン Simple Log Serviceのサポート対象リージョンの詳細については、「サポート対象リージョン」をご参照ください。	`cn-杭州`

例

AccessKeyペアベースの初期化 (署名の場合はAUTH_VERSION_4)

# Import the Simple Log Service SDK for Python package. 
from aliyun.log import *
from aliyun.log.auth import AUTH_VERSION_4

# If you obtain an AccessKey pair from environment variables, you must import an operating system (OS) library. 
import os

# Obtain an AccessKey ID and an AccessKey secret from environment variables.
access_key_id = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_ID', '')
access_key_secret = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_SECRET', '')

# Specify a Simple Log Service endpoint.
endpoint = "yourEndpoint"

# Create a LogClient instance. In this example, use AUTH_VERSION_4 for signing and the China (Hangzhou) region.
client = LogClient(endpoint, access_key_id, access_key_secret, auth_version=AUTH_VERSION_4, region='cn-hangzhou')

AccessKeyペアベースの初期化 (署名の場合はAUTH_VERSION_1)

# Import the Simple Log Service SDK for Python package. 
from aliyun.log import *

# If you obtain an AccessKey pair from environment variables, you must import an OS library. 
import os

# Obtain an AccessKey ID and an AccessKey secret from environment variables.
access_key_id = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_ID', '')
access_key_secret = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_SECRET', '')

# Specify a Simple Log Service endpoint.
endpoint = "yourEndpoint"

# Create a LogClient instance.
client = LogClient(endpoint, access_key_id, access_key_secret)

STSベースの初期化

# Import the Simple Log Service SDK for Python package. 
from aliyun.log import *

# If you obtain an AccessKey pair from environment variables, you must import an OS library. 
import os

# Obtain an AccessKey ID and an AccessKey secret from environment variables.
access_key_id = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_ID', '')
access_key_secret = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_SECRET', '')
securityToken = os.environ.get('ALIBABA_CLOUD_STS_TOKEN')
# Specify a Simple Log Service endpoint.
endpoint = "yourEndpoint"

# Create a LogClient instance.
client = LogClient(endpoint, access_key_id, access_key_secret, securityToken)

Simple Log Service:Python用のシンプルなLog Service SDKの初期化