命令行工具概述

在线编辑

IBM® API ConnectAI Gateway 开发者工具箱 提供了用于云管理以及 API 开发和管理的命令。

命令语法

通常，命令遵循以下语法：
apic command:sub-command [argument] [options]
其中：
  • command 是您正在执行的命令（例如，product、app、API 和 Catalogs 等）。
  • sub-command 是要执行的操作。
  • argument 是适用的自变量（例如 catalog）。
  • options 是任意数量的命令行选项，格式为 --option [value]。 选项也具有包含单短划线（非双短划线）的简短格式。
例如，apic apps:publish --server mgmnthost.com。
对于某些命令，命令或子命令部分是可选的。 例如：
  • apic products:publish 等同于 apic publish。
  • apic products:list 等同于 apic products。
create 命令的语法稍有不同：
apic create:type [options]
使用 -h 或 --help 选项来查看命令帮助。
注: 显示 CLI 帮助文本和其他命令响应文本的语言由本地机器上的语言环境设置确定。

查看命令行工具帮助

通过输入以下命令显示常规命令行帮助信息：apic --help 或 apic -h。 通过输入以下命令来显示特定 apic 命令的帮助信息: apic command_name --help 或 apic command_name -h。

查看版本信息

通过输入以下命令显示命令行工具的版本：apic --version。

设置方式

该 API ConnectAI Gateway 工具包的命令行界面（CLI）可在提供方组织或消费方组织上运行命令。 在运行命令时，请使用不同的 mode 选项来标识要在其中运行命令的实例。 以下列表提供了可用方式的摘要：
apim
此方式适用于 CLI 的管理实例。 在此方式下运行命令时，使用整体 API Manager 作为其作用域。 此方式为缺省方式。
在 apim 方式下运行命令的示例：
apic extensions:list-all --mode apim --scope catalog --server server1 --catalog catalog1 --org myOrg --configured-gateway-service service1
portaladmin
此方式适用于 CLI 的 Developer Portal 实例。 此方式支持可用于复制所有或部分 Developer Portal 环境的命令。
在 portaladmin 方式下运行命令的示例：
apic --mode portaladmin custom-theme:create-export --catalog catalog1 --org myOrg --server server1 --format json
consumer
此方式适用于 CLI 的使用者实例。 此命令使用您有权访问的使用者组织作为其作用域。 必须指定此方式或将其设置为命令的缺省值以使用它。
在 consumer 方式下运行命令的示例：
apic catalogs:list --mode consumer --scope catalog --server server1 --catalog catalog1 --org myOrg
为避免必须在每个使用者 CLI 命令上提供参数，您可以设置 mode 配置变量，如下一节中所述。

使用配置变量

您可以在配置变量中设置常用属性的值。 总之，可以更简单、更一致地设置配置变量，而无需使用命令行选项指定这些变量。
注：

OpenAPI 项目的配置变量始终是全局的。 全局配置变量的值存储在 user-home-dir/.apiconnect/config 文件中，其中 user-home-dir 是用户的主目录。

使用以下命令来处理配置变量：

  • apic config:get varname - 获取配置变量。 使用 apic config 显示所有本地配置变量的值，或使用 apic config -g 显示所有全局配置变量的值。
  • apic config:set varname - 设置或更新指定的配置变量。
  • apic config:delete varname - 删除指定的配置变量。
  • apic config:clear - 删除所有配置变量。

您可以使用 apic config:set 命令来设置配置属性值。 通过设置配置属性 (例如 catalog 和 app) ，您无需在输入命令时提供这些选项的值。

此外，还可以使用apic properties 命令来处理配置属性：
  • apic properties:clear－清除配置属性。
  • apic properties:create－使用其他名称/值对扩充配置属性。
  • apic properties:delete－删除配置属性。
  • apic properties:get－获取配置属性。
  • apic properties:list－列示配置属性。
  • apic properties:update－更新配置属性。
注：

如果您具有与 CLI 配置属性同名的环境变量，那么缺省情况下，其值将覆盖该作用域中任何 CLI 命令的对应 CLI 配置属性的值。

例如，如果您已定义名为 SPACE 的环境变量，那么缺省情况下，无论任何 space 配置属性设置如何，都将假设该值为以下命令中 --space 参数的值：
apic products:publish my_product.yaml --scope space

