云服务器特惠 99/年起
  1. 腾讯云优惠网首页
  2. 腾讯云产品

腾讯云命令行工具 TCCLI 配置方法

• 腾讯云产品

这篇指导你如何配置初始化 TCCLI，包括如何使用交互模式、命令行模式进行初始化，以及如何进行账户切换。

相关产品
腾讯云命令行工具 产品页，含版本规格、价格与购买入口。

一、前提条件

已安装 TCCLI，详情请参见 安装 TCCLI。

二、操作步骤

使用 TCCLI 前你需要进行一些初始化配置，使其完成使用云 API 的必要前提条件。

注意：说明：

注意：下文中 secretId、secretKey、地域等信息仅作为示例，请以实际情况为准。

三、交互模式

你可以通过执行 tccli configure 命令进入交互模式快速配置。

$ tccli configureTencentCloud API secretId [*afcQ]:**************TencentCloud API secretKey [*ArFd]:**************region: ap-guangzhououtput[json]:

说明：

·secretId：云 API 密钥 SecretId，前往 API 密钥管理 获取。

·secretKey：云 API 密钥 SecretKey，前往 API 密钥管理 获取。

·region：云产品地域，请前往对应云产品的 API 文档 获取可用的 region。例如云服务器的 地域列表。

·output：可选参数，请求返回包输出格式，支持 [json table text] 三种格式，默认为 json。更多信息请执行 tccli configure help 查看。

四、命令行模式

通过命令行模式你可以在自动化脚本中配置你的信息。

# set 子命令可以设置某一配置，也可同时配置多个$ tccli configure set secretId **************$ tccli configure set region ap-guangzhou output json# get 子命令用于获取配置信息$ tccli configure get secretKeysecretKey = **************# list 子命令打印所有配置信息$ tccli configure listcredential:secretId = **************secretKey = **************configure:region = ap-guangzhououtput = json# 在命令行中直接指定secretId和secretKey的值，如查询cvm实例信息：$ tccli cvm DescribeInstances –secretId ************** –secretKey **************

五、多账户支持

TCCLI 支持多账户，方便你多种配置同时使用。

# 在交互模式中指定账户名 test$ tccli configure –profile testTencentCloud API secretId [*BCDP]:**************TencentCloud API secretKey [*ArFd]:**************region: ap-guangzhououtput[json]:# set/get/list 子命令指定账户名 test$ tccli configure set region ap-guangzhou output json –profile test$ tccli configure get secretKey –profile test$ tccli configure list –profile test# remove 子命令删除指定账户的配置文件。当 remove 子命令不指定账户名时，会删除 default 配置文件。$ tccli configure remove –profile test# 在调用接口时指定账户（以 cvm DescribeZones 接口为例）$ tccli cvm DescribeZones –profile test

如果不希望输入命令时手动指定账户名，还可以设置环境变量，TCCLI 能从环境变量中读取指定的 profile。

export TCCLI_PROFILE=test

六、TCCLI 配置文件

·使用 tccli configure 命令后，TCCLI 会在 ~/.tccli 目录下生成对应的 default.configure 和 default.credential 文件，这两个文件记录均为 JSON 格式的内容。
default.configure 记录对应产品调用的版本（默认为产品的推荐版本）和 endpoint（默认为最近接入点），以及默认的输出格式和指定的地域。 default.credential 则记录的是用户的密钥信息。 示例如下：

# default.configure文件格式，cvm产品默认调用版本 2017-03-12 的接口，默认的请求域名为 cvm.tencentcloudapi.com{ … "cvm": { "endpoint": "cvm.tencentcloudapi.com", "version": "2017-03-12" }, … "output": "json", "region": "ap-guanzhou", …}# default.credential的文件格式{ "secretId": "**************", "secretKey": "**************"}

·若用户在使用配置命令时指定了账户名，则会生成账户名对应的配置文件。例如，用户使用了 tccli configure –profile test 命令，则会生成 test.configure 和 test.credential 文件。

·若需修改配置文件内容，你可以直接编辑文件或者使用 set 子命令修改。例如 tccli configure set cvm.version 2017-03-12，将调用的 cvm 的版本指定为默认 2017-03-12 版本。

七、配置环境变量

环境变量配置可参考以下方式：

·临时配置（当前终端会话中生效，关闭终端后失效）

Linux/macOS 系统Windows 系统# 设置云 API 密钥 SecretIdexport TENCENTCLOUD_SECRET_ID=你的SecretId# 设置云 API 密钥 SecretKeyexport TENCENTCLOUD_SECRET_KEY=你的SecretKey# 设置云产品地域export TENCENTCLOUD_REGION=ap-guangzhouset TENCENTCLOUD_SECRET_ID=你的SecretIdset TENCENTCLOUD_SECRET_KEY=你的SecretKeyset TENCENTCLOUD_REGION=ap-guangzhou

·永久配置（所有终端生效，重启终端或系统后仍有效）

Linux/macOS 系统Windows 系统

# 编辑环境变量文件echo 'export TENCENTCLOUD_SECRET_ID=你的SecretId' >> ~/.bashrcecho 'export TENCENTCLOUD_SECRET_KEY=你的SecretKey' >> ~/.bashrcecho 'export TENCENTCLOUD_REGION=ap-guangzhou' >> ~/.bashrc# 使配置立即生效source ~/.bashrc

