Edge Microgate 的 CLI 参考文档

您正在查看 Apigee Edge 文档。
前往 Apigee X 文档。 信息

Edge Microgateway v. 2.5.x

概览

借助 Edge Microgateway CLI，您可以控制和管理 Edge Microgateway 实例的各个方面。

管理证书

借助 cert 命令，您可以安装和管理用于对客户端使用的不记名令牌进行签名的公钥/私钥对，以便通过 Edge Microgateway 进行安全调用。密钥以加密的键值映射 (KVM) 形式存储在 Apigee Edge 上。Edge Microgateway 使用公钥来验证已签名的不记名令牌。这些密钥是在您运行 edgemicro configure 命令时生成的，如设置和配置 Edge Microgateway 中所述。您可以根据需要使用此处所述的 cert 命令重新生成和管理这些密钥。

安装证书

在加密的键值对映射 (KVM) 中安装密钥，并以输出形式返回公钥。密钥对的范围限定为指定组织。

用法

edgemicro cert install -o [organization] -e [environment] -u [username] -p [password] --force

参数

参数 说明
-o, --org 您为之配置 Edge Microgateway 的 Apigee 组织。
-e, --env 您已为其配置 Edge Microgateway 的环境。
-u, --username 您的 Apigee 用户名。您必须是指定组织的组织管理员。
-p, --password （可选）您的密码。如果您未在命令行中提供此参数，系统会提示您输入。
-f, --force （可选）如果加密的 KVM 中已存储密钥，则强制替换该密钥。
-h, --help 输出使用情况信息。

示例

edgemicro cert install -o docs -e test -u jdoe@example.com -f

输出

current nodejs version is v6.9.1
current edgemicro version is 2.5.4
password:
deleting vault
creating vault
adding private_key
adding public_key
installed cert

删除证书

删除组织的密钥对。

用法

edgemicro cert delete -o [organization] -e [environment] -u [username] -p [password]

参数

参数 说明
-o, --org 您为之配置 Edge Microgateway 的 Apigee 组织。
-e, --env 您已为其配置 Edge Microgateway 的环境。
-u, --username 您的 Apigee 用户名。您必须是指定组织的组织管理员。
-p, --password （可选）您的密码。如果您未在命令行中提供此参数，系统会提示您输入。
-h, --help 输出使用情况信息。

示例

edgemicro cert delete -o docs -e test -u jdoe@example.com

输出

deleting vault
Vault deleted!

检查证书

检查您的组织是否已安装证书。

用法

edgemicro cert check -o [organization] -e [environment] -u [username] -p [password]

参数

参数 说明
-o, --org 您为之配置 Edge Microgateway 的 Apigee 组织。
-e, --env 您已为其配置 Edge Microgateway 的环境。
-u, --username 您的 Apigee 用户名。您必须是指定组织的组织管理员。
-p, --password （可选）您的密码。如果您未在命令行中提供此参数，系统会提示您输入。
-h, --help 输出使用情况信息。

示例

edgemicro cert check -o docs -e test -u jdoe@example.com

输出 （成功）

checked cert successfully

输出 （失败）

如果证书不存在，则会返回错误。

获取公钥

返回指定组织的公钥。无需进行身份验证。

用法

edgemicro cert public-key -o [organization] -e [environment]

参数

参数 说明
-o, --org 您为之配置 Edge Microgateway 的 Apigee 组织。
-e, --env 您已为其配置 Edge Microgateway 的环境。
-h, --help 输出使用情况信息。

示例

edgemicro cert public-key -o docs -e test

输出 （示例）

-----BEGIN CERTIFICATE-----