要防止环境变量覆盖 CLI 配置属性，请定义名为 APIC_LOAD_FROM_ENV 的环境变量，将值设置为 false。

下表描述了配置变量：

表 1. 配置变量
变量名称 描述 使用替代（或覆盖）这些标志...
目录 所有用于管理目录相关设置的命令的默认目录名称。
“目录”的值可以指定为以下任一形式：
  • 包含服务器名称和组织名称的完整目录 URI： mgmt-server/api/catalogs/org-name/catalog-name. 在这种情况下，您在进行 CLI 调用 --server 时无需指定 --catalog、 --organization 或 ，因为它们的值已包含在完整的目录 URI 中。
  • 目录名称，例如： sandbox。 在这种情况下，您在调用 CLI 时 --server 仍需指定 --organization 和。
注: 目录名称 apic-dev 保留用于本地测试。
  • 如果目录 URI 用于变量赋值： --catalog, --organization, --server
  • 如果目录名称用于变量赋值： --catalog
云端应用程序服务器 云管理命令的缺省管理服务器主机名。 格式：mgmt-server/api/。 --server
消费者 API 使用者的缺省 URI。 格式：mgmt-server/api/consumer-orgs/org-name/catalog-name/consumer-org-name，其中：mgmt-server 是管理服务器，org-name 是组织名称，catalog-name 是目录名称，而 consumer-org-name 是使用者组织名称。 -–server, -–organization, -–catalog, -–consumer
模式 CLI 命令的 --mode 参数的缺省值。 根据您是要在提供者组织还是使用者组织上运行命令，将值设置为 apim 或 consumer。 如果未设置此变量，并且未在命令上提供 --mode 参数，那么将采用值 apim。 --mode
组织 (org) 所有管理组织的命令的默认组织名称。

格式：mgmt-server/api/orgs/org-name，其中，mgmt-server 是管理服务器，org-name 是组织名称。

org 值可以指定为以下任一形式：
  • 包含服务器名称的完整组织 URI： mgmt-server/api/orgs/org-name. 在这种情况下，您在进行 CLI 调用 --organization 时无需指定 --server 或 ，因为它们的值已包含在完整的组织 URI 中。
  • 例如，组织名称： providerorg1. 在这种情况下，您在调用 --server CLI 时仍需指定。
  • 如果组织 URI 用于变量赋值： --organization, --server
  • 如果组织名称用于变量赋值： --organization
空间 用于管理 空间各个方面的所有命令的缺省 空间 URI。

格式: mgmt-server/api/spaces/org-name/catalog-name/space-name，其中 mgmt-server 是管理服务器， org-name 是组织名称， catalog-name 是目录名称， space-name 是 Space 名称。

如果端口号不是缺省值 443，那么可以将其附加到服务器名称。

 --server, --organization, --catalog, --space
要设置配置属性，请输入以下命令：
apic config:set name=value
其中 name 是配置属性的名称，value 是要为其指定的值。

例如：

apic config:set catalog=sandbox

脚本编制命令

在 shell 脚本中自动化一系列 apic 命令，通常会很有帮助。 由于 apic 工具首先需要您以交互方式接受许可证，因此，必须首先使用以下命令：
apic --accept-license
一旦您执行此操作，脚本即可以非交互方式运行。
要禁用对使用情况分析的收集，请输入以下命令：
apic --live-help

设置语言

您可以使用 "--lang标志配置 CLI 命令输出的语言。 该标记允许开发者工具包以指定语言提供命令输出。 下表列出了支持的语言：

表 2. 支持的语言
语言价值 语言
zh-cn 英语（美国）
cs 捷克语
de 德语
es 西班牙语
fr 法语
它 意大利语
ja 日语
ko 韩语
nl 荷兰语
pl 波兰语
pt-br 葡萄牙语（巴西）
ru 俄语
tr 土耳其语
zh-cn 中文（简体）
zh-tw 中文（繁体）
根据您的需求使用语言值。 以法语为例。 要将语言设置为法语，请运行以下命令：
apic --lang fr
运行命令后，输出结果将以法语显示。 例如：
apic config get invalid
Error: invalid n'est pas une variable de configuration valide
如果您提供的无效值不属于支持的语言，系统会显示以下错误：
apic --lang invalid
Error: Value invalid is not valid for lang. Valid values are: en-us, cs, de, es, fr, it, ja, ko, nl, pl, pt-br, ru, tr, zh-cn, zh-tw