1. 右键点击此电脑，选择属性。

2. 单击高级系统设置，选择环境变量。

3. 在系统变量区域中，单击 新建，依次添加以下两个变量：

·变量名：TENCENTCLOUD_SECRET_ID

变量值：你的 SecretId。

·变量名：TENCENTCLOUD_SECRET_KEY

变量值：你的 SecretKey。

·变量名：TENCENTCLOUD_REGION

变量值：你的请求地域。

4. 添加完成后，单击确定保存配置。

·验证配置是否成功

Linux/macOS 系统Windows 系统echo $TENCENTCLOUD_SECRET_ID echo $TENCENTCLOUD_SECRET_KEYecho $TENCENTCLOUD_REGIONecho %TENCENTCLOUD_SECRET_ID%echo %TENCENTCLOUD_SECRET_KEY%echo %TENCENTCLOUD_REGION%

注意：说明：

注意：如果你在命令、配置文件和环境变量都指定了相同的内容，TCCLI 执行的优先级为：命令 > 配置文件 > 环境变量。

八、其他配置

·TCCLI 支持通过 CAM 角色的方式进行认证，你可以参考 角色概述 查看相关信息。

# cam 角色的配置不支持交互模式，你可以使用非交互模式的方式进行配置：$ tccli configure set role-arn qcs::cam::uin/***********/**** role-session-name ****

role-arn 和 role-session-name 字段支持 configure 的 get 和 list 操作，可以写入配置文件、直接在命令行指定，操作方式与 secretId 和 secretKey 的配置类似。如下所示：

# get 子命令获取配置信息$ tccli configure get role-arnrole-arn = qcs::cam::uin/***********/****# list 子命令打印所有配置信息$ tccli configure listcredential:role-arn = qcs::cam::uin/***********/****role-session-name = ****# 将配置信息写入环境变量$ export TENCENTCLOUD_ROLE_ARN=qcs::cam::uin/***********/****$ export TENCENTCLOUD_ROLE_SESSION_NAME=****# 直接在命令行中指定 role-arn 和 role-session-name 信息，如调用 DescriZones 接口$ tccli cvm DescribeZones –role-arn qcs::cam::uin/***********/**** –role-session-name ****

如果你的实例绑定了角色，你可以直接通过实例角色的方式进行认证，无需 secretId 和 secretKey 等信息。你可以使用 –use-cvm-role 来使用实例角色的方式调用。

# 使用实例角色的方式调用 DescribeZones 的接口$ tccli cvm DescribeZones –use-cvm-role

注意：该方式仅支持在已绑定角色的实例上使用，具体方式请参见 管理实例角色。

相关内容：

  1. 腾讯云命令行工具 TCCLI 通用参数 TCCLI 提供了一组通用参数，这些参数可以在所有服务和接口调用中使用。本章节详细说明所有通用参数的用法。...
  2. 腾讯云命令行工具 凭证管理 腾讯云命令行工具（TCCLI）支持多种方式进行凭证管理，并按照以下优先级获取凭证：实例角色 > 角色 > TKE OIDC > 临时密钥 > 永久密钥。...
  3. 腾讯云命令行工具 TCCLI 使用方法 如何使用腾讯云命令行工具 TCCLI 的基础功能。TCCLI 集成了腾讯云所有支持云 API 的产品，可以以在命令行下完成对腾讯云产品的配置和管理。包括使用 TCCLI 创建云服务器、操作云服务器、通过 TCCLI 创建云硬盘、查看云硬盘使用情况、通过 TCCLI 创建私有网络、往私有网络中添加资源等，所有在控制台页面能完成的操作，均能在 TCCLI 上执行命令实现。例如。...
  4. 腾讯云命令行工具 安装 TCCLI 安装腾讯云命令行工具前，请确保你的系统已经安装了 Python 环境和 pip 工具。...
  5. 云 API 使用 TCCLI 欢迎使用腾讯云命令行工具 TCCLI，TCCLI 是管理腾讯云资源的统一工具。通过腾讯云命令行工具，可以以快速轻松的调用腾讯云 API 来管理你的腾讯云资源。你还可以基于腾讯云的命令行工具来做自动化和脚本处理，能够以更多样的方式进行组合和重用。...
  6. 腾讯云命令行工具 通过 SSO 方式登录 TCCLI 已与 集团身份管理 集成，支持通过 SSO 方式登录并在命令行中管理云资源。...
  7. 腾讯云命令行工具 多版本接口访问 TCCLI 默认访问产品最新版本的接口，而某些产品可能存在多个版本的接口，若你需访问特定旧版本的接口，可参考这篇进行实现。...
  8. 腾讯云命令行工具 结果返回过滤 这篇说说腾讯云命令行工具tccli的–filter参数，用于过滤命令返回结果，支持查看特定字段、数组元素、子对象字段及重命名输出。 查看特定字段：使用–filter TotalCount直接获取字段值。 数组元素过滤：使用–filter ZoneSet[0]获取指定索引的子对象。 重命名输出：使用–filter ‘ZoneSet[*].{name:ZoneName}‘同时过滤并重命名字段。...
赞 (0)
上一篇 4天前
下一篇 4天前