tencent cloud

TencentCloud API

製品概要
製品コンセプト
適用シーン
購入ガイド
クイックスタート
入門編の必読資料
API Explorerの使用
TCCLIの使用
CloudShellの利用
開発ガイド
C++ API
.NET API
GO API
Java API
Node.js API
PHP API
Python API
よくある質問
API使用問題
SDK使用問題

TCCLIの使用

PDF
フォーカスモード
フォントサイズ
最終更新日: 2026-01-23 11:39:51
ようこそ、TCCLIへ。TCCLIはTencent Cloudリソースを管理するための統一ツールです。TCCLIを通じて、TencentCloud APIを迅速かつ簡単に呼び出すことで、Tencent Cloudリソースを管理できます。また、TCCLIに基づいて自動化とスクリプト処理を行い、より多様な方法でスクリプトを組み合わせることや再利用することができます。
Tencent Cloud TCCLIは基本機能と高度な機能を含みます。以下の表を参照してください:
機能
説明
TCCLIを設定する
ヘルプメッセージの中国語サポート
JSON、table、text形式の出力フォーマットに対応できる
複数バージョンのAPIへのアクセス
最も近いアクセスポイントを指定する (Endpoint)
返却結果のフィルタリング
入出力パラメータのデータ構造をJSONファイルにエクスポートすることをサポートする
JSONファイルからパラメータを読み取って呼び出すことをサポートする
複雑型のドット(.)接続展開方式の呼び出し

TCCLIをインストールする

1. Python環境とpipツールをインストールします。TCCLIをインストールする前に、お使いのシステムにPython環境とpipツールがインストールされていることを確認してください。詳細については、Python SDKドキュメントを参照してください。
注意:
Pythonのバージョンは2.7以上でなければなりません。詳細については、Pythonおよびpipの公式ドキュメントを参照してください。
TCCLIはTencentCloudApi Python SDKに依存しています。TencentCloudApi Python SDKのバージョンがインストール対象のTCCLIバージョンより低い場合、TCCLIをインストールする時にTencentCloudApi Python SDKが自動的にアップグレードされます。
2. Windows システムでは、Win+Rを押して実行ウィンドウを開き、cmd を入力し、確定をクリックします。本稿は Linux を例とします。
3. コマンドラインウィンドウで、以下のコマンドを実行してTCCLIをインストールします。
pip install tccli
注意:
3.0.96.1により低いバージョンのアップグレードには、以下のコードを実行する必要があります:
sudo pip uninstall tccli jmespath
sudo pip install tccli
4. 以下のコマンドを実行して、TCCLIが正常にインストールされたかどうかを確認します。
tccli --version
以下のような結果が返された場合、TCCLIが正常にインストールされたことを示します。
[root@VM_180_248_centos ~]# tccli --version
3.0.250.1
5. Linux環境では、以下のコマンドを実行してオートコンプリート機能を起動します。大文字小文字の自動修正をサポートします:
complete -C 'tccli_completer' tccli
以下のコードスニペットはオートコンプリートのプロセスを示します:
[root@VM_33_50_centos ~]# tccli c
cam cbs cdn chdfs ckafka cloudhsm cms cr cynosdb
captcha ccc cds cim clb cme configure cvm
cat cdb cfs cis cloudaudit cmq cpdp cws
[root@VM_33_50_centos ~]# tccli cvm R
RebootInstances ResetInstance ResetInstancesType
RenewHosts ResetInstancesInternetMaxBandwidth ResizeInstanceDisks
RenewInstances ResetInstancesPassword RunInstances
[root@VM_33_50_centos ~]# tccli cvm RunInstances --
--ActionTimer --generate-cli-skeleton --InstanceType --SecurityGroupIds
--ClientToken --HostName --InternetAccessible --SystemDisk
--cli-input-json --HpcClusterId --LoginSettings --TagSpecification
--DataDisks --ImageId --output --timeout
--DisasterRecoverGroupIds --InstanceChargePrepaid --Placement --UserData
--DryRun --InstanceChargeType --profile --version
--endpoint --InstanceCount --region --VirtualPrivateCloud
--EnhancedService --InstanceMarketOptions --secretId
--filter --InstanceName --secretKey
[root@VM_33_50_centos ~]# tccli cvm RunInstances --Placement

TCCLIを設定する

1. コマンドラインで以下のコマンドを実行し、インタラクティブモードのクイック設定を行います。
tccli configure
返却結果は以下の通りです。以下の情報を参考に設定してください:
TencentCloud API secretId [*afcQ]:
TencentCloud API secretKey [*ArFd]:
region:
output[json]:
secretId:TencentCloud APIキーのSecretIdです。APIキー管理に移動して取得してください(ルートアカウントは最大2つのTencentCloud APIキーを申請できます)。
secretKey:TencentCloud APIキーのSecretKeyです。APIキー管理に移動して取得してください。
region:クラウド製品のリージョンです。対応するクラウド製品のAPIドキュメントで利用可能なregionを取得してください。例えばCVMの地域リストです。
output:オプションパラメータです。リクエストのレスポンスの出力形式で、JSON、table、textの3形式に対応でき、デフォルトはJSONです。 詳細情報は、tccli configure help コマンドを実行し、確認してください。
2. 以下のコマンドを実行してコマンドラインモードに入ることができます。コマンドラインモードでは、自動化スクリプトでご自身の情報を設定できます。
# setサブコマンドは単一の設定を行うことができ、同時に複数の設定を行うことも可能です。
tccli configure set secretId AKIDwLw1234***********nR2OTI787aBCDP
tccli configure set region ap-guangzhou output json
# getサブコマンドは設定情報を取得するために使用されます。
tccli configure get secretKey
secretKey = OxXj7khcV1234*********dCc1LiArFd
# listサブコマンドはすべての設定情報を出力します。
tccli configure list
credential:
secretId = AKIDwLw1234**********nR2OTI787aBCDP
secretKey = OxXj7khcV1234*********dCc1LiArFd
configure:
region = ap-guangzhou
output = json
詳細情報は、tccli configure [list、get または set] help を実行し、確認してください。例えばtccli configure list helpです。
3. 以下のコマンドを実行して複数のアカウントサポートを設定でき、様々な設定を同時に使用するのが便利です。
# インタラクティブモードでアカウント名 test を指定します。
$ tccli configure --profile test
TencentCloud API secretId [*BCDP]:AKIDwLw1234***********R2OTI787aBCDP
TencentCloud API secretKey [*ArFd]:OxXj7khcV1234*********dCc1LiArFd
region: ap-guangzhou
output[json]:
# set/get/listサブコマンドはアカウント名 test を指定します。このコマンドは前のコマンドと作用が同じです。
$ tccli configure set region ap-guangzhou output json secretId AKIDwLw1234***********R2OTI787aBCDP secretKey OxXj7khcV1234*********dCc1LiArFd --profile test
# 単独で変更可能になりました。例えば地域の変更です:
$ tccli configure set region ap-beijing
# testユーザーのシークレットキーkeyまたは設定を表示するには、以下のコマンドを使用します:
$ tccli configure get secretKey --profile test
$ tccli configure list --profile test
# APIを呼び出す時にアカウントを指定します(例えば、cvm DescribeZones APIです)。
$ tccli cvm DescribeZones --profile test

TCCLIの使用

基本機能

TCCLIは自主設定をサポートしており、ヘルプメッセージは中国語に対応し、さらにJSON、table、textの出力形式をサポートしています。
注意:
サンプル内の単純型でないパラメータは、標準JSON形式でなければならないことに注意してください。
TCCLI は現在以下の3種類の呼び出し方法をサポートしています:
JSON文字列を入力パラメータとした呼び出し
JSONファイルを入力パラメータとした呼び出し (--cli-input-json)
複雑型のドット(.)接続展開形式を入力パラメータとした呼び出し (--cli-unfold-argument)

JSON文字列を入力パラメータとした呼び出しサンプル

以下のコマンドを実行し、1台のCVMを作成します。
$ tccli cvm RunInstances --InstanceChargeType POSTPAID_BY_HOUR --InstanceChargePrepaid '{"Period":1,"RenewFlag":"DISABLE_NOTIFY_AND_MANUAL_RENEW"}' --Placement '{"Zone":"ap-guangzhou-1"}' --InstanceType S1.SMALL1 --ImageId img-8toqc6s3 --SystemDisk '{"DiskType":"CLOUD_BASIC", "DiskSize":50}' --InternetAccessible '{"InternetChargeType":"TRAFFIC_POSTPAID_BY_HOUR","InternetMaxBandwidthOut":10,"PublicIpAssigned":true}' --InstanceCount 1 --InstanceName TCCLI-TEST --LoginSettings '{"Password":"isd@cloud"}' --SecurityGroupIds '["sg-0rszg2vb"]' --HostName TCCLI-HOST-NAME1
以下のコマンドを実行し、クラウド製品 CVM のモニタリングデータを取得します。
[root@VM_33_50_centos ~]# tccli monitor GetMonitorData --Namespace "QCE/CVM" --Period 300 --MetricName "CPUUsage" --Instances '[{"Dimensions":[{"Name":"InstanceId","Value":"ins-cac6a4w8"}]}]'

JSONファイルを入力パラメータとした呼び出し(--cli-input-json)サンプル

1. 以下のコマンドを実行し、入力パラメータのデータ構造をJSONファイルにエクスポートします。
[root@VM_33_50_centos ~]# tccli cvm RunInstances --generate-cli-skeleton > /tmp/RunInstances.json
2. ファイル中のパラメータ値を実際の使用値に置き換え、そのJSONファイルを入力パラメータとして使用します。形式は --cli-input-json の後に file://+ファイルパス を続けます。サンプルは以下の通りです:
[root@VM_33_50_centos ~]# tccli cvm RunInstances --cli-input-json file:///tmp/RunInstances.json
{
"RequestId": "20e2b42d-3260-4750-9293-79116208330e",
"InstanceIdSet": null
}

複雑型のドット(.)接続展開形式を入力パラメータとした呼び出し(--cli-unfold-argument)サンプル

複雑型のドット接続展開呼び出しは、複雑型をドット接続形式で展開する方法です。この方式により、コマンドライン自動補完メカニズムを活用し、入力パラメータが複雑な場合のコマンドライン入力の困難さやエラー発生の問題を解決できます。展開方式は以下の通りです: 複雑型 {"a":{"b": "c"}}--a.b c に展開されます。複雑型配列は.0.1を使用して配列の最初の要素、2番目の要素を表します。基本型配列は.0.1を使用する必要がなく、配列の複数の要素をスペースで区切って直接入力します。例えば、--Integer 10 20--String str1 str2です。
以下のコマンドを実行し、1台のCVMを作成します。
[root@VM_33_50_centos ~]# tccli cvm RunInstances --cli-unfold-argument --InstanceChargeType POSTPAID_BY_HOUR --InstanceChargePrepaid.Period 1 --InstanceChargePrepaid.RenewFlag DISABLE_NOTIFY_AND_MANUAL_RENEW --Placement.Zone ap-guangzhou-1 --InstanceType S1.SMALL1 --ImageId img-8toqc6s3 --SystemDisk.DiskType CLOUD_BASIC --SystemDisk.DiskSize 50 --InternetAccessible.InternetChargeType TRAFFIC_POSTPAID_BY_HOUR --InternetAccessible.InternetMaxBandwidthOut 10 --InternetAccessible.PublicIpAssigned True --InstanceCount 1 --InstanceName TCCLI-TEST --LoginSettings.Password isd@cloud --SecurityGroupIds sg-0rszg2vb --HostName TCCLI-HOST-NAME1

より多くの使用例

