跳到主要内容

Download S3

Learn how to add and configure the \"Download S3\" action in your Buddy pipeline

POST参数

名称类型描述
name
必填
String操作名称
type
必填
StringThe type of the action. Should be set to AMAZON_S3.
bucket_name
必填
StringThe name of the Amazon S3 Bucket.
source_path
必填
StringThe path from which the file will be downloaded.
destination_path
必填
StringThe path in which the file will be saved.
integration
必填
IntegrationThe ID of the integration.
overwriteBooleanReplace files if they already exist.
recursiveBooleanIf set to true, the whole directory tree is downloaded, otherwise only the files from the path are downloaded.
download_excludesString[]The paths and/or files that will be left out during the download.
download_includesString[]The exceptions from the ignore patterns set in download_excludes.

示例

请求

POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions

JSON

{
"name":"Download files from AWS S3/",
"type":"DOWNLOAD_S3",
"trigger_time":"ON_EVERY_EXECUTION",
"bucket_name":"bucketname",
"source_path":"source",
"destination_path":"destination",
"integration":{
"hash_id":"5ddb7c180fb38be67bd78a88a"
},
"overwrite":true,
"recursive":true,
"download_excludes": [
"/tmp",
"*.log"
],
"download_includes": [
"/tmp/assets",
"/tmp/styles"
]
}

示例响应

HTTP

Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
"url":"https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/2",
 "html_url":"https://app.buddy.works/buddy/company-website/pipelines/pipeline/2/action/2/edit",
"id":2,
"name":"Download files from AWS S3/",
"type":"DOWNLOAD_S3",
"trigger_time":"ON_EVERY_EXECUTION",
"last_execution_status":"INITIAL",
"source_path":"source",
"bucket_name":"bucketname",
"integration":{
"url":"https://api.buddy.works/workspaces/buddy/user/integrations/5dcd43cee36b2f53f1555978",
"html_url":"https://app.buddy.works/my-id",
"hash_id":"5ddb7c180fb38be67bd78a88a",
"type":"AMAZON"
},
"recursive":true,
"overwrite":true,
"destination_path":"destination",
"download_excludes": [
"/tmp",
"*.log"
],
"download_includes": [
"/tmp/assets",
"/tmp/styles"
],
  "pipeline":{
    "url":"https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2",
    "html_url":"https://app.buddy.works/buddy/company-website/pipelines/pipeline/2",
  "id":2,
  "name":"test server",
  "on": "CLICK",
"refs": [
"refs/heads/master"
],
  "last_execution_status":"SUCCESSFUL",
  "last_execution_revision":"506a3963507943d6908154f4bc9646e829128a08"
}
}