此页面由 Cloud Translation API 翻译。

Box

借助 Box 连接器，您可以连接到 Box 后端并使用 SQL 检索和更新 Box 数据。

支持的版本

此连接器支持 Box Content API 版本 2.0。

准备工作

在使用 Box 连接器之前，请先完成以下任务：

在您的 Google Cloud 项目中：
- 将 roles/connectors.admin IAM 角色授予配置连接器的用户。
- 将以下 IAM 角色授予您要用其来使用连接器的服务账号：
  - roles/secretmanager.viewer
  - roles/secretmanager.secretAccessor
  服务账号是一种特殊类型的 Google 账号，用于表示需要验证身份并获得授权以访问 Google API 数据的非人类用户。如果您没有服务账号，则必须创建一个服务账号。如需了解详情，请参阅创建服务账号。
- 启用以下服务：
  - secretmanager.googleapis.com (Secret Manager API)
  - connectors.googleapis.com (Connectors API)
  如需了解如何启用服务，请参阅启用服务。
如果之前没有为您的项目启用这些服务或权限，则在您配置连接器时，系统会提示您启用。

配置连接器

配置连接器时，您需要创建与数据源（即后端系统）的连接。一个连接需专用于一个数据源。这意味着，如果您有许多数据源，则必须为每个数据源创建单独的连接。如需创建连接，请执行以下步骤：

在 Cloud 控制台中，进入 Integration Connectors > 连接页面，然后选择或创建一个 Google Cloud 项目。
转到“连接”页面
点击 + 新建以打开创建连接页面。
在位置部分中，选择连接的位置。
1. 区域：从下拉列表中选择一个位置。
  如需查看所有受支持区域的列表，请参阅位置。
2. 点击下一步。
在连接详情部分中，完成以下操作：
1. 连接器：从可用连接器的下拉列表中选择 Box。
2. 连接器版本：从可用版本的下拉列表中选择一个连接器版本。
3. 在连接名称字段中，输入连接实例的名称。
  连接名称必须符合以下条件：
  - 连接名称可以使用字母、数字或连字符。
  - 字母必须小写。
  - 连接名称必须以字母开头，以字母或数字结尾。
  - 连接名称不能超过 63 个字符。
4. （可选）输入连接实例的说明。
5. 服务账号：选择具有所需角色的服务账号。
6. （可选）配置连接节点设置：
  - 节点数下限：输入连接节点数下限。
  - 节点数上限：输入连接节点数上限。
  节点是处理事务的连接单元（或副本）。连接处理越多事务就需要越多节点，相反，处理越少事务需要越少节点。如需了解节点如何影响连接器价格，请参阅连接节点的价格。如果未输入任何值，则默认情况下，节点数下限设置为 2（以便提高可用性），节点数上限设置为 50。
7. 模拟用户模式：指定用户模拟的类型。类型应该是用户模式还是管理员模式。
8. 使用代理：选中此复选框可为连接配置代理服务器并配置以下值：
9. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
10. 点击下一步。
在 Authentication（身份验证）部分，输入身份验证详细信息。
1. 选择身份验证类型，然后输入相关详细信息。
  Box 连接支持以下身份验证类型：
  - OAuth 2.0 - 客户端凭据
  - OAuth 2.0 - 授权代码
2. 点击下一步。
查看：查看您的连接和身份验证详细信息。
点击创建。

配置身份验证

根据您要使用的身份验证输入详细信息。

OAuth 2.0 - 客户端凭据
- 客户端 ID：连接器为您创建的应用提供的客户端 ID。
- 客户端密钥：包含您创建的关联应用的客户端密钥的 Secret Manager 密文。
- 私钥：包含私钥文件内容的 Secret Manager 密文。私钥应与提供给连接器的公钥/证书匹配。
- 私钥密码：包含私钥文件的密码（短语）的 Secret Manager 密文。
- Box 应用访问权限级别：Box 应用的应用访问权限级别
- 企业 ID/用户 ID：如果应用级别为企业，则为企业 ID；如果应用级别为用户，则为用户 ID
- OAuth JWT 公钥 ID：JWT 的公钥 ID。
- 身份验证方案：Box 连接器的身份验证方案
- 启动 OAuth：Box 连接器的启动 OAuth 参数
- OAuth JWT 证书类型：Box 连接器的 OAuth JWT 证书类型
OAuth 2.0 - 授权代码

