tencent cloud

TCCLI Usage
Download PDF
Last updated: 2025-08-19 16:06:31
TCCLI Usage
Last updated: 2025-08-19 16:06:31
Download PDF

Overview

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:
Run the tccli cvm DescribeInstances command to view CVM instances under the current account.
Run the tccli cbs DescribeDisks command to view the list of CBS disks.

Basic Feature Usage

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

Using TCCLI to create a CVM instance

Run the following command to create a CVM instance:
tccli cvm RunInstances \\
--InstanceChargeType POSTPAID_BY_HOUR \\
--Placement '{"Zone":"ap-guangzhou-3"}' \\
--InstanceType S5.SMALL1 \\
--ImageId img-8toqc6s3 \\
--SystemDisk '{"DiskType":"CLOUD_SSD", "DiskSize":50}' \\
--InternetAccessible '{"InternetChargeType":"TRAFFIC_POSTPAID_BY_HOUR","InternetMaxBandwidthOut":10,"PublicIpAssigned":true}' \\
--InstanceCount 1 \\
--InstanceName TCCLI-TEST \\
--LoginSettings '{"Password":"******"}' \\
--SecurityGroupIds '["sg-0rszg2vb"]' \\
--HostName TCCLI-HOST-NAME1

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 < /path/to/file to transfer binary files. Example:
# 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

--cli-unfold-argument

If the API to call uses any structures, you can add --cli-unfold-argument 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 \\
--Placement.Zone ap-guangzhou-3 \\
--ImageId img-8toqc6s3 \\
--DryRun True
Note:
You can press the Tab key to complete --cli-unfold-argument. For details, see Using the Autocomplete Feature.
You can specify --cli-unfold-argument in the command only when using TCCLI 3.0.273.1 or later.

--generate-cli-skeleton

You can use --generate-cli-skeleton 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
The output is as follows:
{
    "Limit": "Integer", 
    "Filters": [
        {
            "Values": [
                "String"
            ], 
            "Name": "String"
        }
    ], 
    "InstanceIds": [
        "String"
    ], 
    "Offset": "Integer"
}
Note:
You can press the Tab key to complete --generate-cli-skeleton. For more information, see Using the Autocomplete Feature.
You can specify --generate-cli-skeleton in the command only when using TCCLI 3.0.273.1 or later.

--cli-input-json

If there are too many input parameters, you can add --cli-input-json in the command to support input through a JSON file. (Add file://file directory after --cli-input-json.) You can use --generate-cli-skeleton 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
Note:
You can press the Tab key to complete --cli-input-json. For more information, see Using the Autocomplete Feature.
You can specify --cli-input-json in the command only when using TCCLI 3.0.250.2 or later.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback