Amazon S3

实体、操作和动作

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

• 实体：实体可以被视为连接的应用或服务中的对象或属性集合。不同连接器的实体定义也会有所不同。例如，在数据库连接器中，表是实体；在文件服务器连接器中，文件夹是实体；在消息传递系统连接器中，队列是实体。

  但可能的情况是，连接器不支持或不具有任何实体，在这种情况下，Entities 列表将为空。

• 操作：操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作：
  • 列表
  • 获取
  • 创建
  • 更新
  • 删除

  从可用列表中选择一个实体，系统会生成该实体可用的操作列表。如需了解操作的详细说明，请参阅连接器任务的实体操作。不过，如果连接器不支持任何实体操作，则不支持的操作不会列在 Operations 列表中。

• 动作：动作是可通过连接器接口提供给集成的头等函数。动作可让您对一个或多个实体进行更改，并且动作因连接器而异。通常，操作会包含一些输入参数和一个输出参数。但可能的情况是，连接器不支持任何动作，在这种情况下，Actions 列表将为空。

操作

本部分列出了连接器支持的部分操作。如需了解如何配置操作，请参阅操作示例。

CopyObject 操作

此操作可让您将对象从一个存储桶复制到另一个存储桶或同一存储分区内。

CopyObject 操作的输入参数

CopyObject 操作的输出参数

如果复制成功，此操作会返回状态 200 (OK)。

如需了解如何配置 CopyObject 操作，请参阅操作示例。

DownloadObjects 操作

此操作可从存储桶中获取一个或多个对象。

DownloadObjects 操作的输入参数

DownloadObjects 操作的输出参数

如果下载成功，此操作会返回状态 200 (OK)。

如需了解如何配置 DownloadObjects 操作，请参阅操作示例。

UploadObject 操作

此操作可让您将对象上传到存储桶。

UploadObject 操作的输入参数

UploadObject 操作的输出参数

如果对象上传成功，此操作会返回状态 200 (OK)。

如需了解如何配置 UploadObject 操作，请参阅操作示例。

DeleteObject 操作

此操作可让您从存储桶中删除对象。

DeleteObject 操作的输入参数

DeleteObject 操作的输出参数

如果删除成功，此操作会返回状态 200 (OK)。

如需了解如何配置 DeleteObject 操作，请参阅操作示例。

MoveObject 操作

此操作可让用户将特定存储桶中的现有对象移动到另一个存储桶或同一存储桶中。

MoveObject 操作的输入参数

MoveObject 操作的输出参数

如果移动操作成功，此操作会返回状态 200 (OK)。

如需了解如何配置 MoveObject 操作，请参阅操作示例。

PutBucketAcl 操作

此操作可让您更新存储桶的访问控制列表 (ACL)。

PutBucketAcl 操作的输入参数

PutBucketAcl 操作的输出参数

如果存储桶 ACL 更新成功，此操作会返回状态 200 (OK)。

如需了解如何配置 PutBucketAcl 操作，请参阅操作示例。

PutObjectAcl 操作

此操作可让您更新存储桶中对象的访问控制列表 (ACL)。

PutObjectAcl 操作的输入参数

PutObjectAcl 操作的输出参数

如果对象 ACL 更新成功，此操作会返回状态 200 (OK)。

如需了解如何配置 PutObjectAcl 操作，请参阅操作示例。

操作示例

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

示例 - 复制对象

此示例将对象从一个存储桶复制到另一个存储桶。

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 CopyObject 操作，然后点击完成。
3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
   "BucketSource": "aws-s3-bucket-source",
   "ObjectSource": "pic.jpg",
   "BucketDestination": "aws-s3-bucket-destination",
   "ObjectDestination": "new_pic.jpg"
   }

如果操作成功，CopyObject 任务的 connectorOutputPayload 响应形参将具有类似于以下的值：

[{
"Status": "Success"
}]

示例 - 下载对象

此示例从指定存储桶下载对象。

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 DownloadObjects 操作，然后点击完成。
3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
   "Bucket": "aws-s3-bucket-source",
   "HasBytes": true
   }

如果操作成功，DownloadObjects 任务的 connectorOutputPayload 响应形参将具有类似于以下的值：

[{
"Success": "True",
"RemoteFile": "prefix1%2Faws-s3-bucket-source%2Finventory-test-1%2F2023-09-10T01-00Z%2Fmanifest.json",
"ContentBytes": "ewogICJzb3VyY2VCdWNrZXQiIDogImF3cy1zMy1idWNrZXQtYmNvbmUiLAogICJnOK"
},
{
"Success": "True",
"RemoteFile": "upload1.txt",
"ContentBytes": "VGhpcyBpcyBhIHRlc3RpbmcgZmlsZQ=="
}]

示例 - 上传对象

此示例将对象上传到指定的存储桶。

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 UploadObject 操作，然后点击完成。
3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
   "Bucket": "aws-s3-bucket-source",
   "FileName": "upload_1.txt",
   "Content": "This is a testing file",
   "AccessPolicy": "PUBLIC"
   }

如果操作成功，UploadObject 任务的 connectorOutputPayload 响应形参将具有类似于以下的值：

[{
"Status": "success",
"bucket": "aws-s3-bucket-source",
"rss:title": "Object 'upload_1.txt' was created in the bucket: aws-s3-bucket-source",
"object": "upload_1.txt"
}]

示例 - 删除对象

此示例会从指定存储桶中删除对象。

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 DeleteObject 操作，然后点击完成。
3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
   "Bucket": "aws-s3-bucket-source",
   "Object": "abc.png"
   }

如果操作成功，DeleteObject 任务的 connectorOutputPayload 响应形参将具有类似于以下的值：

[{
"Status": "Success"
}]

示例 - 移动对象

此示例将对象从一个存储桶移至另一个存储桶。

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 MoveObject 操作，然后点击完成。
3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
   "BucketSource": "aws-s3-bucket-source",
   "ObjectSource": "abc.png",
   "BucketDestination": "aws-s3-bucket-destination",
   "ObjectDestination": "moved.png"
   }

如果操作成功，MoveObject 任务的 connectorOutputPayload 响应形参将具有类似于以下的值：

[{
"Status": "Success"
}]

示例 - 更新存储桶的 ACL

此示例更新了存储桶的访问权限控制权限。

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 PutBucketAcl 操作，然后点击完成。
3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
   "BucketSource": "aws-s3-bucket-source",
   "ACL": "public-read"
   }

如果操作成功，PutBucketAcl 任务的 connectorOutputPayload 响应形参将具有类似于以下的值：

[{
"Status": "Success"
}]

示例 - 更新对象的 ACL

此示例用于更新存储桶中某个对象的访问权限控制。

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 PutObjectAcl 操作，然后点击完成。
3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
   "Bucket": "aws-s3-bucket-source",
   "ACL": "aws-exec-read",
   "Key": "AWS_S3_BusinessCase_V2.xlsx"
   }

如果操作成功，PutObjectAcl 任务的 connectorOutputPayload 响应形参将具有类似于以下的值：

[{
"Status": "Success"
}]

实体操作示例

本部分介绍如何在此连接器中执行一些实体操作。

示例 - 列出所有对象的元数据

此示例会提取 Object 实体中所有对象的元数据。

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Object。
3. 选择 List 操作，然后点击完成。
4. 或者，您可以在连接器任务的任务输入部分中，通过指定过滤条件子句来过滤结果集。 请始终使用英文单引号 (') 括起过滤条件子句值。例如，Bucket='test-bucket'。您还可以使用逻辑运算符指定多个过滤条件。例如，Bucket='test-bucket' and OwnerId='b1ecc809ad8467088afb'。

示例 - 获取存储桶的元数据

此示例从 Bucket 实体中获取具有指定 ID 的存储桶的元数据。

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Bucket。
3. 选择 Get 操作，然后点击完成。
4. 在连接器任务的任务输入部分，点击 EntityId，然后在默认值字段中输入 demo_replication。

   其中，demo_replication 是 Bucket 实体中的唯一存储桶 ID。

示例 - 创建存储桶

此示例会在 Bucket 实体中创建一个存储桶。

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Bucket。
3. 选择 Create 操作，然后点击完成。
4. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
   "Bucket": "Demo1697528098686"
   }

   如果集成成功，连接器任务的 connectorOutputPayload 字段将具有类似以下的值：

   [{
   "Bucket": "Demo1697528098686"
   }]

示例 - 删除存储桶

此示例会删除 Bucket 实体中具有指定 ID 的存储桶。

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择 Bucket。
3. 选择 Delete 操作，然后点击完成。
4. 在连接器任务的任务输入部分，点击 entityId，然后在默认值字段中输入 demo1697528098686。