创建通用存储导出任务-CreateDataWarehouseExportTask

功能介绍

创建通用存储导出任务

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。

如果使用身份策略授权，需具备如下身份策略权限。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
octopus:dataWarehouseExportTask:create	Write	workspace *	-	octopus:dataWarehouse:createExportTask	-

URI

POST /v1.0/{project_id}/common/warehouses/{data_warehouse_id}/data/export-tasks

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目ID，获取方法请参见获取项目ID。约束限制：不涉及取值范围：只能用小写字母 a-z 和数字 0-9组成，且长度为32个字符默认取值：不涉及
data_warehouse_id	是	String	参数解释：通用存储id 约束限制：不涉及取值范围：标准36位带横杠、小写UUID 默认取值：不涉及

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
Content-Type	是	String	参数解释：内容类型。填application/json 约束限制：不涉及取值范围：不涉及默认取值：不涉及
X-Auth-Token	是	String	参数解释：用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）约束限制：不涉及取值范围：不涉及默认取值：不涉及

表3 请求Body参数
参数	是否必选	参数类型	描述
bucket_path	是	String	参数解释：导出数据的目标obs路径，该路径和导出数据的路径总长度不能超过最大值限制约束限制：不涉及取值范围：长度为[1~1024]个字符默认取值：不涉及
bucket_name	是	String	参数解释：桶名约束限制：不涉及取值范围：只能用小写英文字母、数字、“-”、“.”组成，且长度为[3~63]个字符默认取值：不涉及
access_key	是	String	参数解释： base64编码后的ak(access_key与secret_key需要拥有bucket_name桶的obs:object:GetObject,obs:object:PutObject,obs:bucket:ListAllMyBuckets,obs:bucket:ListBucket权限) 约束限制：不涉及取值范围：不涉及默认取值：不涉及
secret_key	是	String	参数解释： base64编码后的sk(access_key与secret_key需要拥有bucket_name桶的obs:object:GetObject,obs:object:PutObject,obs:bucket:ListAllMyBuckets,obs:bucket:ListBucket权限) 约束限制：不涉及取值范围：不涉及默认取值：不涉及
agreement_confirm	是	Boolean	参数解释：是否同意协议，必须为true 约束限制：不涉及取值范围：不涉及默认取值：不涉及
export_source	是	String	参数解释：导出的数据源约束限制：不涉及取值范围： ES：数据索引导出，可选择传入warehouse_params中的除file_paths参数的其他参数 OBS：目录树导出，仅需传入warehouse_params中的file_paths参数默认取值：不涉及
warehouse_params	否	WarehouseParamRequest object	参数解释：导出数据的过滤条件

表4 WarehouseParamRequest
参数	是否必选	参数类型	描述
file_paths	否	Array of strings	参数解释：文件路径（export_source字段为OBS时，选择的文件路径）约束限制：不涉及
data_process_task_ids	否	Array of strings	参数解释：数据处理任务id 约束限制：不涉及
raw_data_ids	否	Array of strings	参数解释：原始数据包id 约束限制：不涉及
start_time	否	Long	参数解释：开始时间，UTC标准时间毫秒时间戳约束限制：不涉及取值范围：不涉及默认取值：不涉及
end_time	否	Long	参数解释：结束时间，UTC标准时间毫秒时间戳约束限制：不涉及取值范围：不涉及默认取值：不涉及
file_name	否	String	参数解释：文件名称，支持模糊匹配约束限制：不涉及取值范围：不涉及默认取值：不涉及

响应参数

状态码：200

表5 响应Body参数
参数	参数类型	描述
payload	DataWarehouseExportPayload object	参数解释：实际返回信息
meta_info	MetaInfo object	参数解释：元数据

表6 DataWarehouseExportPayload
参数	参数类型	描述
item	DataWarehouseExportTask object	参数解释：导出任务

表7 DataWarehouseExportTask
参数	参数类型	描述
id	String	参数解释：导出任务id 取值范围：不涉及
export_task_name	String	参数解释：导出任务名称取值范围：不涉及

表8 MetaInfo
参数	参数类型	描述
current_time	String	参数解释：请求时间，UTC时间格式，时间为UTC标准时间取值范围：不涉及

请求示例

创建导出的数据源为ES时的导出任务

POST https://{endpoint}/v1.0/{project_id}/common/warehouses/dea44f72-4ec2-446e-af50-a141feb41df2/data/export-tasks

{
  "warehouse_params" : {
    "raw_data_ids" : [ "DPK0402855" ]
  },
  "export_source" : "ES",
  "bucket_name" : "octopus-test",
  "bucket_path" : "test/test",
  "secret_key" : "aWFoYyoqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqMEwxcw==",
  "access_key" : "Q0lNVCoqKioqKioqKioqKjlPS1k=",
  "agreement_confirm" : true
}

创建导出的数据源为OBS时的导出任务

POST https://{endpoint}/v1.0/{project_id}/common/warehouses/dea44f72-4ec2-446e-af50-a141feb41df2/data/export-tasks

{
  "warehouse_params" : {
    "file_paths" : [ "processor-job-554158/test/", "processor-job-554158/test2/" ]
  },
  "export_source" : "OBS",
  "bucket_name" : "octopus-test",
  "bucket_path" : "test/test",
  "secret_key" : "aWFoYyoqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqMEwxcw==",
  "access_key" : "Q0lNVCoqKioqKioqKioqKjlPS1k=",
  "agreement_confirm" : true
}

响应示例

状态码：200

创建成功

创建导出的数据源为ES时的导出任务

{
  "meta_info" : {
    "current_time" : "2025-05-14T06:43:41Z"
  },
  "payload" : {
    "item" : {
      "id" : "99f4bc78-c963-402d-a707-2617016cfd59",
      "export_task_name" : "test_1747205021909"
    }
  }
}

创建导出的数据源为OBS时的导出任务

{
  "meta_info" : {
    "current_time" : "2025-05-14T06:43:41Z"
  },
  "payload" : {
    "item" : {
      "id" : "2cb9650c-a57c-4525-8b81-c202d0ad76e1",
      "export_task_name" : "test_1747205021909"
    }
  }
}