Tencent Cloud SDK for Python

Warnings

• gotcha On macOS, Python 3.6+ users may encounter SSL certificate verification errors. This is due to Python no longer using system certificates. You typically need to run `/Applications/Python 3.6/Install Certificates.command` (adjust path for your Python version) to install `certifi`'s certificates.
  Fix: Run the `Install Certificates.command` script found within your Python installation directory on macOS.
• gotcha Do not mix the full SDK package (`tencentcloud-sdk-python`) with individual product packages (e.g., `tencentcloud-sdk-python-cvm`) in the same environment. This can lead to conflicts and unexpected behavior.
  Fix: Choose either the full SDK or specific product SDKs for installation, but not both simultaneously in one environment.
• gotcha If operating behind a proxy, you must explicitly set the `https_proxy` system environment variable, otherwise, connection timeout exceptions may occur.
  Fix: Set the `https_proxy` environment variable (e.g., `export https_proxy="http://your_proxy_ip:port"`).
• breaking The default language of the SDK has been changed to `en-US` in recent versions. If your application relies on localized responses, this change might affect the output of SDK calls.
  Fix: Explicitly set the language parameter in your client profile or request if you require a different language for responses.

Install

• pip install tencentcloud-sdk-python Standard Installation
• pip install --upgrade tencentcloud-sdk-python-common tencentcloud-sdk-python-cvm Install specific product SDKs (e.g., CVM)
• pip install -i https://mirrors.tencent.com/pypi/simple/ --upgrade tencentcloud-sdk-python Chinese mainland mirror source

Imports

• Credential

  from tencentcloud.common import credential

• TencentCloudSDKException

  from tencentcloud.common.exception.tencent_cloud_sdk_exception import TencentCloudSDKException

• CvmClient, models

  from tencentcloud.cvm.v20170312 import cvm_client, models

  Product-specific imports will vary by service and API version (e.g., `cvm.v20170312`).

Quickstart

This quickstart demonstrates how to initialize the client with credentials, create a request object for the CVM `DescribeInstances` API, and execute the call. Ensure `TENCENTCLOUD_SECRET_ID` and `TENCENTCLOUD_SECRET_KEY` environment variables are set for authentication.

import os
from tencentcloud.common import credential
from tencentcloud.common.exception.tencent_cloud_sdk_exception import TencentCloudSDKException
from tencentcloud.cvm.v20170312 import cvm_client, models

try:
    # Get credentials from environment variables (recommended for security)
    secret_id = os.environ.get('TENCENTCLOUD_SECRET_ID', 'YOUR_SECRET_ID')
    secret_key = os.environ.get('TENCENTCLOUD_SECRET_KEY', 'YOUR_SECRET_KEY')

    # Check if credentials are placeholders
    if secret_id == 'YOUR_SECRET_ID' or secret_key == 'YOUR_SECRET_KEY':
        print("Please set TENCENTCLOUD_SECRET_ID and TENCENTCLOUD_SECRET_KEY environment variables.")
        exit(1)

    cred = credential.Credential(secret_id, secret_key)

    # Instantiate the client object for a specific product (e.g., CVM)
    # The second parameter is the region, e.g., 'ap-shanghai' or 'ap-guangzhou'
    client = cvm_client.CvmClient(cred, "ap-shanghai")

    # Instantiate a request object for the API (e.g., DescribeInstancesRequest)
    req = models.DescribeInstancesRequest()

    # Call the API method through the client object
    resp = client.DescribeInstances(req)

    # Print the returned response in JSON format
    print(resp.to_json_string())

except TencentCloudSDKException as err:
    print(f"An error occurred: {err}")
except Exception as e:
    print(f"An unexpected error occurred: {e}")