客户端 ID：由外部应用提供的客户端 ID。
范围：权限范围。例如 root_readonly。如需了解范围的工作原理，以及查看 Box 的所有可用范围，请参阅范围。
客户端密钥：选择 Secret Manager 密钥。您应该先创建 Secret Manager 密钥，然后再配置此授权。
密钥版本：客户端密钥的 Secret Manager 密钥版本。

对于 Authorization code 身份验证类型，在创建连接后，您应额外执行一些步骤来配置身份验证。如需了解详情，请参阅创建连接后的其他步骤。

注意：如果您使用的是 Authorization code 身份验证类型，并在 Box 应用中进行了任何配置更改，则必须重新授权 Box 连接。如需了解如何重新授权，请参阅重新授权授权代码。

创建连接后的其他步骤

如果您选择 OAuth 2.0 - Authorization code 进行身份验证，则必须在创建连接后执行以下额外的步骤：

在“连接”页面中，找到新创建的连接。
请注意，新连接器的状态将显示为需要授权。
点击需要授权。
系统随即会显示修改授权窗格。
将重定向 URI 值复制到您的外部应用。
验证授权详细信息。
点击 Authorize（授权）。
如果授权成功，“连接”页面中的连接状态将设置为活跃。

重新授权授权代码

如果您使用的是 Authorization code 身份验证类型，并在 Box 应用中进行了任何配置更改，则必须重新授权 Box 连接。如需重新授权连接，请执行以下步骤：

在“连接”页面中点击所需的连接。
系统随即会打开连接详情页面。
点击 Edit 以修改连接详情。
在 Authentication（身份验证）部分中验证 OAuth 2.0 - Authorization code 详细信息。
根据需要进行必要的更改。
点击保存。系统随即会将您转到连接详情页面。
点击 Authentication 部分中的修改授权。系统将显示授权窗格。
点击 Authorize（授权）。
如果授权成功，“连接”页面中的连接状态将设置为有效。

实体、操作和动作

所有集成连接器都会为所连接应用的对象提供抽象层。您只能通过此抽象访问应用的对象。抽象作为实体、操作和动作向您展示。

实体：实体可以被视为连接的应用或服务中的对象或属性集合。不同连接器的实体定义也会有所不同。例如，在数据库连接器中，表是实体；在文件服务器连接器中，文件夹是实体；在消息传递系统连接器中，队列是实体。
不过，可能连接器不支持或不支持任何实体，在这种情况下，Entities 列表将为空。
操作：操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作：
- List（列出）
- 获取
- 创作
- 更新
- 删除
从可用列表中选择一个实体，系统会生成该实体可用的操作列表。如需了解操作的详细说明，请参阅连接器任务的实体操作。但是，如果连接器不支持任何实体操作，则此类不受支持的操作不会列在 Operations 列表中。
动作：动作是可通过连接器接口提供给集成的头等函数。动作可让您对一个或多个实体进行更改，并且动作因连接器而异。但可能的情况是，连接器不支持任何动作，在这种情况下，Actions 列表将为空。

操作

本部分列出了 Box 连接支持的所有操作。

“DownloadFile”操作

此操作可让您从 Box 实例下载文件。

DownloadFile 操作的输入参数

参数名称	数据类型	需要	说明
FileID	字符串	是	要下载的文件的 ID。
HasBytes	布尔值	是	指定以字符串还是 Base64 编码字符串下载文件。

DownloadFile 操作的输出参数

此操作将返回状态 200 (OK)，以及指示结果的响应正文。

参数名称	数据类型	说明
成功	字符串	指定文件下载是否成功。
ContentBytes	字符串	以 Base64 编码字符串表示的文件内容。

如需查看有关如何配置 DownloadFile 操作的示例，请参阅操作示例。

UploadFile 操作

此操作可让您将文件上传到 Box 实例。

UploadFile 操作的输入参数

参数名称	数据类型	需要	说明
ParentID	字符串	是	您要在其中上传文件的文件夹的 ID。如果您未指定此参数，文件将上传到 Box 账号的根目录。默认值为 0。
内容	字符串	是	要上传的文件内容。

UploadFile 操作的输出参数

