查询数据导入导出任务详情 - ShowHpcCacheTask
功能介绍
查询数据导入导出任务详情。
接口约束
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/sfs-turbo/{share_id}/hpc-cache/task/{task_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于标识资源所属的IAM项目空间,实现项目级资源隔离与权限管控。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| share_id | 是 | String | 参数解释: 文件系统ID,用于唯一标识SFS Turbo文件系统实例。 获取方法请参见查询文件系统列表接口。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| task_id | 是 | String | 参数解释: 任务ID,用于唯一标识一个数据导入导出任务。 可通过创建数据导入导出任务接口的响应获取,或通过查询数据导入导出任务列表接口查询。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于鉴权认证。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| Content-Type | 是 | String | 参数解释: 请求消息体MIME类型,用于标识请求正文的数据格式。 约束限制: 不涉及。 取值范围: application/json 默认取值: application/json |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-request-id | String | 参数解释: 请求ID,用于唯一标识和追踪本次请求。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| task_id | String | 参数解释: 任务ID,用于唯一标识一个数据导入导出任务。 取值范围: 不涉及。 |
| type | String | 参数解释: 任务类型,用于标识数据导入导出任务的操作方式。 取值范围: |
| status | String | 参数解释: 任务状态,用于标识任务的当前执行阶段。 取值范围: |
| src_target | String | 参数解释: 联动目录名称,指定文件系统中与OBS后端存储建立联动关系的子目录名称。 取值范围: 不涉及。 |
| src_prefix | String | 参数解释: 导入导出任务的源端路径前缀,用于过滤需要同步的对象。 导入时为OBS桶内的相对路径前缀,导出时为联动目录下的相对路径前缀。 取值范围: 不涉及。 |
| dest_target | String | 参数解释: 目标端联动目录名称,当前只支持和src_target保持一致。 取值范围: 不涉及。 |
| dest_prefix | String | 参数解释: 目标端路径前缀,当前只支持和src_prefix保持一致。 取值范围: 不涉及。 |
| start_time | String | 参数解释: 任务开始时间。 取值范围: 采用UTC时间格式,格式为yyyy-MM-ddTHH:mm:ss,如2023-09-02T15:04:05。 |
| end_time | String | 参数解释: 任务结束时间,任务未完成时该字段为空字符串。 取值范围: 采用UTC时间格式,格式为yyyy-MM-ddTHH:mm:ss,如2023-09-02T15:04:05。 |
| message | String | 参数解释: 任务执行结果信息。 任务执行成功时为空字符串,任务执行失败时返回错误原因描述。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-request-id | String | 参数解释: 请求ID,用于唯一标识和追踪本次请求。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| errCode | String | 参数解释: 错误码,用于标识请求失败的原因。详细错误码请参见错误码。 取值范围: 不涉及。 |
| errMsg | String | 参数解释: 错误描述,用于描述请求失败的具体原因,便于排查问题。请参见错误码。 取值范围: 不涉及。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-request-id | String | 参数解释: 请求ID,用于唯一标识和追踪本次请求。 取值范围: 不涉及。 |
请求示例
文件系统ID为"77ba6f4b-6365-4895-8dda-bc7142af4dde", 任务ID为"11abef67-7ac4-0f46-644d-1d5cfc2424a4",查询该任务的详情
"GET HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/77ba6f4b-6365-4895-8dda-bc7142af4dde/hpc-cache/task/11abef67-7ac4-0f46-644d-1d5cfc2424a4" 响应示例
状态码:200
{
"task_id" : "7bd2a9b6-xxxx-4605-xxxx-512d636001b0",
"type" : "import_metadata",
"status" : "DOING",
"src_target" : "sfs-link-directory",
"src_prefix" : "input/datasets/",
"dest_target" : "sfs-link-directory",
"dest_prefix" : "input/datasets/",
"message" : "",
"start_time" : "2023-09-02T15:04:05",
"end_time" : ""
} 状态码:400
{
"errCode" : "SFS.TURBO.0001",
"errMsg" : "parameter error"
} 状态码:500
{
"errCode" : "SFS.TURBO.0005",
"errMsg" : "Internal server error"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 成功 |
| 400 | 错误响应 |
| 500 | 错误响应 |
错误码
请参见错误码。