SecretIdis used to identify the API requester, while
SecretKeyis a key used for signature string encryption and authentication by the server. You can get them on the API Key Management page as shown below:
Your security credential represents your account identity and granted permissions, which is equivalent to your login password. Do not disclose it to others.
*.tencentcloudapi.comand varies by product. For example, the endpoint of CVM is
cvm.tencentcloudapi.com. For specific endpoints, please see the API documentation of the corresponding product .
You can install the Tencent Cloud SDK for Python into your project through pip. If you haven't installed pip in your project environment yet, install it first as instructed in Installation.
Run the following command on the command line to install the SDK for Python.
pip install --upgrade tencentcloud-sdk-python
If you have both Python 2 and Python 3 environments, you need to use the pip3 command to install.
Users in the Chinese mainland can use a Tencent Cloud mirror source to speed up the download by running
pip install -i https://mirrors.tencent.com/pypi/simple/ --upgrade tencentcloud-sdk-python for example.
- If you only want to use the package of a specific product, such as CVM, you can install it separately, but this method cannot work together with the full installation method. For example, run
pip install --upgrade tencentcloud-sdk-python-common tencentcloud-sdk-python-cvm.
Go to the GitHub code hosting page to download the latest code, decompress it, and run the following command:
$ cd tencentcloud-sdk-python $ python setup.py install
The following takes the instance list querying API as an example.
from tencentcloud.common import credential from tencentcloud.common.exception.tencent_cloud_sdk_exception import TencentCloudSDKException from tencentcloud.cvm.v20170312 import cvm_client, models try: cred = credential.Credential("secretId", "secretKey") client = cvm_client.CvmClient(cred, "ap-shanghai") req = models.DescribeInstancesRequest() resp = client.DescribeInstances(req) print(resp.to_json_string()) except TencentCloudSDKException as err: print(err)
v3.0.396, Tencent Cloud SDK for Python supports the use of
Common Client mode for requests. You only need to install the
tencentcloud-sdk-python-common package to initiate calls to any Tencent Cloud product.
You must clearly know the parameters required by the called API; otherwise, the call may fail.
For more information on
Common Client, please see example.
You can find more detailed samples in the
examples directory in the GitHub repository.
If there is a proxy in your environment, you can set the proxy in the following two ways:
Otherwise, it may not be called normally, and a connection timeout exception will be thrown.
When you install Python 3.6 or above on macOS, you may encounter a certificate error:
Error: [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: self signed certificate in certificate chain (_ssl.c:1056)..
This is because that on macOS, Python no longer uses the system's default certificate and does not provide a certificate itself. When an HTTPS request is made, the certificate provided by the
certifi library needs to be used, but the SDK does not support specifying it; therefore, you can only solve this problem by installing the certificate with the
sudo "/Applications/Python 3.6/Install Certificates.command" command.
Although this problem should not occur in Python 2, there may be similar situations in specific user environments, which can also be solved with
sudo /Applications/Python 2.7/Install Certificates.command.