此操作将返回状态 200 (OK)，以及指示结果的响应正文。

参数名称	数据类型	说明
成功	字符串	指定文件上传是否成功。
ID	字符串	新创建的文件的 ID。
VersionID	字符串	文件特定版本的 ID。
哈希	字符串	文件的 `SHA1` 哈希值。
ETag	字符串	文件或文件夹的 Etag 值。默认值为 0。

如需查看有关如何配置 UploadFile 操作的示例，请参阅操作示例。

CopyFile 操作

此操作可让您从 Box 实例中复制文件。

CopyFile 操作的输入参数

参数名称	数据类型	需要	说明
FileID	字符串	是	要复制的文件的 ID。
DestinationFolderId	字符串	否	要将文件复制到的目标文件夹的 ID。如果未指定任何值，系统会复制文件的最新版本。
NewName	字符串	是	已复制文件的新文件名。

CopyFile 操作的输出参数

此操作将返回状态 200 (OK)，以及指示结果的响应正文。

参数名称	数据类型	说明
成功	字符串	指定文件复制是否成功。
ID	字符串	已复制文件的 ID。

如需查看有关如何配置 CopyFile 操作的示例，请参阅操作示例。

“CopyFolder”操作

此操作可让您从 Box 实例中复制整个文件夹。

CopyFolder 操作的输入参数

参数名称	数据类型	需要	说明
FolderID	字符串	是	要复制的文件夹的 ID。
DestinationFolderId	字符串	是	要将文件夹复制到的目标文件夹的 ID。
NewName	字符串	否	已复制的文件夹的新文件名。

CopyFolder 操作的输出参数

此操作将返回状态 200 (OK)，以及指示结果的响应正文。

参数名称	数据类型	说明
成功	字符串	指定文件夹复制是否成功。
ID	字符串	已复制文件夹的 ID。

如需查看有关如何配置 CopyFolder 操作的示例，请参阅操作示例。

操作示例

本部分介绍如何执行该连接器中的一些操作。

示例 - 下载文件

在 Configure connector task 对话框中，点击 Actions。
选择 DownloadFile 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
```
{
"FileID": "1283194869422", 
"HasBytes": true
}
```

本示例会下载一个 Base64 编码字符串形式的文件。如果操作成功，连接器任务的 connectorOutputPayload 响应参数的值将如下所示：

[
{ "Success": "True"},
{"ContentBytes": "JVBERi0xLjQKJcfl9OXwCjIgMCBvYmoKJSBbMjRdIAo8PAovRmlsdGVy"}
]

注意：如果您要下载非二进制文件，请将 HasBytes 值设置为 false。

示例 - 上传文件

在 Configure connector task 对话框中，点击 Actions。
选择 UploadFile 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
```
{
"ParentId": "0",
"Content": "12345"
}
```

本示例将字符串内容作为文件上传。如果操作成功，连接器任务的 connectorOutputPayload 响应参数的值将如下所示：

[{
"Success": "true",
"ID": "1283902965389",
"VersionID": "1403546001389",
"Hash": "8cb2237d0679ca88db6464eac60da96345513964",
"Etag": "0"
}]

示例 - 复制文件

在 Configure connector task 对话框中，点击 Actions。
选择 CopyFile 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
```
{
"FileID": "1288751886061",
"DestinationFolderId": "219105724517", 
"NewName": "NewCopiedFile"
}
```

以下示例会将 ID 为 1288751886061 的文件复制到 ID 为 219105724517 的文件夹。如果操作成功，连接器任务的 connectorOutputPayload 响应参数的值将如下所示：

[{
"Success": "true",
"ID": "1308006018536"
}]

示例 - 复制文件夹

在 Configure connector task 对话框中，点击 Actions。
选择 CopyFolder 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：
```
{
"FolderID": "218475301279",
"DestinationFolderId": "0", 
"NewName": "NewCopiedFolder"
}
```

以下示例会将 ID 为 218475301279 的文件夹复制到 ID 为 219105724517 的文件夹。如果操作成功，连接器任务的 connectorOutputPayload 响应参数的值将如下所示：

[{
"Success": "true",
"ID": "226312444517"
}]

实体操作示例

示例 - 列出所有文件

以下示例列出了 Files 实体中的文件。