以下のコマンドで、TCCLIをさらに使用することもできます:
tccli help コマンドを実行し、サポート対象製品を確認できます。中国語に対応しています。
[root@VM_33_50_centos ~]# tccli help
NAME
tccli
DESCRIPTION
tccli (Tencent Cloud Command Line Interface) is a tool to manage your Tencent Cloud services.
CONFIGURE
Before using tccli, you should use the command(tccli configure) to configure your profile as the default For more in
formation, please enter tccli configure help
USEAGE
tccli [options] <service> [options] <action> [options] [options and parameters]
OPTIONS
help
show the tccli help info
--version
show the version of tccli
AVAILABLE SERVICES
af
APIを使用したローン不正防止の方法について紹介します。ローン不正防止などを含みます。
afc
APIを使用したカスタムモデリングの方法について紹介します。カスタムモデリングなどを含みます。
ame
APIを使用してAuthorized Music Express(AME)を操作する方法を紹介します。素材の取得、データの報告などを含みます。
......
本稿はCVMを例として、tccli cvm help コマンドを実行し、製品がサポートするAPIを確認します。
[root@VM_33_50_centos ~]# tccli cvm help
NAME
cvm
AVAILABLE VERSIONS
2017-03-12
デフォルトでは最新バージョンの情報のみ表示されます。他のバージョンのヘルプ情報を確認するには、--version xxxx-xx-xx を追加してください。
DESCRIPTION
cvm-2017-03-12
APIを使用してCVMを操作する方法を紹介します。インスタンス、イメージ、シークレットキーなどのリソースの使用と管理を含みます。
USEAGE
tccli cvm <action> [--param...]
OPTIONS
help
show the tccli cvm help info
AVAILABLE ACTIONS
AllocateHosts
CDHインスタンスを作成する
AssociateInstancesKeyPairs
キーペアをバインドする
AssociateSecurityGroups
セキュリティグループをバインドする
......
tccli cbs DescribeDisks help コマンドを実行し、APIがサポートするパラメータを確認します。本稿はCBSのDescribeDisks APIを例とします。
[root@VM_33_50_centos ~]# tccli cbs DescribeDisks help
NAME
DescribeDisks
DESCRIPTION
cbs-2017-03-12-DescribeDisks
本API(DescribeDisks)は、CBSのリストを照会するために使用されます。
* CBS ID、CBSタイプまたはCBSステータスなどの情報に基づいてCBSの詳細情報を照会できます。異なる条件間はAND関係です。フィルタ情報の詳細については
フィルター`Filter`を参照してください。
* パラメータが空の場合、現在のユーザーに対して一定数量(`Limit`で指定された数量、デフォルトは20)のCBSリストを返します。
USEAGE
tccli cbs DescribeDisks [--param...]
OPTIONS
help
show the tccli cbs DescribeDisks help info
--region
identify the region to which the instance you want to work with belongs.
--timeout
specify a request timeout
--secretKey
specify a SecretKey
......
AVAILABLE PARAMS
--Limit (Integer | Optional)
返される件数は、デフォルトは20で、最大値は100です。`Limit`の詳細な説明については、API [概要](https://www.tencentcloud.com/document/product/362/15633)の関連セクションを参照してください。
--OrderField (String | Optional)
クラウドディスクリストのソート基準となるフィールドです。取り得る値:<br><li>CREATE_TIME:クラウドディスクの作成時間に基づいてソート<br><li>DEADLINE:クラウドディスクの有効期限に基づいてソート
<br>デフォルトではクラウドディスクの作成時間でソートします。
--Offset (Integer | Optional)
オフセットは、デフォルトは0です。`Offset`の詳細については、API[概要](https://www.tencentcloud.com/document/product/362/15633)の関連セクションを参照してください。
......
出力フォーマットはJSON、tableおよびtext形式をサポートしています。
JSON形式
[root@VM_33_50_centos ~]# tccli cvm DescribeRegions
{
"TotalCount": 20,
"RegionSet": [
{
"RegionState": "AVAILABLE",
"Region": "ap-beijing",
"RegionName": "華北地域(北京)"
},
{
"RegionState": "AVAILABLE",
"Region": "ap-chengdu",
"RegionName": "西南地域(成都)"
},
{
"RegionState": "AVAILABLE",
"Region": "ap-guangzhou",
"RegionName": "華南地域(広州)"
},
{
"RegionState": "AVAILABLE",
"Region": "ap-hongkong",
"RegionName": "香港・マカオ・台湾地域(中国香港)"
},
{
"RegionState": "AVAILABLE",
"Region": "ap-singapore",
"RegionName": "東南アジア地域(シンガポール)"
},
{
"RegionState": "AVAILABLE",
"Region": "ap-tokyo",
"RegionName": "アジア太平洋地域(東京)"
},
{
"RegionState": "AVAILABLE",
"Region": "eu-frankfurt",
"RegionName": "欧州地域(フランクフルト)"
},
......
],
"RequestId": "e5125cf1-****-****-****-316f18eed021"
}
table形式
[root@VM_33_50_centos ~]# tccli cvm DescribeRegions --output table
--
| action |
+---------------------------------------+--------------+
| RequestId | TotalCount |
+---------------------------------------+--------------+
| 1af5f2a0-****-****-****-462f0271a69f | 20 |
+---------------------------------------+--------------+
|| RegionSet ||
|+-------------------+----------------+---------------+|
|| Region | RegionName | RegionState ||
|+-------------------+----------------+---------------+|
|| ap-bangkok | アジア太平洋地域(バンコク) | AVAILABLE ||
|| ap-beijing | 華北地域(北京) | AVAILABLE ||
|| ap-chengdu | 西南地域(成都) | AVAILABLE ||
|| ap-chongqing | 西南地域(重慶) | AVAILABLE ||
|| ap-guangzhou | 華南地域(広州) | AVAILABLE ||
|| ap-guangzhou-open| 華南地域(広州Open) | AVAILABLE ||
|| ap-hongkong | 香港・マカオ・台湾地域(香港) | AVAILABLE ||
|| ap-nanjing | 華東地域(南京) | AVAILABLE ||
|| ap-seoul | アジア太平洋地域(ソウル) | AVAILABLE ||
|| ap-shanghai | 華東地域(上海) | AVAILABLE ||
|| ap-singapore | 東南アジア地域(シンガポール) | AVAILABLE ||
|| ap-tokyo | アジア太平洋地域(東京) | AVAILABLE ||
|| eu-frankfurt | 欧州地域(フランクフルト) | AVAILABLE ||
|| na-ashburn | 米国東部(バージニア) | AVAILABLE ||
|| na-siliconvalley | 米国西部(シリコンバレー) | AVAILABLE ||
|+-------------------+----------------+---------------+|
text フォーマット
[root@VM_33_50_centos ~]# tccli cvm DescribeRegions --output text
70bbd02f-****-****-****-afc5c34018ae 20
REGIONSET ap-bangkok アジア太平洋地域(バンコク) AVAILABLE
REGIONSET ap-beijing 華北地域(北京) AVAILABLE
REGIONSET ap-chengdu 西南地域(成都) AVAILABLE
REGIONSET ap-chongqing 西南地域(重慶) AVAILABLE
REGIONSET ap-guangzhou 華南地域(広州) AVAILABLE
REGIONSET ap-guangzhou-open 華南地域(広州Open) AVAILABLE
REGIONSET ap-hongkong 香港・マカオ・台湾地域(香港) AVAILABLE
REGIONSET ap-nanjing 華東地域(南京) AVAILABLE
REGIONSET ap-seoul アジア太平洋地域(ソウル) AVAILABLE
REGIONSET ap-shanghai 華東地域(上海) AVAILABLE
REGIONSET ap-singapore 東南アジア地域(シンガポール) AVAILABLE
REGIONSET ap-tokyo アジア太平洋地域(東京) AVAILABLE
REGIONSET eu-frankfurt 欧州地域(フランクフルト) AVAILABLE
REGIONSET na-ashburn 米国東部(バージニア) AVAILABLE
REGIONSET na-siliconvalley 米国西部(シリコンバレー) AVAILABLE

高度な機能

この手順では、CVMを例として、複数バージョンのAPIへのアクセスス、最も近いアクセスポイントの指定、返却結果のフィルタリング、入出力パラメータのデータ構造のJSONファイルへのエクスポート、およびJSONファイルからのパラメータ読み取りなど、TCCLIの高度な機能の使用方法を詳しく紹介します。

複数バージョンのAPIへのアクセスス

一部の製品には複数のバージョンのAPIが存在する可能性があり、TCCLIはデフォルトで最新バージョンのAPIにアクセスします。特定の旧バージョンのAPIにアクセスしたい場合は、以下の方法で実現できます。
方式1:CVM製品のデフォルト使用バージョンを2017-03-12に設定します
tccli configure set cvm.version 2017-03-12
方式2:リアルタイム使用時にバージョン番号を指定します
tccli cvm help --version 2017-03-12
tccli cvm DescribeZones help --version 2017-03-12
tccli cvm DescribeZones --version 2017-03-12

最も近いアクセスポイントを指定する (Endpoint)

TCCLIはデフォルトで最も近いアクセスポイントにリクエストを送信してサービスにアクセスします。特定の製品に対して独自のEndpointを指定することもできます。
CVM製品のデフォルトエンドポイントを設定します
tccli configure set cvm.endpoint cvm.ap-guangzhou.tencentcloudapi.com
呼び出し時にリアルタイムで指定します
tccli cvm DescribeZones --endpoint cvm.ap-guangzhou.tencentcloudapi.com

返却結果のフィルタリング

CVM DescribeZones のレスポンスを例として、フィルタリングなしの場合の出力です。
[root@VM_180_248_centos ~]# tccli cvm DescribeZones
{
"TotalCount": 3,
"ZoneSet": [
{
"ZoneState": "AVAILABLE",
"ZoneId": "100001",
"Zone": "ap-guangzhou-1",
"ZoneName": "広州1区"
},
{
"ZoneState": "AVAILABLE",
"ZoneId": "100003",
"Zone": "ap-guangzhou-3",
"ZoneName": "広州3区"
},
{
"ZoneState": "AVAILABLE",
"ZoneId": "100004",
"Zone": "ap-guangzhou-4",
"ZoneName": "広州4区"
}
],
"RequestId": "4fd313a6-****-****-****-898c02fcae02"
}
特定のフィールドのみを表示します。
[root@VM_180_248_centos ~]# tccli cvm DescribeZones --filter TotalCount
3
ある配列型オブジェクトの第N番目のサブオブジェクトの情報を指定します。
[root@VM_180_248_centos ~]# tccli cvm DescribeZones --filter ZoneSet[0]
{
"ZoneState": "AVAILABLE",
"ZoneId": "100001",
"Zone": "ap-guangzhou-1",
"ZoneName": "広州1区"
}
配列型オブジェクト内の、特定名称を持つ全てのサブオブジェクトに対して、特定フィールドの指定をします。
[root@VM_180_248_centos ~]# tccli cvm DescribeZones --filter ZoneSet[*].ZoneName
[
"広州1区",
"広州3区",
"広州4区"
]
配列内のサブオブジェクトをフィルタリングし、同時に新しい名称で表示します。
注意:
フィルタリング動作の説明をシングルクォーテーションで囲む必要があります。
[root@VM_180_248_centos ~]# tccli cvm DescribeZones --filter 'ZoneSet[*].{name:ZoneName, id:ZoneId}'
[
{
"name": "広州1区",
"id": "100001"
},
{
"name": "広州3区",
"id": "100003"
},
{
"name": "広州4区",
"id": "100004"
}
]

関連問題

TCCLIはどのように購入しますか?

本サービスは無料です。問題が発生した場合は、チケットを提出して、対応する支援を求めてください。

API認証をどのように実装しますか?

APIがサポートする各製品ドキュメントディレクトリで、呼び出し方法 > API認証を選択でき、製品のAPI認証ドキュメントと合わせて実装します。例えば、CVM API認証を参照して確認できます。

ヘルプとサポート

この記事はお役に立ちましたか?

フィードバック