创建数据导入导出任务 - CreateHpcCacheTask
功能介绍
创建数据导入导出任务。
接口约束
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v1/{project_id}/sfs-turbo/{share_id}/hpc-cache/task
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于标识资源所属的IAM项目空间,实现项目级资源隔离与权限管控。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| share_id | 是 | String | 参数解释: 文件系统ID,用于唯一标识SFS Turbo文件系统实例。 获取方法请参见查询文件系统列表接口。 约束限制: 文件系统状态必须为可用状态,不能处于创建中、扩容中、删除中等任务执行中的中间状态,否则接口将拒绝该请求。调用前可通过查询文件系统详情接口确认文件系统状态。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于鉴权认证。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| Content-Type | 是 | String | 参数解释: 请求消息体MIME类型,用于标识请求正文的数据格式。 约束限制: 不涉及。 取值范围: application/json 默认取值: application/json |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| type | 是 | String | 参数解释: 任务类型,用于指定数据导入导出的操作方式。 约束限制: 100MB/s/TiB-智算型、200MB/s/TiB-智算型不支持创建任务类型为导出的数据任务。 取值范围:
默认取值: 不涉及。 |
| src_target | 是 | String | 参数解释: 联动目录名称,指定文件系统中与OBS后端存储建立联动关系的子目录名称。 约束限制: 联动目录必须已存在且处于可用状态。 取值范围: 不涉及。 默认取值: 不涉及。 |
| src_prefix | 否 | String | 参数解释: 导入导出任务的源端路径前缀,用于过滤需要同步的对象。 导入时不需要包含OBS桶名,导出时不需要包含联动目录名称。 当type为import、import_metadata、preload时,该参数必须是OBS后端存储内的相对路径前缀。 当type为export时,该参数必须是文件系统内file_system_path下的相对路径前缀。 如果不带该字段,导入时会导入绑定OBS桶内的所有对象,导出时会导出联动目录下的所有文件。 约束限制: 由1~1023个字符组成。 取值范围: 不涉及。 默认取值: 不涉及。 |
| dest_target | 是 | String | 参数解释: 目标端联动目录名称。 约束限制: 必须和src_target保持一致。 取值范围: 不涉及。 默认取值: 不涉及。 |
| dest_prefix | 否 | String | 参数解释: 目标端路径前缀。 约束限制: 必须和src_prefix保持一致。 取值范围: 不涉及。 默认取值: 不涉及。 |
| attributes | 否 | ObsTargetAttributes object | 参数解释: 后端存储属性配置对象,用于配置导入到文件系统的文件和目录的权限及属主信息。 约束限制: 2024年6月30日及之前创建且未升级的文件系统版本不支持该参数,请提交工单处理。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| file_mode | 否 | Integer | 参数解释: 导入的文件权限,使用八进制数字表示。第一位表示文件所有者的权限,取值范围是0到7;第二位表示文件所属用户组的权限,取值范围是0到7;第三位表示其他用户的权限,取值范围是0到7。文件所有者由uid指定,文件所属用户组由gid指定,不是文件所有者且不在文件所属用户组的用户为其他用户。 数字4、2、1分别表示读、写、执行权限,这些数字相加,即可得到所需的权限组合。例如:750中第一位7代表该文件所有者对该文件具有读、写、执行权限;第二位5代表该文件所属用户组对该文件具有读、执行权限;第三位0代表其他用户对该文件无权限。 约束限制: 不涉及。 取值范围: 000到777的整数。 默认取值: 不涉及。 |
| dir_mode | 否 | Integer | 参数解释: 导入的目录权限,使用八进制数字表示。第一位表示目录所有者的权限,取值范围是0到7;第二位表示目录所属用户组的权限,取值范围是0到7;第三位表示其他用户的权限,取值范围是0到7。目录所有者由uid指定,目录所属用户组由gid指定,不是目录所有者且不在目录所属用户组的用户为其他用户。 数字4、2、1分别表示读、写、执行权限,这些数字相加,即可得到所需的权限组合。例如:750中第一位7代表该目录所有者对该目录具有读、写、执行权限;第二位5代表该目录所属用户组对该目录具有读、执行权限;第三位0代表其他用户对该目录无权限。 约束限制: 不涉及。 取值范围: 000到777的整数。 默认取值: 不涉及。 |
| uid | 否 | Integer | 参数解释: 导入对象所有者的用户ID。 约束限制: 不涉及。 取值范围: 0到4294967294(即2^32-2)的整数。 默认取值: 0 |
| gid | 否 | Integer | 参数解释: 导入对象所属用户组的ID。 约束限制: 不涉及。 取值范围: 0到4294967294(即2^32-2)的整数。 默认取值: 0 |
响应参数
状态码:202
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-request-id | String | 参数解释: 请求ID,用于唯一标识和追踪本次请求。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| task_id | String | 参数解释: 任务ID,用于唯一标识创建的数据导入导出任务。 可通过查询数据导入导出任务列表接口查询任务执行状态。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-request-id | String | 参数解释: 请求ID,用于唯一标识和追踪本次请求。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| errCode | String | 参数解释: 错误码,用于标识请求失败的原因。详细错误码请参见错误码。 取值范围: 不涉及。 |
| errMsg | String | 参数解释: 错误描述,用于描述请求失败的具体原因,便于排查问题。请参见错误码。 取值范围: 不涉及。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-request-id | String | 参数解释: 请求ID,用于唯一标识和追踪本次请求。 取值范围: 不涉及。 |
请求示例
-
创建快速导入任务,任务类型是"import_metadata",联动目录名称是"sfs-link-directory",关联OBS桶内的源端路径前缀是"input/datasets/"。
POST HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/{share_id}/hpc-cache/task { "type" : "import_metadata", "src_target" : "sfs-link-directory", "src_prefix" : "input/datasets/", "dest_target" : "sfs-link-directory", "dest_prefix" : "input/datasets/" } -
创建快速导入任务,任务类型是"import_metadata",联动目录名称是"sfs-link-directory",关联OBS桶内的源端路径前缀是"input/datasets/";指定导入的文件在文件系统内的权限为640,目录权限为750。
POST HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/{share_id}/hpc-cache/task { "type" : "import_metadata", "src_target" : "sfs-link-directory", "src_prefix" : "input/datasets/", "dest_target" : "sfs-link-directory", "dest_prefix" : "input/datasets/", "attributes" : { "file_mode" : 640, "dir_mode" : 750 } } -
创建数据预热任务,任务类型是"preload",联动目录名称是"sfs-link-directory",关联OBS桶内的源端路径前缀是"input/datasets/";指定导入的文件在文件系统内的权限为640,目录权限为750,uid为0,gid为0。
POST HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/{share_id}/hpc-cache/task { "type" : "preload", "src_target" : "sfs-link-directory", "src_prefix" : "input/datasets/", "dest_target" : "sfs-link-directory", "dest_prefix" : "input/datasets/", "attributes" : { "file_mode" : 640, "dir_mode" : 750, "uid" : 0, "gid" : 0 } }
响应示例
状态码:202
{
"task_id" : "7bd2a9b6-xxxx-4605-xxxx-512d636001b0"
} 状态码:400
{
"errCode" : "SFS.TURBO.0001",
"errMsg" : "parameter error"
} 状态码:500
{
"errCode" : "SFS.TURBO.0005",
"errMsg" : "Internal server error"
} 状态码
| 状态码 | 描述 |
|---|---|
| 202 | 任务下发成功 |
| 400 | 客户端错误 |
| 500 | 内部错误 |
错误码
请参见错误码。