MIICpDCCAYwCCQCKpXWGum9uTjANBgkq9w0BAQsFADAUMRIwEAYDVQQDEwls
b2NhbGhvc3cNMTYxMTAyMjAxNTA2WhcNMTYxMTAzMjAxNTA2WjAUMRIwEAYD
VQQDEwlsb2Nvc3QwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDD
ETr/ne/gP47+9LgjLvBJjpbFVdaeUabZZ3wbA7sSIVnnNXWt3yPklrWSfIh+
L2+dq4k+YunsQE2+dwPdXA2x8DPGvqGcCdWPxnpZ7ix5Akbs8i/J+Ue0pXT4
jkpWbaDDftGL2tcxwP45yI+slpDYvmWRps07TFXkAPjGEHYPvCT9/v/35GkL
0h4v0S+XfpcjS5c47o7CIWlkgEM5GBosQUb17kuVR48392vGFPsnCP34iNe7
zguhiCXYg2zkOcj/N3AE4xKIhCz0QcewULy08GltWMmyjJ/30zs8P41JqoA4
RwfeEZ8RenN3rJQim1ppAAEwDQYJKoZIhvcNAQELBQADggEBAHcORIfc+ySe
2FMmqicNe6Wt5V/5zOaBMLsGQdqGOHB5cQc79sMBrk680KVhrwHXZ2nBIkVe
UEL+2qLY1VLfswBNAvcNwV9U4TwHq4eIANiD751oJK1tHmM/ujThQkwNf96o
6I7Ws+wfpGO3ppJCttRbtnATIxrwsCHN4i5lbW/tJSL7t/Zf6T1B+YSJU9AF
xuvLq22cCqyYJQdmKq2vVS55WRZdllm+mRtJrv7MLM9gfDPRxVlwrBz/eQHy
Fv+dwzxcvQjkz03RNhZUodzuD34DPJoYeK++rItsddwQ26KTahH80yYTAFzY
x9gfPf1/+qo=?

-----END CERTIFICATE-----

为 Apigee Edge Cloud 配置 Edge Microgateway

使 Edge Microgateway 能够与 Apigee Edge Cloud 实例搭配使用。它会封装并执行一系列命令，以将所需的身份验证代理部署到 Edge，生成身份验证令牌，并更新配置文件。如需查看完整的有效示例，请参阅设置和配置 Edge Microgateway。

用法

edgemicro configure -o [organization] -e [environment] -u [username] -p [password]

参数

参数 说明
-o, --org 您为之配置 Edge Microgateway 的 Apigee 组织。
-e, --env 您已为其配置 Edge Microgateway 的环境。
-u, --username 您的 Apigee 用户名。您必须是指定组织的组织管理员。
-p, --password （可选）您的密码。如果您未在命令行中提供此参数，系统会提示您输入。
-r, --url （可选）指定组织：环境的虚拟主机别名。请参阅 Edge 文档，了解虚拟主机。默认值： org-env.apigee.net
-c, --configDir （可选）指定 Edge Microgateway 配置文件的路径。默认情况下，配置文件位于 ./config/config.yaml 中。（已添加 v2.4.x）
-x, --proxyName （可选）为 edgemicro-auth 代理设置基本路径。如果 edgemicro-auth 代理部署在非默认路径 /edgemicro-auth 下，此功能可让您在 Edge Microgateway 中设置新路径。默认情况下，基本路径为 /edgemicro-auth。（已添加 v2.4.x）
-t, --token （可选）允许您使用 OAuth 令牌进行身份验证，而不是使用用户名/密码。 另请参阅使用 OAuth2 访问令牌保护 API 调用。 例如：

edgemicro configure -o docs -e test -t <your token>
-v, --virtualHosts （可选）替换默认虚拟主机，即“default,secure”。如果您为 Edge 组织环境指定的虚拟主机除外，请使用此选项。请参阅 Edge 文档，了解虚拟主机。
-d, --debug （可选）提供调试信息。
-h, --help 输出使用情况信息。

使用说明

此命令会将配置信息存储在 ~/.edgemicro/org-env-config.yaml 中。

示例

edgemicro configure -o docs -e test -u jdoe@example.com

输出

成功后，该命令会返回一组密钥，您需要在启动 Edge Microgateway 时使用这些密钥。

...

The following credentials are required to start edge micro
  key: d2f0a246ad52b5d2a8b04ba65b43c76348aba586691cf6185cd7bb9fb78fe9f
  secret: 59813bc1db4a7ada182705ae40893c28a6fae680c3deb42aefbf1a4db42e372

