# 腾讯云Python API SDK快速起步

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

> 安装Python环境参考[PerfKit Benchmaker快速起步](https://github.com/huataihuang/cloud-atlas-draft/tree/6f3204fffc11cf006abd394631e2598d98b415c3/performance/cloud/perfkit_benchmarker/quick_start/README.md)

## 安装

> 通过pip安装最为方便简洁，本文实践在[PerfKit Benchmaker快速起步](https://github.com/huataihuang/cloud-atlas-draft/tree/6f3204fffc11cf006abd394631e2598d98b415c3/performance/cloud/perfkit_benchmarker/quick_start/README.md)环境基础上完成

```
pip install qcloudapi-sdk-python
```

## 申请安全凭证

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

## 使用

* 列出指定区域（这里案例是`成都`区域）的cvm实例

```python
>>> from QcloudApi.qcloudapi import QcloudApi
>>> module = 'cvm'
>>> action = 'DescribeInstances'
>>> config = {'Region':'ap-guangzhou', 'secretId':'xxxx', 'secretKey':'xxxx', 'Version':'2017-03-20'}
>>> params = {'Limit':1}
>>> service = QcloudApi(module, config)
>>> service.call(action, params)
```

> * `Version` 表示API版本号，主要用于标识请求的不同API版本。 本接口第一版本可传：2017-03-12。

* 启动实例

```python
>>> from QcloudApi.qcloudapi import QcloudApi
>>> module = 'cvm'
>>> action = 'StartInstances'
>>> config = {'Region':'ap-guangzhou', 'secretId':'xxxx', 'secretKey':'xxxx', 'Version':'2017-03-20'}
>>> params = {'InstanceIds.1':'ins-2vo6qtql', 'Version':'2017-03-20'}
>>> service.call(action, params)
'{"Response":{"RequestId":"e3023a10-33ef-4aac-8fe4-7b296a151178"}}'
```

> * `InstanceIds.N` 一个或多个待操作的实例ID。可通过DescribeInstances接口返回值中的InstanceId获取。每次请求批量实例的上限为100。
>
> 参考文档：[启动实例](https://cloud.tencent.com/document/api/213/9386)

## 命令行操作CVM

* 检查帮助

```bash
qcloudcli cvm help
```

* 通过 `qcloudcli addprofile` 命令添加新账号；
* 通过 `qcloudcli showconfigure` 查看账号信息；

### 创建vm

* 创建了一台广州二区（zoneId=100002）的内存为1G（mem=1）的1核（cpu=1）服务器，使用的镜像Id为1，数据盘大小为10G（storageSize=10） 

```bash
qcloudcli cvm RunInstancesHour --zoneId 100002 --cpu 1 --mem 1 --imageId 1 --storageSize 10
```

显示输出

```
{
    "codeDesc": "Success", 
    "message": "", 
    "code": 0, 
    "unInstanceIds": [
        "ins-g5towv5a"
    ]
}
```

* 命令查看当前账号的云服务器资源

```
qcloudcli cvm DescribeInstances
```

> 默认开启的虚拟机没有公网IP地址
>
> `--imageId 1`是`CentOS 6.2 64位`
>
> 详细的创建实例方法参考[创建实例（按量计费）](https://cloud.tencent.com/document/api/213/1350)

* 创建带公网虚拟机

```
qcloudcli cvm RunInstancesHour --zoneId 100002 --cpu 1 --mem 1 --imageId 1 --storageSize 0 --bandwidthType PayByTraffic --bandwidth 1
```

> `--storageSize`是必须项，这里设置0
>
> `--bandwidthType PayByTraffic --bandwidth 1`公网按量计费，带宽1M

* 创建虚拟机以及密钥

```
```

## 销毁vm

## 参考

* [云API SDK  Python](https://cloud.tencent.com/document/developer-resource/494/7244)
* [GigHub: qcloudapi-sdk-python](https://github.com/QcloudApi/qcloudapi-sdk-python)
* [命令行工具CLI](https://cloud.tencent.com/product/cli)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://huataihuang.gitbook.io/cloud-atlas-draft/iaas/tencent/api/qcloud_python_api_startup.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.