IBM Cloud Docs
一般 IBM Cloud CLI (ibmcloud)命令

一般 IBM Cloud CLI (ibmcloud)命令

IBM Cloud® 命令行界面提供了一组按命名空间分组的命令，供用户与 IBM Cloud 交互。

IBM Cloud CLI 支持以下命令，包括命令名称、参数、选项、前提条件、说明和示例。

全球先决条件

每条命令的先决条件都说明了运行命令前需要进行哪些操作。 前提条件可包括以下一项或多项操作：

端点
使用 ibmcloud api 命令 设置 API 端点。
登录
使用 ibmcloud login 命令 登录。 如果使用联合 ID 登录，请使用 --sso 选项通过一次性密码进行身份验证。 或者，使用 --apikey 选项通过 API 密钥进行认证。
目标
使用 ibmcloud target 命令 设置或查看目标账户或区域。

全局选项

IBM Cloud CLI 中的大多数命令都有以下选项。 要检查特定命令是否有可用选项，请在使用该命令时使用 -h, --help 选项。

--output FORMAT

指定输出格式。 仅支持 JSON。

示例

以 JSON 格式打印可用的资源组：

ibmcloud resource groups --output json

-q, --quiet

禁用详细消息。 如果指定了 -q, --quiet ，则不会显示 Getting information from... as ... 等提示信息。

示例

在静音模式下打印可用资源组：

ibmcloud resource groups -q

ibmcloud help

显示 IBM Cloud CLI 第一级内置命令和受支持名称空间的一般帮助，或者显示特定内置命令或名称空间的帮助。

ibmcloud help [COMMAND|NAMESPACE]

先决条件

无。

命令选项

COMMAND|NAMESPACE
显示其帮助信息的命令或名称空间。 如果未指定，将显示 IBM Cloud CLI 的一般帮助。 可选。

示例

显示 IBM Cloud CLI 的一般帮助：

ibmcloud help

显示 dev 命令的帮助：

ibmcloud help dev

云辅助

别名： ai

向使用 watsonx 的人工智能助理提问。 有关功能和限制的更多信息，请参阅 获取人工智能助手的帮助。

ibmcloud assist "MY_QUERY"

人工智能助手生成的内容可能包含错误或不正确的内容。

先决条件

  • 使用 ibmcloud login 命令登录。 如果使用联合 ID 登录，请使用 --sso 选项使用一次性密码进行身份验证，或使用 --apikey 选项使用 API 密钥进行身份验证。

命令选项

无。

示例

ibmcloud assist "How do I update the CLI?"

如果您在查询中使用了引号或感叹号，请确保使用 \ 转义每个字符。 更多信息，请参阅 IBM Cloud CLI 中使用字符串引号。

云版本

别名： v

打印 IBM Cloud CLI 的版本。

ibmcloud version

先决条件

无。

命令选项

无。

示例

打印 IBM Cloud CLI 的版本：

ibmcloud version

ibmcloud api

设置或查看 IBM Cloud API 端点。

ibmcloud api [API_ENDPOINT] [--unset] [--skip-ssl-validation] [--vpc]

先决条件

无。

命令选项

API_ENDPOINT
作为目标的 API 端点，例如 https://cloud.ibm.com。 如果未指定 API_ENDPOINT 和 --unset 选项，将显示当前 API 端点。 可选。
--skip-ssl-validation
绕过 HTTP 请求的 SSL 验证。 不建议使用此选项。
--vpc
为专用 API 端点使用 VPC 连接。 有关为私有 API 端点配置使用 VPC 连接的更多信息，请参阅 配置私有端点网关（VPC 使用要求）。
--unset
除去 API 端点设置。

示例

将 API 端点设置为 cloud.ibm.com：

ibmcloud api cloud.ibm.com

将 API 端点设置为 cloud.ibm.com 并绕过 SSL 验证。

ibmcloud api https://cloud.ibm.com --skip-ssl-validation

查看当前 API 端点：

ibmcloud api

除去 API 端点：

ibmcloud api --unset

ibmcloud config

将缺省值写入配置文件。

ibmcloud config --http-timeout TIMEOUT_IN_SECONDS | --trace (true|false|path/to/file) |
         --color (true|false) | --locale (LOCALE|CLEAR) | --check-version (true|false)

先决条件

无。

命令选项

--check-version
启用或禁用 CLI 版本检查。 有效值为 true 或 false。
--color
启用或禁用颜色输出。 缺省情况下，此选项处于禁用状态。 有效值为 true 或 false。
--http-timeout
HTTP 请求的超时值（以秒为单位）。 缺省值为 60 秒。
--locale
设置缺省语言环境。 如果未指定值，将删除先前的语言环境。
--sso-otp
设置单点登录（SSO）一次性密码（OTP）检索的样式。 默认值为 manual，需要用户交互操作。 auto 设置将自动启动默认浏览器并接受令牌。
--alpha-commands
按字母顺序排列未分类的命令
--trace
跟踪对终端或指定文件的 HTTP 请求。 有效值为 true 或 false。

