归档存储

归档存储 CAS 产品下线公告

产品简介

购买指南

快速入门

操作指南

工具指南

API 文档

SDK 文档

常见问题

联系我们

词汇表

办公协同&微信生态产品文档捉虫活动邀您参加！> HOT
文档中心>归档存储>API 文档>任务操作>List Jobs

List Jobs

最近更新时间：2024-12-17 17:51:55

我的收藏

本页目录：

功能描述

List Jobs 请求实现列出 Vault 的任务，包括正在进行的任务以及最近完成的任务。
支持跨账户操作。当操作本账户时，UID 为"-"。

请求

请求语法

GET /<UID>/vaults/<VaultName>/jobs HTTP 1.1
Host:cas.<Region>.myqcloud.com
Date:date
Authorization: Auth

请求参数

名称
描述
类型
必选
completed
要返回的任务的状态。枚举值： true 、 false。
Boolen
否
limit
要返回任务的最大数目，默认限制为 1000
String
否
marker
字典序，从 Marker 起读取对应条目
String
否
statuscode
要返回的任务状态的类型。枚举值： InProgress、Succeeded 、 Failed
String
否

请求头部

无特殊请求头部，其他头部请参见 公共请求头部。

请求内容

无请求内容

返回值

返回头部

无特殊返回头部，其他头部请参见 公共返回头部。

返回内容

