创建数据包导入任务-CreateCollectionRecord
功能介绍
创建数据包导入任务
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
octopus:dataImportRecord:create
Write
workspace *
-
-
-
URI
POST /v1.0/{project_id}/data/import-records
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| Content-Type | 是 | String | 参数解释: 内容类型。填application/json 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| type | 是 | String | 参数解释: 传输方式 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| path | 是 | String | 参数解释: 数据包路径 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| ak | 是 | String | 参数解释: AK值 约束限制: 大写英文字母或数字,长度为20位 取值范围: 不涉及 默认取值: 不涉及 |
| sk | 是 | String | 参数解释: SK值 约束限制: 英文字母或数字,长度为40位 取值范围: 不涉及 默认取值: 不涉及 |
| packages | 否 | Array of strings | 参数解释: 数据包名列表 约束限制: 最多2000个数据包 |
| agreement_confirm | 是 | Boolean | 参数解释: 是否同意协议 约束限制: 必须为true 取值范围: 默认取值: 不涉及 |
| opendata_processor_config | 否 | DataProcessorConfig object | 参数解释: 转opendata处理任务配置 约束限制: 不涉及 |
| desensitize_processor_config | 否 | DataProcessorConfig object | 参数解释: 脱敏处理任务配置 约束限制: 不涉及 |
| workspace_id | 是 | String | 参数解释: 工作空间ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| is_select_all_packages | 否 | Boolean | 参数解释: 是否导入全部数据包,当is_select_all_packages为false或空时,packages字段必须指定数据包名称 约束限制: 不涉及 取值范围: 默认取值: false |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| processor_id | 是 | Long | 参数解释: 算子ID,配置算子时此项必填 约束限制: 最小值1 取值范围: 不涉及 默认取值: 不涉及 |
| resource_spec | 是 | String | 参数解释: 资源规格,配置算子时此项必填,示例:1Core_4GiB。具体获取方式可参考“查询可用资源规格“接口 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| envs | 否 | Array of JobEnv objects | 参数解释: 环境变量 约束限制: 最多十组 |
| cluster_type | 否 | String | 参数解释: 集群类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| cluster_id | 否 | String | 参数解释: 集群ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:201
| 参数 | 参数类型 | 描述 |
|---|---|---|
| payload | payloadWithSingleString object | 参数解释: 实际返回信息 |
| meta_info | RespMetaInfo object | 参数解释: 元数据 |
请求示例
创建数据导入任务
POST https://{endpoint}/v1.0/{project_id}/data/import-records
{
"packages" : [ "my_package1", "my_package2" ],
"type" : "OBS",
"path" : "octopus-user-087679f0aaxxxxxxxxxxxxxx2f5e902b/rosbag/DO202302010834046875241",
"ak" : "ABCTUKMSXXXXXXXXXOKY",
"sk" : "012345jPI3YpmVRVTlbExxxxxxxxxx4Pvmkhp0L1s",
"agreement_confirm" : true,
"opendata_processor_config" : {
"envs" : [ {
"key" : "topic",
"value" : "camera_1"
} ],
"processor_id" : 10241,
"resource_spec" : "4Core_8GiB",
"cluster_type" : "CCE",
"cluster_id" : "087679f0aaxxxxxxxxxxxxxx2f5e902b"
}
} 响应示例
状态码:201
创建成功,返回导入id
{
"meta_info" : {
"current_time" : "2022-01-01T08:08:29Z"
},
"payload" : {
"item" : "DCL0000000000001"
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 201 | 创建成功,返回导入id |
| 400 | 请求参数错误或OBS配额不足 |
| 403 | 权限校验失败 |
| 500 | 系统内部错误 |
错误码
请参见错误码。