TCCLI Usage

Product Introduction

Purchase Guide

Installing TCCLI

Obtaining Credentials Through Browser Authorization

TCCLI Configuration Method

Using an HTTPS Proxy

Using the Autocomplete Feature

Configuring TCCLI

Obtaining Help Information

Multi-version API Access

Specifying the Nearest Endpoint

Filtering Return Results

Result Polling

Using TCCLI

Using Advanced Features

Operation Guide

Tencent Cloud Command Line Interface

This document describes how to use the basic features of TCCLI.

TCCLI integrates all Tencent Cloud products that support TencentCloud API, and allows you to configure and manage the products. For example, you can use TCCLI to create and operate a Cloud Virtual Machine (CVM) instance, create a Cloud Block Storage (CBS) disk and view its usage, and create a Virtual Private Cloud (VPC) and add resources to it. All operations that can be performed on console pages can be performed by running commands in TCCLI. Examples:

 command to view CVM instances under the current account.

The following examples are based on Linux. Structures in the examples must be in standard JSON format.

Run the following command to create a CVM instance:

--Placement '{"Zone":"ap-guangzhou-2"}' \

--SystemDisk '{"DiskType":"CLOUD_SSD", "DiskSize":50}' \

--InternetAccessible '{"InternetChargeType":"TRAFFIC_POSTPAID_BY_HOUR","InternetMaxBandwidthOut":10,"PublicIpAssigned":true}' \

--LoginSettings '{"Password":"******"}' \

Using standard input to transfer binary files

TCCLI allows you to call APIs with the content type octet-stream. When calling such APIs, you can use standard input 

# Taking the CLS UploadLog API as an example, you can use the following command to upload logs:

tccli cls UploadLog --TopicId xxx < /path/to/file

If the API to call uses any structures, you can add 

 in the command to use a dot (.) as the concatenation operator for structure input. In this case, you can use the autocomplete feature of TCCLI to make the input process easier. Example:

tccli cvm RunInstances --cli-unfold-argument \

https://www.tencentcloud.com/document/product/1013/52423

 to generate a parameter skeleton in JSON format. Example:

# You can also input the generated JSON skeleton into a JSON file.

# $ tccli cvm DescribeInstances --generate-cli-skeleton > /home/test.json

tccli cvm DescribeInstances --generate-cli-skeleton

If there are too many input parameters, you can add 

 in the command to support input through a JSON file. (Add 

 to generate the corresponding JSON file. After specifying parameters in the JSON file, you can use the file to call an API. Example:

tccli cvm DescribeInstances --cli-input-json file:///home/test.json

tencent cloud