edgemicro configuration complete!

生成键

genkeys 命令会生成一个密钥和密钥令牌对，Edge Microgateway 在异步向 Apigee Edge 发布分析数据时会使用该密钥和密钥令牌对进行身份验证。

用法

edgemicro genkeys -o [organization] -e [environment] -u [username] -p [password]

参数

参数 说明
-o, --org 您为之配置 Edge Microgateway 的 Apigee 组织。
-e, --env 您已为其配置 Edge Microgateway 的环境。
-u, --username 您的 Apigee 用户名。您必须是指定组织的组织管理员。
-p, --password （可选）您的密码。如果您未在命令行中提供此参数，系统会提示您输入。
-h, --help 输出使用情况信息。

使用说明

成功后，该命令会返回三项内容。第一个是您需要放置在配置文件中的网址。另外两个是启动 Edge Microgateway 实例时所需的密钥对。

  • 引导网址：此网址指向一个 Apigee Edge 服务，该服务可让 Edge Microgateway 实例将分析数据发送到 Apigee Edge。您需要将该网址复制到 Edge Microgateway 配置文件中：~/.edgemicro/org-env-config.yaml。
  • key：密钥。此密钥和相应密文是启动 Edge Microgateway 实例所用 CLI 命令的必需输入。
  • secret：密钥。

示例

edgemicro genkeys -o docs -e test -u jdoe@example.com

输出 （示例）

成功后，该命令会返回一组密钥，您需要在启动 Edge Microgateway 时使用这些密钥。

configuring host edgemicroservices-us-east-1.apigee.net for region us-east-1
Please copy the following property to the edge micro agent config
  bootstrap: https://edgemicroservices-us-east-1.apigee.net/edgemicro/bootstrap/organization/jdoe/environment/test

The following credentials are required to start edge micro
  key: db39324077989c75eac34c13d285772ea8e3b982b957b3f52916f3048511443f
  secret: 5bf8da39de0056f88fdd5f25a8602d22f312c1c8c870580a5fef55ac6637b7ae

finished

为 Apigee Edge Private Cloud 配置 Edge Microgateway

配置 Edge Microgateway 以与 Apigee Edge Private Cloud 安装搭配使用。

用法

edgemicro private configure -o [organization] -e [environment] -u [username] -p [password]

参数

参数 说明
-o, --org 您为之配置 Edge Microgateway 的 Apigee 组织。
-e, --env 您已为其配置 Edge Microgateway 的环境。
-u, --username 您的 Apigee 用户名。您必须是指定组织的组织管理员。
-p, --password （可选）您的密码。如果您未在命令行中提供此参数，系统会提示您输入。
-r, --runtime-url 指定私有云实例的运行时网址。
-m, --mgmt-url 私有云实例的管理服务器的网址。
-v, --virtualHosts 组织：环境的虚拟主机逗号分隔列表。默认值为“default,secure”。
-c, --configDir （可选）指定 Edge Microgateway 配置文件的路径。默认情况下，配置文件位于 ./config/config.yaml 中。（已添加 v2.4.x）
-t, --token （可选）允许您使用 OAuth 令牌进行身份验证，而不是使用用户名/密码。 另请参阅使用 OAuth2 访问令牌保护 API 调用。 例如：

edgemicro configure -o docs -e test -t <your token>
-d, --debug （可选）提供调试信息。
-h, --help 输出使用情况信息。

使用说明

此命令会将配置信息存储在 ~/.edgemicro/org-env-config.yaml 中。

示例

edgemicro private configure -o docs -e test -u jdoe@example.com -r http://192.162.55.100:9002 -m http://192.162.55.100:8080

输出

成功后，该命令会返回一组密钥，您需要在启动 Edge Microgateway 时使用这些密钥。

...

The following credentials are required to start edge micro
  key: d2f0a246ad52b5d2a8b04ba65b43c76348aba586691cf6185cd7bb9fb78fe9f
  secret: 59813bc1db4a7ada182705ae40893c28a6fae680c3deb42aefbf1a4db42e372