一次只能指定其中一个选项。

示例

将 HTTP 请求超时设置为 30 秒：

ibmcloud config --http-timeout 30

启用 HTTP 请求的跟踪输出：

ibmcloud config --trace true

跟踪对 /home/usera/my_trace 文件的 HTTP 请求：

ibmcloud config --trace /home/usera/my_trace

禁用颜色输出：

ibmcloud config --color false

将语言环境设置为 zh_Hans：

ibmcloud config --locale zh_Hans

清除语言环境设置：

ibmcloud config --locale CLEAR

启用自动接受 SSO 一次性密码：

ibmcloud config --sso-otp auto

启用按字母顺序排列未分类命令的功能

ibmcloud config --alpha-commands true

ibmcloud login

登录到 IBM Cloud CLI：

ibmcloud login [-a API_ENDPOINT] [--sso] [-u USERNAME] [-p PASSWORD] [--apikey KEY | @KEY_FILE] [--cr-token (TOKEN | @CR_TOKEN_FILE) | --vpc-cri] [--profile PROFILE_ID | PROFILE_NAME | PROFILE_CRN] [-c (ACCOUNT_ID | ACCOUNT_OWNER_USER_ID) | --no-account] [--accept] [-g (RESOURCE_GROUP_NAME | RESOURCE_GROUP_ID)] [-r REGION | --no-region] [--vpc]

先决条件

无。

命令选项

-a API_ENDPOINT
API 端点。 例如，cloud.ibm.com。 或者使用 private.cloud.ibm.com，通过专用端点登录。 使用此标记可将 API 端点保存到配置文件中。
--sso
将此选项指定为使用联合标识登录。 使用此选项会提示您对单点登录提供程序进行认证，并输入一次性通行码以登录。
-U username
用户名。 可选。
-p password
用户密码。 可选。
--apikey API_KEY 或 @API_KEY_FILE_PATH
API 密钥内容或用 @ 符号指示的 API 密钥文件的路径。
--cr-token TOKEN 或 @CR_TOKEN_FILE_PATH
计算资源标记的内容或 @ 符号指示的计算资源标记文件的路径。 如果提供，还必须提供或设置 --profile 标志或 IBMCLOUD_CR_PROFILE 环境变量。
--vpc-cri
以 VPC VSI 计算资源身份登录。 有关详细信息，请参阅 以虚拟服务器实例计算资源身份登录。
--profile PROFILE_ID、PROFILE_NAME 或 PROFILE_CRN
获取 IAM 访问令牌时，会使用链接的受信任 IAM 配置文件的名称、ID 或 CRN。 如果提供，还必须提供或设置 --cr-token 标志、IBMCLOUD_CR_TOKEN 环境变量或 --vpc-cri 标志。 如果以 VPC VSI 计算资源身份进行验证，则只支持指定受信任配置文件 CRN 或 ID。
-c ACCOUNT_ID
目标帐户的标识。 该选项与 --no-account 选项是排他性的。
--no-account
强制在没有帐户的情况下登录。 建议不要使用此选项，此选项与 -c 选项互斥。
--accept
接受邀请加入目标帐户。 提供的账户必须是有效的账户 ID。
-g RESOURCE_GROUP
目标资源组的名称或标识。 可选。
-r REGION
目标区域的名称。 例如，us-south 或 eu-gb。
--no-region
强制在不设置目标区域的情况下登录。
--skip-ssl-validation
绕过 HTTP 请求的 SSL 验证。 不建议使用此选项。
--vpc
为专用 API 端点使用 VPC 连接。 有关使用私有 API 端点的 VPC 连接登录的更多信息，请参阅 使用私有端点登录 CLI。 有关配置 VPC 连接以使用专用 API 端点的信息，请参阅 配置专用端点网关（使用 VPC 时需要）。

示例

以交互方式登录：

ibmcloud login

登录私人端点：

ibmcloud login -a private.cloud.ibm.com

支持两个区域：us-south 和 us-east。

使用 VPC 登录专用端点：

ibmcloud login -a private.cloud.ibm.com --vpc

使用用户名和密码登录，并设置目标账户：

ibmcloud login -u username -p password -c MyAccountID

使用联合 ID 登录，并设置目标账户：

ibmcloud login --sso -c MyAccountID

使用具有关联帐户的 API 密钥：

ibmcloud login --apikey api-key-string

ibmcloud login --apikey @filename

使用没有关联帐户的 API 密钥：

ibmcloud login --apikey api-key-string -c MyAccountID

ibmcloud login --apikey @fileName -c MyAccountID

如果 API 密钥具有关联的帐户，那么不支持切换到其他帐户。

以特定用户身份使用联合标识登录：

ibmcloud login --sso

然后，CLI 会提供一个 URL 链接并要求输入密码：

