Describe Job

最近更新时间:2019-03-06 18:10:36

功能描述

Describe Job 请求实现获取Vault的具体任务信息

支持跨账户操作。当操作本账户时,UID为"-"

请求

请求语法

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

请求参数

无特殊请求参数。

请求头部

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

请求内容

无请求内容。

返回值

返回头部

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

返回内容

检索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 任务状态代码。枚举值: SucceededFailedInProgress String
StatusMessage 任务状态消息 String
VaultQCS 任务对应Vault的资源名称 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检索的检索类型。枚举值: ExpeditedStandardBulk String
{
    "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"
}

检索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 任务状态代码。枚举值: SucceededFailedInProgress String
StatusMessage 任务状态消息 String
VaultQCS 任务对应Vault的资源名称 String
InventorySizeInBytes 与检索Archive列表任务请求相关联的列表的大小,单位字节 Number
Format Archive列表输出格式,枚举值: CSVJSON String
StatDate 文件库清单检索的开始日期(采用 UTC 格式)。ISO 8601 日期格式的字符串表示,例如,2013-03-20T17:03:43.221Z ISO 8601
EndDate 文件库清单检索的结束日期(采用 UTC 格式)。ISO 8601 日期格式的字符串表示,例如,2013-03-20T17:03:43.221Z ISO 8601
Limit 指定每个文件库清单检索请求返回的最大清单项目数。 有效值:正整数 String
InventorySizeInBytes. Marker 字典序,从Marker起读取对应Archive列表 String
{
    "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"
    }
}

将档案导入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 任务状态代码。枚举值: SucceededFailedInProgress 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检索的检索类型。枚举值: ExpeditedStandardBulk String
{
    "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"
}

从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 任务状态代码。枚举值: SucceededFailedInProgress 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
{
    "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"
}