English · 简体中文
pyqcloud-sdk is a Python package that simplifies the calling of Tencent Cloud product APIs. With just a product ID, region, operation code, and request parameters, you can achieve API calls. The main features are:
- Simplified and unified API calling method
- Automatic handling of authentication, region, and client settings
- Supports all services supported by the original SDK
- Supports custom log configuration
- Based on tencentcloud-sdk-python-common, providing a higher-level abstraction
- Pre-fetches product interface information from tencentcloud-sdk-python
Install using pip:
pip install pyqcloud-sdkSupports Python 3.6+
import logging
from pyqcloud_sdk import Services, setup_logging
# Set up logging (optional)
setup_logging(level=logging.INFO)
# Initialize service
service = Services(
name="cvm", # Service name, required
region="ap-guangzhou", # Region, required
secret_id="your_secret_id", # Optional, default reads from environment variable
secret_key="your_secret_key", # Optional, default reads from environment variable
version="2017-03-12" # Optional, API version, default is the latest version
)
# Call API
response = service.call("DescribeInstances", {"Limit": 1})
print(response)It is recommended to set authentication information using environment variables:
- Default reads
TENCENTCLOUD_SECRET_IDandTENCENTCLOUD_SECRET_KEY - Use
set_secret_from_env()to specify custom environment variable names:
service.set_secret_from_env('CUSTOM_ID_ENV', 'CUSTOM_KEY_ENV')from pyqcloud_sdk.exceptions import ServiceError, ClientError
try:
response = service.call("DescribeInstances", {})
except ServiceError as e:
print(f"Service error: {e}")
except ClientError as e:
print(f"Client error: {e}")
...from pyqcloud_sdk import setup_logging
import logging
setup_logging(level=logging.DEBUG, format="%(asctime)s - %(levelname)s - %(message)s")- Keep SecretId and SecretKey safe and avoid leakage.
- In production environments, it is recommended to store sensitive information using environment variables or configuration files.
- This package automatically handles most API call retries, but special cases may require custom retry logic.
- Before using, ensure that the necessary access permissions have been granted in the Tencent Cloud console and that the corresponding services have been enabled.
This project is licensed under the MIT License. See the LICENSE file for details.