# api-python-sdk

**Repository Path**: mirrors_tencentyun/api-python-sdk

## Basic Information

- **Project Name**: api-python-sdk
- **Description**: 腾讯云 API 2.0 SDK for python
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-18
- **Last Updated**: 2025-11-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### qcloudapi-sdk-python

qcloudapi-sdk-python是为了让Python开发者能够在自己的代码里更快捷方便的使用腾讯云的API而开发的SDK工具包。

#### 更新历史

* [5/24] 添加Cbs、Snapshot和Scaling模块

#### 资源

* [公共参数](http://wiki.qcloud.com/wiki/%E5%85%AC%E5%85%B1%E5%8F%82%E6%95%B0)
* [API列表](http://wiki.qcloud.com/wiki/API)
* [错误码](http://wiki.qcloud.com/wiki/%E9%94%99%E8%AF%AF%E7%A0%81)

#### 入门

1. 申请安全凭证。
在第一次使用云API之前，用户首先需要在腾讯云网站上申请安全凭证，安全凭证包括 SecretId 和 SecretKey, SecretId 是用于标识 API 调用者的身份，SecretKey是用于加密签名字符串和服务器端验证签名字符串的密钥。SecretKey 必须严格保管，避免泄露。

2. 下载SDK，放入到您的程序目录。
使用方法请参考下面的例子。

#### 例子

    #!/usr/bin/python
    # -*- coding: utf-8 -*-

    # 引入云API入口模块
    from src.QcloudApi.qcloudapi import QcloudApi

    '''
    module 设置需要加载的模块
    已有的模块列表：
    cvm      对应   cvm.api.qcloud.com
    cdb      对应   cdb.api.qcloud.com
    lb       对应   lb.api.qcloud.com
    trade    对应   trade.api.qcloud.com
    sec      对应   csec.api.qcloud.com
    image    对应   image.api.qcloud.com
    monitor  对应   monitor.api.qcloud.com
    cdn      对应   cdn.api.qcloud.com
    '''
    module = 'sec'

    '''
    action 对应接口的接口名，请参考wiki文档上对应接口的接口名
    '''
    action = 'CaptchaQuery'

    config = {
        'Region': '区域参数',
        'secretId': '你的secretId',
        'secretKey': '你的secretKey',
        'method': 'get'
    }

    '''
    params 请求参数，请参考wiki文档上对应接口的说明
    '''
    params = {
        'userIp': '127.0.0.1',
        'businessId': 1,
        'captchaType': 1,
        'script': 0,
        # 'Region': 'gz', # 当Region不是上面配置的DefaultRegion值时，可以重新指定请求的Region
    }
    try:
        service = QcloudApi(module, config)

        # 请求前可以通过下面四个方法重新设置请求的secretId/secretKey/region/method参数
        # 重新设置请求的secretId
        secretId = '你的secretId'
        service.setSecretId(secretId)
        # 重新设置请求的secretKey
        secretKey = '你的secretKey'
        service.setSecretKey(secretKey)
        # 重新设置请求的region
        region = 'sh'
        service.setRegion(region)
        # 重新设置请求的method
        method = 'post'
        service.setRequestMethod(method)

        # 生成请求的URL，不发起请求
        print service.generateUrl(action, params)
        # 调用接口，发起请求
        print service.call(action, params)
    except Exception, e:
        print 'exception:', e

#### 常见问题

* 如果碰到ImportError: No module named requests.auth 请安装 requests.[request说明](https://github.com/kennethreitz/requests)