更新时间:2022-11-30 GMT+08:00
分享

查询独立加密任务

功能介绍

查询独立加密任务状态。返回任务执行结果或当前状态。该API已废弃。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/encryptions

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

task_id

Array

独立加密任务ID。一次最多10个

status

String

任务状态。

取值如下:

  • WAITING:等待启动

  • PROCESSING:处理中

  • SUCCEEDED:处理成功

  • FAILED:处理失败

  • CANCELED:已取消

start_time

String

起始时间。格式为yyyymmddhhmmss。必须是与时区无关的UTC时间,指定task_id时该参数无效。

end_time

String

结束时间。格式为yyyymmddhhmmss。必须是与时区无关的UTC时间,指定task_id时该参数无效。

page

Integer

分页编号。查询指定“task_id”时,该参数无效。

默认值:0。

size

Integer

每页记录数。查询指定“task_id”时,该参数无效。

取值范围:[1,100]。

默认值:10。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Authorization

String

使用AK/SK方式认证时必选,携带的鉴权信息。

X-Project_Id

String

使用AK/SK方式认证时必选,携带项目ID信息, 与路径参数中的项目ID相同。

X-Sdk-Date

String

使用AK/SK方式认证时必选,请求的发生时间。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

task_array

Array of EachEncryptRsp objects

任务列表

is_truncated

Integer

是否截断

total

Integer

查询结果数量

表5 EachEncryptRsp

参数

参数类型

描述

task_id

String

任务ID

status

String

任务执行状态。

取值如下:

  • NO_TASK:无任务

  • WAITING:等待启动

  • PROCESSING:加密中

  • SUCCEEDED:加密成功

  • FAILED:加密失败

  • CANCELED:已删除

create_time

String

加密任务启动时间。

end_time

String

加密任务结束时间。

input

ObsObjInfo object

加密任务对应的源文件信息,包括location、桶名、源文件。

output

ObsObjInfo object

加密任务的输出信息,包含location、桶名、路径。

output_file_name

Array of strings

加密生成的文件名,数组类型,可能包含多个,包含加密文件名。

user_data

String

用户数据。

description

String

加密任务描述,当加密出现异常时,此字段为异常的原因。

表6 ObsObjInfo

参数

参数类型

描述

bucket

String

OBS的bucket名称。

location

String

OBS桶所在的区域,且必须与使用的MPC区域保持一致。

object

String

OBS对象路径,遵守OSS Object定义。

  • 当用于指示input时,需要指定到具体对象。

  • 当用于指示output时, 只需指定到转码结果期望存放的路径。

file_name

String

文件名,仅用于转封装指定输出名称。

  • 当指定了此参数时,输出的对象名为object/file_name 。

  • 当不指定此参数时,输出的对象名为object/xxx,其中xxx由MPC指定。

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

GET https://{endpoint}/v1/{project_id}/encryptions?task_id=31207

响应示例

状态码: 200

查询独立加密任务成功。

{
  "task_array" : [ {
    "task_id" : 31207,
    "status" : "SUCCEEDED",
    "create_time" : 20201119103952,
    "end_time" : 20201119104051,
    "input" : {
      "bucket" : "obs-apitest-01",
      "location" : "cn-north-5",
      "object" : "encrypt/m3u8/index.m3u8"
    },
    "output" : {
      "bucket" : "obs-apitest-01",
      "location" : "cn-north-5",
      "object" : "out_gamma/encrypt/001"
    },
    "output_file_name" : [ "index.m3u8" ]
  } ],
  "is_truncated" : 0,
  "total" : 1
}

状态码: 400

查询独立加密任务失败。

{
  "error_code" : "MPC.10202",
  "error_msg" : "Invalid request parameter."
}

状态码

状态码

描述

200

查询独立加密任务成功。

400

查询独立加密任务失败。

错误码

请参见错误码

分享:

    相关文档

    相关产品