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 项目。
- 点击 + 新建以打开创建连接页面。
- 在位置部分中,选择连接的位置。
- 区域:从下拉列表中选择一个位置。
如需查看所有受支持区域的列表,请参阅位置。
- 点击下一步。
- 区域:从下拉列表中选择一个位置。
- 在连接详情部分中,完成以下操作:
- 连接器:从可用连接器的下拉列表中选择 Box。
- 连接器版本:从可用版本的下拉列表中选择一个连接器版本。
- 在连接名称字段中,输入连接实例的名称。
连接名称必须符合以下条件:
- 连接名称可以使用字母、数字或连字符。
- 字母必须小写。
- 连接名称必须以字母开头,以字母或数字结尾。
- 连接名称不能超过 49 个字符。
- (可选)输入连接实例的说明。
- 您可以选择启用 Cloud Logging,然后选择日志级别。默认情况下,日志级别设置为
Error
。 - 服务账号:选择具有所需角色的服务账号。
- (可选)配置连接节点设置:
- 节点数下限:输入连接节点数下限。
- 节点数上限:输入连接节点数上限。
节点是处理事务的连接单元(或副本)。 连接处理越多事务就需要越多节点,相反,处理越少事务需要越少节点。 如需了解节点如何影响连接器价格,请参阅连接节点的价格。如果未输入任何值,则默认情况下,节点数下限设置为 2(以便提高可用性),节点数上限设置为 50。
- 模拟用户模式:指定用户模拟的类型。类型应该是用户模式还是管理员模式。
- 使用代理:选中此复选框可为连接配置代理服务器并配置以下值:
-
代理身份验证方案:选择要通过代理服务器进行身份验证的身份验证类型。支持以下身份验证类型:
- 基本:基本 HTTP 身份验证。
- 摘要:摘要 HTTP 身份验证。
- 代理用户:用于向代理服务器进行身份验证的用户名。
- 代理密码:用户密码的 Secret Manager 密文。
-
代理 SSL 类型:连接到代理服务器时使用的 SSL 类型。支持以下身份验证类型:
- 自动:默认设置。如果网址是 HTTPS 网址,则使用“隧道”选项。如果网址是 HTTP 网址,则使用“永不”选项。
- 始终:连接始终启用 SSL。
- 永不:连接未启用 SSL。
- 隧道:连接通过隧道代理建立。代理服务器会打开与远程主机的连接,并且流量会流经该代理。
- 在代理服务器部分中,输入代理服务器的详细信息。
- (可选)点击 + 添加标签,以键值对的形式向连接添加标签。
- 点击下一步。
-
在身份验证部分中,输入身份验证详细信息。
- 选择身份验证类型,然后输入相关详细信息。
Box 连接支持以下身份验证类型:
- JWT 身份验证
- OAuth 2.0 - 授权代码
- Box JSON
- OAuth 2.0 - 客户端凭据
- 点击下一步。
如需了解如何配置这些身份验证类型,请参阅配置身份验证。
- 选择身份验证类型,然后输入相关详细信息。
- 查看:查看您的连接和身份验证详细信息。
- 点击创建。
配置身份验证
根据您要使用的身份验证输入详细信息。
-
JWT 身份验证
- 客户端 ID:Box 为您创建的应用提供的客户端 ID。
- 客户端密钥:包含您创建的应用的客户端密钥的 Secret Manager 密文。
- 密钥版本:客户端密钥的版本。
- 私钥:包含私钥文件内容的 Secret Manager 密文。私钥应与提供给连接器的公钥/证书匹配。
- Secret 版本:私钥 Secret 的版本。
- 私钥密码:包含私钥文件的密码(短语)的 Secret Manager 密文。
- Secret 版本:私钥密码的版本。
- Box 应用访问权限级别:Box 应用的应用访问权限级别。
- 企业 ID/用户 ID:如果应用级别为企业,则为企业 ID;如果应用级别为用户,则为用户 ID
- OAuth JWT 公钥 ID:JWT 的公钥 ID。
- 身份验证方案:Box 连接器的身份验证方案。
- 启动 OAuth:为 Box 连接器启动 OAuth 参数。
- OAuth JWT 证书类型:Box 连接器的 OAuth JWT 证书类型。
- OAuth 2.0 - 授权代码
- 客户端 ID:Box 为您创建的应用提供的客户端 ID。
- 范围:权限范围。例如
root_readonly
。如需了解镜重范围的运作方式以及查看 Box 的所有可用镜重范围,请参阅镜重范围。 - 客户端密钥:选择 Secret Manager 密钥。您必须先创建 Secret Manager 密钥,然后才能配置此授权。
- 密钥版本:客户端密钥的 Secret Manager 密钥版本。
-
Box JSON
- 用于 JWT 身份验证的 Box JSON:包含 Box 提供的 JSON 文件内容的 Secret。
- 密钥版本:JSON 文件密钥的版本。
-
OAuth 2.0 - 客户端凭据
- OAuth 客户端 ID:Box 为您创建的应用提供的客户端 ID。
- 客户端密钥:包含您创建的应用的客户端密钥的 Secret Manager 密文。
- 密钥版本:客户端密钥的版本。
- 正文 ID:应用请求委托访问权限的用户正文。
- Box 应用访问权限级别:Box 应用的应用访问权限级别。
对于 Authorization code
身份验证类型,在创建连接后,您必须执行一些额外的步骤来配置身份验证。如需了解详情,请参阅创建连接后的其他步骤。
连接配置示例
本部分列出了您在创建关联时配置的各种字段的示例值。
OAuth JWT 令牌方法连接类型
字段名称 | 详细信息 |
---|---|
位置 | us-central1 |
连接器 | Box |
连接器版本 | 1 |
连接名称 | box-conn |
启用 Cloud Logging | 是 |
服务账号 | XXXX@serviceaccount |
模拟用户模式 | 用户 |
节点数下限 | 2 |
节点数上限 | 2 |
身份验证 | JWT 身份验证 |
客户端 ID | XXXX |
客户端密钥 | XXXX |
密钥版本 | 1 |
私钥 | XXXX |
密钥版本 | 1 |
私钥密码 | XXXX |
密钥版本 | 1 |
Box 应用访问权限级别 | 企业 |
企业 ID/用户 ID | XXXX |
OAuth JWT 公钥 ID | XXXX |
身份验证方案 | OAuthJWT |
启动 OAuth | GETANDREFRESH |
OAuth JWT 证书类型 | PEMKEY_BLOB |
您可以通过 Box 账号访问客户端 ID、客户端密钥、Box 应用访问权限级别和企业 ID/用户 ID。
您可以通过下载的 Private keypair.json
文件访问私钥和私钥密码。如需了解详情,请参阅公钥和私钥对信息。此外,在传递私钥密码之前,请将 json
文件中的 \n
替换为新行。
OAuth 授权代码连接类型
字段名称 | 详细信息 |
---|---|
位置 | us-central1 |
连接器 | Box |
连接器版本 | 1 |
连接名称 | box-conn |
启用 Cloud Logging | 是 |
服务账号 | XXXX@serviceaccount |
模拟用户模式 | 用户 |
授权 | OAuth 2.0 - 授权代码 |
节点数下限 | 2 |
节点数上限 | 2 |
客户端 ID | XXXX |
范围 | root_readwrite |
客户端密钥 | XXXX |
密钥版本 | 1 |
如需了解 Box OAuth 配置,请参阅创建 OAuth 应用。
适用于 JWT 身份验证方法连接类型的 BoxJson
字段名称 | 详细信息 |
---|---|
位置 | us-central1 |
连接器 | Box |
连接器版本 | 1 |
连接名称 | gcp-box-conn-new |
启用 Cloud Logging | 是 |
服务账号 | XXXX@serviceaccount |
模拟用户模式 | 用户 |
作为用户 ID | XXXX |
节点数下限 | 2 |
节点数上限 | 2 |
身份验证 | Box JSON |
适用于 JWT 身份验证的 Box JSON | XXXX |
密钥版本 | 1 |
您可以使用 Box 账号为 JWT 身份验证设置 BoxJson。如需了解如何为 JWT 设置 BoxJson,请参阅 JWT 令牌创建步骤
从您下载的 Private keypair.json
文件中访问 JWT 身份验证的 BoxJson 值。如需了解详情,请参阅公钥和私钥对信息。您必须在 Box Json for JWT Auth 字段中传递 .json
文件的完整内容。
OAuth 客户端凭据连接类型
字段名称 | 详细信息 |
---|---|
位置 | us-central1 |
连接器 | Box |
连接器版本 | 1 |
连接名称 | oauth-clientcred-conn |
启用 Cloud Logging | 是 |
服务账号 | XXXX@serviceaccount |
模拟用户模式 | 用户 |
作为用户 ID | XXXX |
节点数下限 | 2 |
节点数上限 | 2 |
身份验证 | OAuth 客户端凭据 |
OAuth 客户端 ID | XXXX |
OAuth 客户端密钥 | XXXX |
密钥版本 | 1 |
主题 ID | XXXX |
Box 应用访问权限级别 | 企业版 |
您可以通过 Box 账号访问客户端 ID、客户端密钥、Box 应用访问权限级别和企业 ID/用户 ID。
重新授权授权代码
如果您使用的是 Authorization code
身份验证类型,并且在 Box 应用中进行了任何配置更改,则必须重新授权 Box 连接。如需重新授权关联,请执行以下步骤:
- 在“连接”页面中,点击所需的连接。
系统随即会打开连接详情页面。
- 点击修改以修改关联详情。
- 在身份验证部分中,验证 OAuth 2.0 - 授权代码详细信息。
根据需要进行必要的更改。
- 点击保存。您随即会进入连接详情页面。
- 点击身份验证部分中的修改授权。系统随即会显示 Authorize(授权)窗格。
- 点击授权。
如果授权成功,“连接”页面中的连接状态将设为有效。
创建连接后的其他步骤
如果您选择了 OAuth 2.0 - Authorization code
作为身份验证方式,则必须在创建连接后执行以下额外步骤:
- 在“连接”页面中,找到新创建的连接。
请注意,新连接器的状态将为需要授权。
- 点击需要授权。
系统随即会显示修改授权窗格。
- 将重定向 URI 值复制到您的外部应用。
- 验证授权详细信息。
- 点击授权。
如果授权成功,“连接”页面中的连接状态将设为有效。
实体、操作和动作
所有集成连接器都会为所连接应用的对象提供抽象层。您只能通过此抽象访问应用的对象。抽象作为实体、操作和动作向您展示。
- 实体:实体可以被视为连接的应用或服务中的对象或属性集合。不同连接器的实体定义也会有所不同。例如,在数据库连接器中,表是实体;在文件服务器连接器中,文件夹是实体;在消息传递系统连接器中,队列是实体。
但可能的情况是,连接器不支持或不具有任何实体,在这种情况下,
Entities
列表将为空。 - 操作:操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作:
从可用列表中选择一个实体,系统会生成该实体可用的操作列表。如需了解操作的详细说明,请参阅连接器任务的实体操作。不过,如果连接器不支持任何实体操作,则
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"} ]
示例 - 上传文件
- 在
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" }]
实体操作示例
示例 - 列出所有文件
- 在
Configure connector task
对话框中,点击Entities
。 - 从
Entity
列表中选择“文件”。 - 选择
LIST
操作,然后点击完成。
您可以对以下实体执行 LIST 操作:Folders、TrashedItems、SharedItems、Collaborations、TaskAssignments 和 Tasks
示例 - 获取文件
- 在
Configure connector task
对话框中,点击Entities
。 - 从
Entity
列表中选择“文件”。 - 选择
GET
操作,然后点击完成。 - 将实体 ID 设置为 1262397830475,即要传递的键。如需设置实体 ID,请在连接器任务的任务输入部分,点击 EntityId,然后在默认值字段中输入
1262397830475
。
必须直接传递实体 ID 的值,例如 1262397830475。其中,1262397830475 是唯一的主键值。
您可以对以下实体执行 GET 操作:文件夹、SharedItems、协作项目、TaskAssignment 和 Tasks
示例 - 删除文件
- 在
Configure connector task
对话框中,点击Entities
。 - 从
Entity
列表中选择“文件”。 - 选择
DELETE
操作,然后点击完成。 - 将实体 ID 设置为 1258725940971,即要传递的键。如需设置实体 ID,请在连接器任务的任务输入部分,点击 EntityId,然后在默认值字段中输入
1258725940971
。或者,如果实体有两个复合商家键或主键(而不是指定 entityId),您也可以将 filterClause 设置为
Id='1258725940971'
。
您可以对以下实体执行 DELETE 操作:文件夹、任务、协作项目、SharedItems 和 TaskAssignment
示例 - 创建文件夹
- 在
Configure connector task
对话框中,点击Entities
。 - 从
Entity
列表中选择“文件夹”。 - 选择
Create
操作,然后点击完成。 - 在连接器任务的任务输入部分中,点击
connectorInputPayload
,然后在Default Value
字段中输入类似于以下内容的值:{ "Name": "Google Cloud Platforms_created_folders", "ParentId": "0" }
如果集成成功,
Folder
任务的connectorOutputPayload
响应参数的值将类似于以下内容:{ "Id": "222269371053" }
示例 - 创建协作
- 在
Configure connector task
对话框中,点击Entities
。 - 从
Entity
列表中选择“协作”。 - 选择
Create
操作,然后点击完成。 - 在连接器任务的任务输入部分中,点击
connectorInputPayload
,然后在Default Value
字段中输入类似于以下内容的值:{ "ItemId": "216592737829", "ItemType": "folder", "AccessibleById": "27370766275", "AccessibleByType": "user", "AccessibleByLogin": "baklavainthebalkans@gmail.com", "Role": "editor" }
如果集成成功,
Folder
任务的connectorOutputPayload
响应参数的值将类似于:{ "Success": false }
示例 - 创建任务
- 在
Configure connector task
对话框中,点击Entities
。 - 从
Entity
列表中选择“Tasks”。 - 选择
Create
操作,然后点击完成。 - 在连接器任务的任务输入部分中,点击
connectorInputPayload
,然后在Default Value
字段中输入类似于以下内容的值:{ "ItemId": "1253997361112", "ItemType": "file", "Action": "review", "Message": "Creating a task from Google Cloud Platform", "DueAt": "2023-12-12 09:01:15.0", "CompletionRule": "all_assignees" }
如果集成成功,
Folder
任务的connectorOutputPayload
响应参数的值将类似于以下内容:{ "Id": "1253997361112" }
示例 - 创建任务分配
- 在
Configure connector task
对话框中,点击Entities
。 - 从
Entity
列表中选择“TaskAssignment”。 - 选择
Create
操作,然后点击完成。 - 在连接器任务的任务输入部分中,点击
connectorInputPayload
,然后在Default Value
字段中输入类似于以下内容的值:{ "TaskId": "21507516872", "AssignedToId": "27370766275" }
如果集成成功,
Folder
任务的connectorOutputPayload
响应参数的值将类似于以下内容:{ "Id": "50804351753" }
示例 - 更新文件
- 在
Configure connector task
对话框中,点击Entities
。 - 从
Entity
列表中选择“文件”。 - 选择
Update
操作,然后点击完成。 - 在连接器任务的任务输入部分中,点击
connectorInputPayload
,然后在Default Value
字段中输入类似于以下内容的值:{ "Name": "Get Started with Box Files.pdf" }
- 将实体 ID 设置为 1253997361112。如需设置实体 ID,请点击 entityId,然后在默认值字段中输入
1253997361112
。或者,您也可以将 filterClause 设置为
1253997361112
,而不是指定 entityId。运行此示例会在连接器任务的
connectorOutputPayload
输出变量中返回类似于以下内容的响应:{ "Id": "1253997361112" }
您可以对以下实体执行 UPDATE 操作:Folders、Tasks、Collaborations、SharedItems 和 TaskAssignments
示例 - 更新文件夹
- 在
Configure connector task
对话框中,点击Entities
。 - 从
Entity
列表中选择“文件夹”。 - 选择
Update
操作,然后点击完成。 - 在连接器任务的任务输入部分中,点击
connectorInputPayload
,然后在Default Value
字段中输入类似于以下内容的值:{ "Name": "Demo Update" }
- 将实体 ID 设置为 216457668125。如需设置实体 ID,请点击 entityId,然后在默认值字段中输入
216457668125
。或者,您也可以将 filterClause 设置为
216457668125
,而不是指定 entityId。运行此示例会在连接器任务的
connectorOutputPayload
输出变量中返回类似于以下内容的响应:{ "Id": "216457668125" }
示例 - 更新协作
- 在
Configure connector task
对话框中,点击Entities
。 - 从
Entity
列表中选择“协作”。 - 选择
Update
操作,然后点击完成。 - 在连接器任务的任务输入部分中,点击
connectorInputPayload
,然后在Default Value
字段中输入类似于以下内容的值:{ "Role": "Viewer" }
- 将实体 ID 设置为 46685648757。如需设置实体 ID,请点击 entityId,然后在默认值字段中输入
46685648757
。或者,您也可以将 filterClause 设置为
46685648757
,而不是指定 entityId。运行此示例会在连接器任务的
connectorOutputPayload
输出变量中返回类似于以下内容的响应:{ }
示例 - 更新任务
- 在
Configure connector task
对话框中,点击Entities
。 - 从
Entity
列表中选择“Tasks”。 - 选择
Update
操作,然后点击完成。 - 在连接器任务的任务输入部分中,点击
connectorInputPayload
,然后在Default Value
字段中输入类似于以下内容的值:{ "Message": "This is a new task is updated and assigned to you by me" }
- 将实体 ID 设置为 21507516872。如需设置实体 ID,请点击 entityId,然后在默认值字段中输入
21507516872
。或者,您也可以将 filterClause 设置为
21507516872
,而不是指定 entityId。运行此示例会在连接器任务的
connectorOutputPayload
输出变量中返回类似于以下内容的响应:{ "Id": "21507516872" }
示例 - 更新任务分配
- 在
Configure connector task
对话框中,点击Entities
。 - 从
Entity
列表中选择“TaskAssignment”。 - 选择
Update
操作,然后点击完成。 - 在连接器任务的任务输入部分中,点击
connectorInputPayload
,然后在Default Value
字段中输入类似于以下内容的值:{ "Message": "Looks good to me", "ResolutionState": "completed" }
- 将实体 ID 设置为 49542929469。如需设置实体 ID,请点击 entityId,然后在默认值字段中输入
49542929469
。或者,您也可以将 filterClause 设置为
49542929469
,而不是指定 entityId。运行此示例会在连接器任务的
connectorOutputPayload
输出变量中返回类似于以下内容的响应:{ "Id": "49542929469" }
示例 - 更新 Transferfolders
- 在
Configure connector task
对话框中,点击Entities
。 - 从
Entity
列表中选择“文件夹”。 - 选择
Update
操作,然后点击完成。 - 在连接器任务的任务输入部分中,点击
connectorInputPayload
,然后在Default Value
字段中输入类似于以下内容的值:{ "Name": "Demo Update" "ParentId": "216596059374" }
- 将实体 ID 设置为 216457668125。如需设置实体 ID,请点击 entityId,然后在默认值字段中输入
216457668125
。运行此示例会在连接器任务的
connectorOutputPayload
输出变量中返回类似于以下内容的响应:{ "Id": "216457668125" }
使用 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 中创建和使用连接器任务,请参阅连接器任务。