在 Configure connector task 对话框中，点击 Entities。
从 Entity 列表中选择 Files。
选择 LIST 操作，然后点击完成。
（可选）您可以在 filterClause 中输入值，以过滤结果集。

示例 - 获取门票

此示例从 Tickets 实体获取特定工单。

在 Configure connector task 对话框中，点击 Entities。
从 Entity 列表中选择 Tickets。
选择 GET 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 EntityId，然后在默认值字段中输入 35。
其中，35 是 Tickets 实体的主键值。

示例 - 创建工单

此示例在 Tickets 实体中创建一个工单。

在 Configure connector task 对话框中，点击 Entities。
从 Entity 列表中选择 Tickets。
选择 Create 操作，然后点击完成。

在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

{
"Subject": "Create_Ticket_01",
"Description": "Test",
"Type": "incident",
"Priority": "urgent",
"Status": "open",
"Recipient": null,
"HasIncidents": false,
"DueAt": null,
"RequesterId": 3.84625885158E11,
"SubmitterId": 3.84625883418E11,
"AssigneeId": 3.84625883418E11,
"OrganizationId": "16665992392721",
"GroupId": 3.60008282358E11,
"TicketFormId": 3.60001719218E11,
"BrandId": 3.60003285058E11
}

如果集成成功，连接器任务的 connectorOutputPayload 字段的值将如下所示：

{
"Id": 38.0
}

示例 - 更新工单

此示例将更新 Tickets 实体中的指定票券。

在 Configure connector task 对话框中，点击 Entities。
从 Entity 列表中选择“票券”。
选择 Update 操作，然后点击完成。

在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

{
        "Subject": "Update_Ticket_02",
        "Description": "Updating the ticket",
        "RequesterId": 1.6854335860497E13
      }

点击 entityId，然后在 Default Value 字段中输入 35。
或者，您也可以不指定 entityId，而是将 filterClause 设置为 35。

如果集成成功，连接器任务的 connectorOutputPayload 字段的值将如下所示：
```
{
Id": 35.0
}
      
```

示例 - 删除工单

此示例从 Tickets 实体中删除指定的票券。

在 Configure connector task 对话框中，点击 Entities。
从 Entity 列表中选择“票券”。
选择 Delete 操作，然后点击完成。
在连接器任务的任务输入部分中，点击 entityId，然后在默认值字段中输入 35。

注意：Delete 操作仅软删除记录。如果需要，您可以稍后恢复已删除的记录。

使用 Terraform 创建连接

您可以使用 Terraform 资源创建新连接。

如需了解如何应用或移除 Terraform 配置，请参阅基本 Terraform 命令。

如需查看用于创建连接的示例 Terraform 模板，请参阅示例模板。

使用 Terraform 创建此连接时，您必须在 Terraform 配置文件中设置以下变量：

参数名称	数据类型	需要	说明
impersonate_user_mode	ENUM	True	指定用户模拟的类型。应选择“用户”模式还是“管理员”模式。支持的值包括：User、Admin
proxy_enabled	BOOLEAN	False	选中此复选框可配置用于连接的代理服务器。
proxy_auth_scheme	ENUM	False	用于向 ProxyServer 代理进行身份验证的身份验证类型。支持的值包括：BASIC、DIGEST、NONE
proxy_user	STRING	False	用于向 ProxyServer 代理进行身份验证的用户名。
proxy_password	SECRET	False	用于对 ProxyServer 代理进行身份验证的密码。
proxy_ssltype	ENUM	False	连接到 ProxyServer 代理时使用的 SSL 类型。支持的值包括：AUTO、ALWAYS、NEVER、TUNNEL

在集成中使用 Box 连接

创建连接后，它在 Apigee Integration 和 Application Integration 中均可使用。您可以通过连接器任务在集成中使用该连接。

如需了解如何在 Apigee Integration 中创建和使用连接器任务，请参阅连接器任务。
如需了解如何在 Application Integration 中创建和使用连接器任务，请参阅连接器任务。

向 Google Cloud 社区寻求帮助

您可以在 Cloud 论坛的 Google Cloud 社区发布您的问题并讨论此连接器。

后续步骤

了解如何暂停和恢复连接。
了解如何监控连接器的使用情况。
了解如何查看连接器日志。