edgemicro configuration complete!

启动 Edge Microgateway

在启动 Edge Microgateway 之前，您必须先运行 edgemicro configure（公共云）或 edgemicro private configure（私有云）。configure 命令会返回启动 Edge Microgateway 所需的密钥和 Secret 值。

用法

edgemicro start -o [organization] -e [environment] -k [public-key] -s [secret-key]

参数

参数 说明
-o, --org 您为之配置 Edge Microgateway 的 Apigee 组织。
-e, --env 您已为其配置 Edge Microgateway 的环境。
-k, --key 运行“edgemicro configure”命令时返回的键值。
-s, --secret 运行“edgemicro configure”命令时返回的 Secret 值。
-p, --processes （可选）要启动的进程数。默认值：系统中的核心数。
-d, --pluginDir （可选）插件目录的绝对路径。
-r, --port （可选）替换 ~/.edgemicro/org-env-config.yaml 文件中指定的端口号。默认值：8000
-c, --cluster

（可选）以集群模式启动 Edge Microgateway。

注意： 自 v2.3.1 起，此选项已被移除。在 v2.3.1 及更高版本中，Edge Micro 始终以集群模式启动。
-c, --configDir （可选）指定 Edge Microgateway 配置文件的路径。默认情况下，配置文件位于 ./config/config.yaml 中。（已添加 v2.4.x）
-u, --configUrl （可选）指定 Edge Microgateway 将从中下载其配置文件的端点。（已添加 v2.5.x）
-d, --debug （可选）提供调试信息。
-h, --help 输出使用情况信息。

设置端口

您可以使用 start 命令指定端口号，以替换配置文件中指定的端口。您还可以使用 PORT 环境变量指定端口号。例如：

edgemicro start -o docs -e test -k abc123 -s xyz456 -p 2 --port 8002

或

export PORT=8002
edgemicro start -o org -e test -k key -s secret -p 2

如果该端口正在使用，Edge Microgateway 会返回错误。

聚类简介

Edge Microgateway 采用 Node.js 集群模块来实现集群。通过集群，Edge Microgateway 可以充分利用多核系统。如需了解详情，请参阅此 Node.js 文档。

示例

edgemicro start -o docs -e test -k abc123 -s xyz456

示例输出：

...

current nodejs version is v6.9.1
current edgemicro version is 2.5.4
info: jwk_public_keys download from null returned 200 undefined
info: jwt_public_key download from https://docs-test.apigee.net/edgemicro-auth/publicKey returned 200 OK
info: products download from https://docs-test.apigee.net/edgemicro-auth/products returned 200 OK
info: config download from https://edgemicroservices-us-east-1.apigee.net/edgemicro/bootstrap/organization/docs/environment/test returned 200 OK
PROCESS PID : 17991

管理令牌

借助 token 命令，您可以获取、解码和验证已签名的 OAuth2 访问令牌。另请参阅 使用 OAuth2 访问令牌保护 API 调用。

解码令牌

将已签名、已编码的不记名令牌解码为纯文本 JSON JWT（Java Web 令牌）表示形式。令牌会传递有关提供用于创建令牌的密钥的 Apigee Edge 开发者应用的信息，包括应用名称、client_id、产品列表等。

用法

edgemicro token decode -f [filename]

参数

参数 说明
-f, --file 包含要解码的 JWT 令牌的文件的名称。
-h, --help 输出使用情况信息。

示例

edgemicro token decode -f token.jwt

输出（示例）

{ header: { typ: 'JWT', alg: 'RS256' },

  payload:
   { application_name: 'b43342ef-86f6-4666-a121-b9ac2025d217',
     client_id: 'O9ZQRZKnn1rdgcKQgsABSMdOsKS',
     scopes: [],
     api_product_list: [ 'MicroTest' ],
     iat: 1436280566,
     exp: 1436282365 },
  signature: '' }

生成令牌