检索Archive
名称
描述
类型
Action
Job 类型， 对于档案取回任务，此值为 ArchiveRetrieval
String
JobId
任务的 ID
String
JobDescription
任务的描述
String
CallBackUrl
回调的 HTTP 地址
String
CreationDate
任务启动时的通用协调时间 (UTC) 日期。ISO 8601 日期格式的字符串表示，例如，2013-03-20T17:03:43.221Z
ISO 8601
CompletionDate
任务完成时的通用协调时间 (UTC) 日期。ISO 8601 日期格式的字符串表示，例如，2013-03-20T17:03:43.221Z
ISO 8601
Completed
如果任务已完成，则为 true；否则为 false
Boolen
StatusCode
任务状态代码。枚举值： Succeeded、Failed 或 InProgress
String
StatusMessage
任务状态消息
String
VaultQCS
任务对应 Vault 的资源名称
String
Marker
字典序，Joblist 被截断，下一个 Job 从该 marker 开始读取
String
ArchiveId
在档案取回操作中请求的档案的 ID
String
ArchiveSizeInBytes
档案取回任务请求的档案的大小
Number
ArchiveSHA256TreeHash
档案取回操作的整个档案的 SHA256 树形哈希
String
RetrievalByteRange
档案取回任务所取回的字节范围，格式为“StartByteValue-EndByteValue”
如果没有在档案取回中指定范围，则取回整个档案，并且 StartByteValue 等于 0，EndByteValue 等于档案大小减去 1
String
SHA256TreeHash
档案请求范围的 SHA256 树形哈希值。
当指定未以树形哈希对齐的范围的档案取回任务，该值为 Null
当指定不等于整个档案的范围并且任务状态为 InProgress的 档案任务，该值为 Null，任务完成后，SHA256TreeHash 字段将具有值
String
Tier
Archive检索的检索类型。枚举值： Expedited ，Standard ，Bulk
String
{
    "JobList": [{
            "Action": "String",
            "JobId": "String",
            "JobDescription": "String",
            "CallBackUrl": "String",
            "CreationDate": "String",
            "CompletionDate": "String",
            "Completed": "Boolean",
            "StatusCode": "String",
            "StatusMessage": "String",
            "VaultQCS": "String",
            "ArchiveId": "String",
            "ArchiveSizeInBytes": "Number",
            "ArchiveSHA256TreeHash": "String",
            "RetrievalByteRange": "String",
            "SHA256TreeHash": "String",
            "Tier": "String"
        },
        ...
    ],
    "Marker": "String"
}
检索Archive列表
名称
描述
类型
Action
Job 类型， 对于档案取回任务，此值为 ArchiveRetrieval
String
JobId
任务的 ID
String
JobDescription
任务的描述
String
CallBackUrl
回调的 HTTP 地址
String
CreationDate
任务启动时的通用协调时间 (UTC) 日期。ISO 8601 日期格式的字符串表示，例如，2013-03-20T17:03:43.221Z
ISO 8601
CompletionDate
任务完成时的通用协调时间 (UTC) 日期。ISO 8601 日期格式的字符串表示，例如，2013-03-20T17:03:43.221Z
ISO 8601
Completed
如果任务已完成，则为 true；否则为 false
Boolen
StatusCode
任务状态代码。枚举值： Succeeded、Failed 或 InProgress
String
StatusMessage
任务状态消息
String
VaultQCS
任务对应 Vault 的资源名称
String
Marker
字典序，Joblist 被截断，下一个 Job 从该 marker 开始读取
String
InventorySizeInBytes
与检索 Archive 列表任务请求相关联的列表的大小，单位字节
Number
InventoryRetrievalParameters.Format
Archive列表输出格式，枚举值： CSV 、JSON。
String
InventoryRetrievalParameters.StartDate
文件库清单检索的开始日期（采用 UTC 格式）。ISO 8601 日期格式的字符串表示，例如，2013-03-20T17:03:43.221Z
ISO 8601
InventoryRetrievalParameters.EndDate
文件库清单检索的结束日期（采用 UTC 格式）。ISO 8601 日期格式的字符串表示，例如，2013-03-20T17:03:43.221Z
ISO 8601
InventoryRetrievalParameters.Limit
指定每个文件库清单检索请求返回的最大清单项目数。 有效值：正整数
String
InventoryRetrievalParameters.Marker
字典序，从 Marker 起读取对应 Archive 列表
String
{
    "JobList": [{
            "Action": "String",
            "JobId": "String",
            "JobDescription": "String",
            "CallBackUrl": "String",
            "CreationDate": "String",
            "CompletionDate": "String",
            "Completed": "Boolean",
            "StatusCode": "String",
            "StatusMessage": "String",
            "VaultQCS": "String",
            "InventorySizeInBytes": "String",
            "InventoryRetrievalParameters": {
                "Format": "String",
                "StartDate": "String",
                "EndDate": "String",
                "Limit": "String",
                "Marker": "String"
            }
        },
        ...
    ],
    "Marker": "String"
}
将档案导入COS
名称
描述
类型
Action
Job类型， 对于将档案导入 COS，此值为 PushToCOS
String
JobId
任务的 ID
String
JobDescription
任务的描述
String
CallBackUrl
回调的 HTTP 地址
String
CreationDate
任务启动时的通用协调时间 (UTC) 日期。ISO 8601 日期格式的字符串表示，例如，2013-03-20T17:03:43.221Z
ISO 8601
CompletionDate
任务完成时的通用协调时间 (UTC) 日期。ISO 8601 日期格式的字符串表示，例如，2013-03-20T17:03:43.221Z
ISO 8601
Completed
如果任务已完成，则为 true；否则为 false
Boolen
StatusCode
任务状态代码。枚举值： Succeeded、Failed 或 InProgress
String
StatusMessage
任务状态消息
String
VaultQCS
任务对应 Vault 的资源名称
String
Marker
字典序，Joblist 被截断，下一个 Job 从该 marker 开始读取
String
ArchiveId
在档案取回操作中请求的档案的 ID
String
ArchiveSizeInBytes
档案取回任务请求的档案的大小
Number
RetrievalByteRange
档案取回任务所取回的字节范围，格式为“StartByteValue*-*EndByteValue”。
如果没有在档案取回中指定范围，则取回整个档案，并且 StartByteValue 等于 0，EndByteValue 等于档案大小减去 1
String
Bucket
COS 中目标 Bucket 的域名
String
Object
COS 中目标 Bucket 的 Object 地址
String
Tier
Archive 检索的检索类型。枚举值： Expedited ，Standard ，Bulk
String
{
    "JobList": [{
            "Action": "String",
            "JobId": "String",
            "JobDescription": "String",
            "CallBackUrl": "String",
            "CreationDate": "String",
            "CompletionDate": "String",
            "Completed": "Boolean",
            "StatusCode": "String",
            "StatusMessage": "String",
            "VaultQCS": "String",
            "ArchiveId": "String",
            "ArchiveSizeInBytes": "Number",
            "RetrievalByteRange": "String",
            "Bucket": "String",
            "Object": "String",
            "Tier": "String"
        },
        ...
    ],
    "Marker": String
}
从 COS 中拉取对象
名称
描述
类型
Action
Job 类型， 对于从 COS 中拉取对象文件，此值为 PullFromCOS
String
JobId
任务的 ID
String
JobDescription
任务的描述
String
CallBackUrl
回调的 HTTP 地址
String
CreationDate
任务启动时的通用协调时间 (UTC) 日期。ISO 8601 日期格式的字符串表示，例如，2013-03-20T17:03:43.221Z
ISO 8601
CompletionDate
任务完成时的通用协调时间 (UTC) 日期。ISO 8601 日期格式的字符串表示，例如，2013-03-20T17:03:43.221Z
ISO 8601
Completed
如果任务已完成，则为 true；否则为 false
Boolen
StatusCode
任务状态代码。枚举值： Succeeded、Failed 或 InProgress
String
StatusMessage
任务状态消息
String
VaultQCS
任务对应 Vault 的资源名称
String
Marker
字典序，Joblist 被截断，下一个 Job 从该 marker 开始读取
String
ArchiveId
档案的 ID
String
ArchiveSizeInBytes
档案的大小
Number
Bucket
COS 中源 Bucket 的域名
String
Object
COS 中源 Bucket 的 Object 地址
String
Range
COS 中源 Object 的 Range 范围， 以字节（bytes）为单位
String
Condition
从COS获取数据的前置条件
Array
If-Modified-Since
如果文件修改时间晚于指定时间，返回文件内容
String
If-Umodified-Since
如果文件修改时间早于指定时间，返回文件内容
String
If-Match
如果文件 ETag 与指定的一致，返回文件内容
String
If-None-Match
如果文件 ETag 与指定的不一致，返回文件内容
String
ArchiveDescription
档案文件描述
String
{
    "JobList": [{
            "Action": "String",
            "JobId": "String",
            "JobDescription": "String",
            "CallBackUrl": "String",
            "CreationDate": "String",
            "CompletionDate": "String",
            "Completed": "Boolean",
            "StatusCode": "String",
            "StatusMessage": "String",
            "VaultQCS": "String",
            "ArchiveId": "String",
            "ArchiveSizeInBytes": "Number",
            "Bucket": "String",
            "Object": "String",
            "Condition": {
                "If-Modified-Since": "String",
                "If-Umodified-Since": "String",
                "If-Match": "String",
                "If-None-Match": "String"
            },
            "ArchiveDescription": "String"
        },
        ...
    ],
    "Marker": "String"
}


如果遇到产品相关问题，您可咨询 在线客服 寻求帮助。

归档存储 相关文档

中国站
文档活动
message-icon联系我们
目录
可通过正文划词反馈文档内容问题，我们会快速处理并更新文档内容。
跳过（1/2）