Get One Time Code from https://identity-1.us-south.iam.cloud.ibm.com/identity/passcode to proceed.
Open the URL in the default browser? [Y/n] >

在浏览器中打开链接，以获取密码。 在控制台中输入密码进行登录。

除了使用 CLI 提供的 URL 链接外，还可以启动 IBM Cloud 控制台并登录。 在 IBM Cloud 控制台中，到 Avatar图标 Avatar 图标 > 登录 CLI 和 API。 复制 IBM Cloud CLI 密码命令并输入。 如果您使用 Google 帐户登录 IBMid，或使用 IBM Cloud App ID 实例连接云帐户，请使用此方法登录。

以链接到受信任配置文件的 IBM Kubernetes Service 计算资源的身份登录：

ibmcloud login --cr-token token-string --profile trusted_profile_name_id_or_crn

ibmcloud login --cr-token @filename --profile trusted_profile_name_id_or_crn

IBMCLOUD_CR_TOKEN=@filename ibmcloud login --profile trusted_profile_name_id_or_crn

IBMCLOUD_CR_TOKEN=@filename IBMCLOUD_CR_PROFILE=trusted_profile_name_id_or_crn ibmcloud login

有关以 IBM Kubernetes Service 计算资源身份登录的更多信息，请参阅 使用计算资源令牌登录。

使用实例配置过程中链接的默认受信任配置文件，以 VPC VSI 计算资源身份登录：

ibmcloud login --vpc-cri

以链接到指定受信任配置文件的 VPC VSI 计算资源的身份登录：

ibmcloud login --vpc-cri --profile trusted_profile_id_or_crn

IBMCLOUD_CR_PROFILE=trusted_profile_id_or_crn ibmcloud login --vpc-cri

有关以 VPC VSI 计算资源身份登录的更多信息，请参阅 以虚拟服务器实例计算资源身份登录。

接受邀请加入新账户：

ibmcloud login -c TargetedAccountID --accept

ibmcloud logout

从 CLI 注销：

ibmcloud logout

先决条件

无。

ibmcloud regions

查看 IBM Cloud 上所有区域的信息：

ibmcloud regions

先决条件

使用 ibmcloud api 命令来设置 API 端点。

ibmcloud target

设置或查看目标账户或区域：

ibmcloud target [-r REGION_NAME | --unset-region] [-c ACCOUNT_ID] [-g RESOURCE_GROUP | --unset-resource-group]

先决条件

  • 使用 ibmcloud api 命令来设置 API 端点。
  • 使用 ibmcloud login 命令登录。 如果使用联合 ID 登录，请使用 --sso 选项使用一次性密码进行身份验证，或使用 --apikey 选项使用 API 密钥进行身份验证。

命令选项

-c ACCOUNT_ID
目标帐户的标识。 可选。
-r REGION
目标区域的名称，例如，us-south 或 eu-gb。 可选。
-g RESOURCE_GROUP
目标资源组的名称。 可选。
--unset-region
清除目标区域。
--unset-resource-group
清除目标资源组。

如果未指定任何选项，则显示当前账户和地区。

示例

设置当前账户：

ibmcloud target -c MyAccountID

切换到新区域：

ibmcloud target -r eu-gb

查看当前账户和地区：

ibmcloud target

ibmcloud update

将 CLI 更新到最新版本：

ibmcloud update [-f]

先决条件

无。

命令选项

-f
强制更新而不确认。 需要 root 用户特权。

常规经典基础架构服务命令

使用 IBM Cloud CLI 中的经典基础架构命令可配置和管理基础架构服务。

运行 ibmcloud sl 命令可查看可用命令的列表：

USAGE:
   ibmcloud sl command [arguments...] [options...]

COMMANDS:
   block           Classic infrastructure Block Storage
   call-api        Call arbitrary API endpoints
   file            Classic infrastructure File Storage
   dns             Classic infrastructure Domain Name System
   globalip        Classic infrastructure Global IP addresses
   hardware        Classic infrastructure hardware servers
   image           Classic infrastructure Compute images
   ipsec           Classic infrastructure IPSEC VPN
   order           Classic infrastructure Orders
   placement-group Classic infrastructure Placement Group
   security        Classic infrastructure SSH Keys and SSL Certificates
   securitygroup   Classic infrastructure network security groups
   subnet          Classic infrastructure Network subnets
   ticket          Classic infrastructure Manage Tickets
   user            Classic infrastructure Manage Users
   vlan            Classic infrastructure Network VLANs
   vs              Classic infrastructure Virtual Servers
   help            Print command usage message

要查看有关命令的帮助信息，请运行以下命令：

ibmcloud sl [command] -h

有关每条命令的详细信息，请参阅本文档中的相关参考主题。

从 CLI Vibmcloud sl init 开始，0.14 命令不再可用。 要安装最新的 CLI 版本，请参阅安装独立 IBM Cloud CLI。

ibmcloud sl help

查看所有命令的帮助信息以操作经典基础架构环境：

ibmcloud sl help