npm 包 @heroku-cli/plugin-data-privatelink 使用教程

阅读时长 4 分钟读完

简介

在 Heroku 平台上,我们可以使用 @heroku-cli/plugin-data-privatelink 这个 npm 包来管理私有链接,这个包内含有 Heroku 平台的数据私有链接命令。

数据私有链接是一个用于安全地处理 SaaS 相关 API 的私有链接模式,这个模式通过 Heroku 平台,可以直接将已授权的 Heroku 应用程序通过私有链接连接到其他 SaaS 应用程序。而这个 npm 包提供了一套使用指导,方便了我们的开发过程。

安装

首先,在命令行输入以下命令,安装 @heroku-cli/plugin-data-privatelink npm 包:

注意,安装过程中需要保证已经登录 Heroku 平台,并且已经通过 Heroku CLI 来验证账户。如果没有,请先执行以下命令:

如何使用

@heroku-cli/plugin-data-privatelink 这个 npm 包提供了以下几个命令:

  • privatelink:config
  • privatelink:create
  • privatelink:delete
  • privatelink:info
  • privatelink:list
  • privatelink:update

我们接下来通过实例来介绍这些命令的使用方法:

私有链接配置

在使用 @heroku-cli/plugin-data-privatelink npm 包之前,我们需要先配置 Heroku 平台,用于私有链接授权。在命令行中进行以下操作:

其中,Your_API_Token 应该换成你的 API Token。API Token 的获取方法如下:

  • 进入你的 Heroku 账户控制台。
  • 在右上角,找到你的头像,点击打开 Heroku Dashboard。
  • 点击右上角的 "Account Settings" 按钮。
  • 在 Account Settings 的页面中,找到 "API Key",点击 "Reveal",此时你就可以看到你的 API Token 了。

注意,获取 API Token 需要已经登录 Heroku 平台。

创建私有链接

假设你已经完成了私有链接配置,下面就可以开始创建私有链接了。在命令行中输入以下命令:

其中,MyApp 应该是你需要使用私有链接的应用的名称。X.X.X.X/32 应该是你需要连接的私有 IP 地址。如果需要连接多个私有 IP 地址,我们可以在 --cidr 参数后添加多组参数。

列出私有链接

在使用私有链接的过程中,我们可以通过列出所有的私有链接,查看我们的应用程序到底连接了哪些资源。在命令行中输入以下命令:

其中,MyApp 是你需要查看私有链接的应用名称。

删除私有链接

如果我们需要取消某个应用程序的私有链接,我们需要执行以下命令:

其中 linkID 代表链接的 ID。我们可以通过 "list" 命令查看所有私有链接的 ID。

更新私有链接

如果我们需要更新一个私有链接的 CIDR 前缀(即更新连接的私有 IP 地址),我们需要执行以下命令:

其中,MyApp 是应用程序名称,X.X.X.X/32 是需要更新的 CIDR 地址,linkID 是需要更新的链接 ID。

查看私有链接信息

如果我们需要查看某个应用程序的私有链接的详细信息,可以执行以下命令:

其中,MyApp 是应用程序的名称,linkID 是你想要查看链接信息的 ID。

总结

通过本文,我们学习了如何安装和使用 @heroku-cli/plugin-data-privatelink 这个 npm 包。我们可以使用它来管理 Heroku 平台的私有链接,列表了几个重要的命令,包括:privatelink:config、privatelink:create、privatelink:delete、privatelink:info、privatelink:list 和 privatelink:update。当使用私有链接时,务必保证安全,避免遭受攻击。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/114926