生成已签名的不记名令牌。该令牌允许客户端应用向 Edge Microgateway 发出经过身份验证的 API 调用。该令牌是符合 OAuth 2.0 标准的 JSON Web 令牌 (JWT)。它需要将 Apigee Edge 上注册的开发者应用的使用方密钥（客户端 ID）和使用方密文（客户端密钥）值作为输入。另请参阅 使用 OAuth2 访问令牌保护 API 调用。

用法

edgemicro token get -o [org] -e [env] -i [client_id] -s [client_secret]

参数

参数 说明
-o, --org 您为之配置 Edge Microgateway 的 Apigee 组织。
-e, --env 您已为其配置 Edge Microgateway 的环境。
-1, --key 与支持微网关的代理关联的开发者应用的客户端 ID。
-s, --secret 与支持微网关的代理关联的开发者应用的客户端密钥。
-h, --help 输出使用情况信息。

示例

edgemicro token get -o docs -e test -i 5UzOwAXGoOeo60aew94PPG5MAZE3aJp -s 6vahKFGS9a3qMLwz

输出（示例）

{ token: 'eyJ0eXAiOiJKV1JhbGciOiJSUzI1NiJ9Glvbl9uYW1lIjoiNWNiMGY0NTV6TV3
EtOWMzOC00YmJjLWIzNzEtZGMxZTQzOGMxIiwiY2xpZW50X2lkIjoiNVV6T3dBWEdvSU9lbz
YwYWV3OTRQN0c1TUFaRTNhSnAiLCJzY2MiOltdLCJhcGlfcHJvZHVjdF9saXN0IjpbIkVkZ2
VNaWNyb1Rlc3RQcm9kdWN0Il0sImlhdCI3ODEyMzQ2MSwiZXhwIjoxNDc4MTI1MjYwfQ.Dx5
f5U7PXm8koNGmFX4N6VrxKMJnpndKgoJ5zWSJvBZ6Ccvhlpd85ipIIA5S2A5nx4obYWp_rpY
RJpIGYwyxP6Oq2j0rxnVjdCC4qyYMgthZjhKgEBVBe3s1ndP72GP2vV6PsSA9RQ2-yzsy9r0
TzhAZ3NJTxT1tS0XKqKngE-OhR3fJHVLAzdMDT0AmS9H0Z2NAJtQOuK6RTpCjG9B6Bc48AEM
sj7QSM-1LWiQ8LdY8k_BoC06qsTI7bCQGWwTuqL-ismbcx2bxovUxSemZIaoROfuF-dCZHG3
2aTP75WxBvvNgBBvPvQtPzbeSOtEaww' }

发出 HTTP 请求以获取令牌

您还可以发出原始 HTTP 请求来获取令牌。请参阅直接获取不记名令牌。

验证令牌

根据存储在 Apigee Edge 上的公钥，针对指定组织和环境验证已签名的不记名令牌。

用法

edgemicro token verify -o [org] -e [env] -f [filename]

参数

参数 说明
-o, --org 您为之配置 Edge Microgateway 的 Apigee 组织。
-e, --env 您已为其配置 Edge Microgateway 的环境。
-f, --file 包含要验证的 JWT 的文件的名称。
-h, --help 输出使用情况信息。

示例

edgemicro token get -o docs -e test -f token.jwt

有效令牌的输出示例

{ application_name: 'b43342ef-86f6-4666-a121-b9ac2025d217',

  client_id: 'O9ZQRZKnn1rdgcKQsAZUBkQSMdOsKS',

  scopes: [],

  api_product_list: [ 'MicroTest' ],

  iat: 1436396155,

  exp: 1436397954 }

无效令牌的输出示例

{ [JsonWebTokenError: invalid token] name: 'JsonWebTokenError', message: 'invalid token' }

令牌过期时的输出示例

{ [TokenExpiredError: jwt expired]

  name: 'TokenExpiredError',

  message: 'jwt expired',

  expiredAt: Tue Jul 07 2015 09:19:25 GMT-0600 (MDT) }

初始化新的 Edge Microgateway 配置

首次安装 Edge Microgateway 后，运行此命令一次。创建新的默认配置文件：~/.edgemicro/default.yaml。

用法

edgemicro init

参数

参数 说明
-c, --configDir （可选）指定 Edge Microgateway 配置文件的路径。默认情况下，配置文件位于 ./config/config.yaml 中。（已添加 v2.4.x）
-h, --help 输出使用情况信息。

示例

edgemicro init

输出 （成功）

config initialized to /MyHome/.edgemicro/default.yaml

验证 Edge Microgateway 配置

验证 Edge Microgateway 是否已正确配置。

用法

edgemicro verify -o [organization] -e [environment] -k [public-key] -s [secret-key]

参数

示例

edgemicro verify -o docs -e test -k abc123 -s xyz456

输出 （成功）

logging to /var/tmp/edgemicro-My-Machine.local-a0c48610-a148-11e6-8466-93f081b05988
installed plugin from analytics
installed plugin from oauth
a0c48610-a148-11e6-8466-93f081b05988 edge micro listening on port 8000
verifying analytics negative case: OK
verifying bootstrap url availability:OK
verifying jwt_public_key availability: OK
verifying products availability: OK
verifying quota with configured products: OK
verifying analytics with payload: OK
verification complete

检查微网关集群状态

默认情况下，Edge Microgateway 以集群模式启动。您可以使用此命令检查集群的状态。

用法

edgemicro status

参数

参数 说明
-h, --help 输出使用情况信息。

示例

edgemicro status

输出 （成功）

current nodejs version is v6.9.1
current edgemicro version is 2.5.4
edgemicro is running with 8 workers

停止微网关集群

停止 Edge Microgateway 集群。

用法

edgemicro stop

参数

参数 说明
-h, --help 输出使用情况信息。

示例

edgemicro stop

输出 （成功）

current nodejs version is v6.9.1
current edgemicro version is 2.5.4
Stop Completed Successfully

重新加载微网关集群

在配置更改后提供零停机时间重启。通过拉取新配置来重新加载 Edge Microgateway。

用法

edgemicro reload -o [organization] -e [environment] -k [public-key] -s [secret-key]

参数

参数 说明
-o, --org 您为之配置 Edge Microgateway 的 Apigee 组织。
-e, --env 您已为其配置 Edge Microgateway 的环境。
-k, --key 运行“edgemicro configure”命令时返回的键值。
-s, --secret 运行“edgemicro configure”命令时返回的 Secret 值。
-h, --help 输出使用情况信息。

示例

edgemicro reload -o docs -e test -k abc123 -s xyz456

输出 （成功）

...

Reload Completed Successfully

升级 KVM

如需使用密钥轮替，您必须在 Apigee Edge 组织中安装升级版键值对映射。（已添加 v2.5.x）

注意：如果您在 2.5.2 版之前配置了当前的 Edge Micro 实例，则必须升级 KVM 才能使用密钥轮换。您只需升级一次。

用法

edgemicro upgradekvm -o [organization] -e [environment] -u [username]

参数

参数 说明
-o, --org 您为之配置 Edge Microgateway 的 Apigee 组织。
-e, --env 您已为其配置 Edge Microgateway 的环境。
-u, --username 您的 Apigee 用户名。您必须是指定组织的组织管理员。
-p, --password （可选）您的密码。如果您未在命令行中提供此参数，系统会提示您输入。
-v, --virtualhost （可选）代理的虚拟主机。
-t, --token （可选）允许您使用 OAuth 令牌进行身份验证，而不是使用用户名/密码。 另请参阅使用 OAuth2 访问令牌保护 API 调用。 例如：

edgemicro upgradekvm -o docs -e test -t <your token>
-b, --baseuri （可选）Apigee Edge 上组织的基准 URI。默认情况下，Apigee 云部署的基本 URI 为 api.enterprise.apigee.com。对于本地部署，基本网址可能有所不同。

示例

edgemicro upgradekvm -o docs -e test -u jdoe@example.com

输出 （成功）

成功后，该命令将返回类似于以下内容的输出：

current nodejs version is v6.9.1
current edgemicro version is 2.5.4
password:
Checking for certificate...
Certificate found!
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT6yVoT/h6pvkPlkUUtv
Hgs7MbDPcWxto7dZqJBwQ4oOQ0IJ2P4XGigc3kYUyPp5lFHg1ssP9+0onRpqn6Lq
z7N5iaTSv5YXb26bU2kSOl4hbwcljIzauAnBzQ13VaQ5SoflRxMGSZmTqZeu5jkQ
3JZ7F6k2bCar5sk1k84vd4WXcCVyngFlrMtlux5z0vOU56QYZFvvKYl/wOHNPLLB
Js54531CV1ZfhV3nDDq9Lh5D1C/oQVlm1Lc7BJoEUmKeFATmSsi50c14ScsmdtJ1
HqC/brSXCd185P6ifu2RH7IHKzNfcD4NlfAVmDScng4w5RxBan2avbmAJrokQ4b5
WQIDAQAB
-----END PUBLIC KEY-----
KVM update complete

升级 edgemicro-auth 代理

如需使用密钥轮替，您必须在 Apigee Edge 组织中部署升级后的 edgemicro-auth 代理。（已添加 v2.5.x）

注意：如果您在 2.5.2 版之前配置了当前的 Edge Micro 实例，则必须升级此代理才能使用密钥轮换。您只需升级一次。

用法

edgemicro upgradeauth -o [organization] -e [environment] -u [username]

参数

参数 说明
-o, --org 您为之配置 Edge Microgateway 的 Apigee 组织。
-e, --env 您已为其配置 Edge Microgateway 的环境。
-u, --username 您的 Apigee 用户名。您必须是指定组织的组织管理员。
-p, --password （可选）您的密码。如果您未在命令行中提供此参数，系统会提示您输入。
-v, --virtualhost （可选）代理的虚拟主机。
-b, --baseuri （可选）Apigee Edge 上组织的基准 URI。默认情况下，Apigee 云部署的基本 URI 为 api.enterprise.apigee.com。对于本地部署，基本网址可能有所不同。

示例

edgemicro upgradeauth -o docs -e test -u jdoe@example.com

输出 （成功）

成功后，该命令将返回类似于以下内容的输出：

Going to create revision 2 of API edgemicro-auth
Using /Users/jdoe/npm/lib/node_modules/edgemicro/node_modules/microgateway-edgeauth/apiproxy/edgemicro-auth.xml as the root file
Creating revision 2 of API edgemicro-auth
Uploading java resource micro-gateway-products-javacallout-2.0.0.jar
Uploading jsc resource generate-verify-jwt.js
Uploading jsc resource send-public-key.js
Uploading jsc resource set-jwt-variables.js
Uploading jsc resource set-response.js
Uploading node resource index.js
Uploading node resource node_modules_apigee-access.zip
Uploading node resource node_modules_base64url.zip
Uploading node resource node_modules_buffer-equal-constant-time.zip
Uploading node resource node_modules_ecdsa-sig-formatter.zip
Uploading node resource node_modules_jsrsasign.zip
Uploading node resource node_modules_jwa.zip
Uploading node resource node_modules_jws.zip
Uploading node resource node_modules_safe-buffer.zip
Uploading node resource package.json
Uploading policy Access-App-Info-2.xml
Uploading policy Access-App-Info.xml
Uploading policy AccessTokenRequest.xml
Uploading policy Add-Custom-Claims.xml
Uploading policy Create-OAuth-Request.xml
Uploading policy Create-Refresh-Request.xml
Uploading policy Extract-API-Key.xml
Uploading policy Extract-OAuth-Params.xml
Uploading policy Extract-Refresh-Params.xml
Uploading policy Get-Private-Key.xml
Uploading policy Get-Public-Key.xml
Uploading policy Get-Public-Keys.xml
Uploading policy JavaCallout.xml
Uploading policy Products-to-JSON-2.xml
Uploading policy Products-to-JSON.xml
Uploading policy Raise-Fault-Unknown-Request.xml
Uploading policy RefreshAccessToken.xml
Uploading policy Send-Public-Key.xml
Uploading policy Set-JWT-Variables.xml
Uploading policy Set-Response.xml
Uploading policy Verify-API-Key.xml
Uploading target TargetEndpoint-1
Uploading proxy default
Deploying revision 2 of edgemicro-auth to test
Deployment on test successful
edgemicro-auth proxy upgraded

轮替密钥

使用 edgemicro rotatekey 命令轮换用于生成 JWT 令牌的公钥/私钥对，这些令牌用于 Edge Microgateway 上的 OAuth 安全。

如需了解详情，请参阅 轮替 JWT 密钥。

用法

edgemicro rotatekey -o [organization] -e [environment] -u [username] -k [kid]

参数

参数 说明
-o, --org （必需）您为之配置 Edge Microgateway 的 Apigee 组织。
-e, --env （必需）您已为之配置 Edge Microgateway 的环境。
-u、--username （必需）您的 Apigee 用户名。您必须是指定组织的组织管理员。
-p, --password （可选）您的密码。如果您未在命令行中提供此参数，系统会提示您输入。
-k, --kid （必需）用于匹配特定密钥的 ID。Edge Microgateway 在密钥轮替期间使用此值从一组密钥中进行选择。如需了解详情，请参阅 JSON Web 密钥规范的第 4.5 节。
-b, --baseuri （可选）Apigee Edge 上组织的基准 URI。默认情况下，Apigee 云部署的基本 URI 为 api.enterprise.apigee.com。对于本地部署，基本网址可能有所不同。

示例

edgemicro rotatekey -o jdoe -e test -u jdoe@google.com -k 2

输出 （成功）

成功后，该命令将返回类似于以下内容的输出：

current nodejs version is v6.9.1
current edgemicro version is 2.5.7
password:
Checking if private key exists in the KVM...
Checking for certificate...
Found Certificate
Generating New key/cert pair...
Extract new public key
Key Rotation successfully completed!

轮替后，您可以在 Edge 界面中看到，微网关 KVM 中已添加新密钥。

永久监控

使用 edgemicro forever 命令管理 Forever 进程，这是一种 Node.js 工具，可在 Node.js 应用崩溃或出错时自动重启该应用。 另请参阅 永久监控。

用法

您必须先设置以下环境变量，然后才能执行 edgemicro forever 命令：

  • EDGEMICRO_ORG - 您为其配置了 Edge Microgateway 的 Apigee 组织。
  • EDGEMICRO_ENV - 您已为该环境配置 Edge Microgateway。
  • EDGEMICRO_KEY - 您运行“edgemicro configure”命令时返回的密钥值。
  • EDGEMICRO_SECRET - 运行“edgemicro configure”命令时返回的 Secret 值。
edgemicro forever -f [forever_file] -a [start|stop]

参数

参数说明
-f, --file指定 forever.json 文件的位置。
-a, --actionstart 或 stop。默认值为“start”。

示例：

如需开始使用 Forever，请执行以下操作：

edgemicro forever -f ~/mydir/forever.json -a start

如需停止 Forever，请执行以下操作：

edgemicro forever -a stop

撤消密钥

使用 edgemicro revokekeys 命令撤消 Edge Microgateway 配置的密钥和密文凭据。

用法

edgemicro revokekeys -o [organization] -e [environment] -u [username]
-k [key] -s [secret]

参数

参数 说明
-o, --org （必需）您为之配置 Edge Microgateway 的 Apigee 组织。
-e, --env （必需）您已为之配置 Edge Microgateway 的环境。
-u, --username （必需）您的 Apigee 用户名。您必须是指定组织的组织管理员。
-p, --password （可选）您的密码。如果您未在命令行中提供此参数，系统会提示您输入。
-k, --key （必需）要撤消的密钥。
-s, --secret （必需）要撤消的密钥。

示例

edgemicro revokekeys -o myorg -e test -u jdoe@apigee.com
-k 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f -s 4b5d6355b874f7c46838893823e8d929dcb2e42fb9aebcb535089c9b98513

成功后，您会看到以下消息：

key 2c0064f5bd85f5573dcaffe21566fa7a2d49885cdbf8899370c8a4479285f revoked successfully