全部文档
当前文档

热搜词推荐

云服务器 虚拟私有网络 边缘节点计算 对等连接

共搜索到 0 条结果

暂无内容

如果没有找到您期望的内容，请尝试其他搜索词

文档中心

对象存储(KS3)

查看更多结果
未找到含当前关键字的文档标题
页面目录
全部展开全部收起
未找到含该关键词的产品
文档中心 对象存储(KS3) API文档 批量处理 DescribeJob

DescribeJob

最近更新时间：2025-07-25 18:55:49

该接口用于获取单个指定批量处理任务详情，包括批量处理配置信息和任务执行进度。

权限描述

使用该接口的用户，必须是主账号或具有ks3:DescribeJob权限。

请求

请求示例

GET /?jobs&jobId=184ce261-18af-5e3d-3e30-253723cfd937 HTTP/1.1
Host: ks3-cn-beijing.ksyuncs.com
Date: {date}
Authorization: {SignatureValue}

请求参数

参数

描述

是否必选

jobId

任务ID。

每个任务对应唯一的任务ID，创建批量处理任务（CreateJob）成功后，KS3会返回任务ID。

是

请求头

该接口仅使用公共请求头。

请求体

该接口不使用请求体。

响应

响应头

该接口仅返回公共响应头部。

响应体

响应体为一段描述批量处理任务具体信息的XML：

<DescribeJobResult>
    <JobId>string</JobId>
    <CreationTime>string</CreationTime>
    <Description>string</Description>
    <Status>string</Status>
    <Manifest>
        <Location>
            <Filter>
                <Bucket>krn:ksc:ks3:::bucket1</Bucket>
                <Prefix>string</Prefix>
                <Prefix>string</Prefix>
            </Filter>
            <Filter>
                <Bucket>krn:ksc:ks3:::bucket2</Bucket>
                <Prefix>string</Prefix>
                <Prefix>string</Prefix>
            </Filter>
        </Location>
        <Spec>
            <Format>KS3BatchOperations_Bucket_V1</Format>
        </Spec>
    </Manifest>
    <Operation>
        <KS3RestoreObject>
            <StorageClass>string</StorageClass>
            <Days>Integer</Days>
        </KS3RestoreObject>
    </Operation>
    <Priority>integer</Priority>
    <ProgressSummary>
        <TotalNumberOfTasks>integer</TotalNumberOfTasks>
        <NumberOfTasksFailed>integer</NumberOfTasksFailed>
        <NumberOfTasksSucceeded>integer</NumberOfTasksSucceeded>
    </ProgressSummary>
    <Report>
        <Enabled>boolean</Enabled>
        <Bucket>string</Bucket>
        <Prefix>string</Prefix>
        <ReportScope>string</ReportScope>
    </Report>
    <TerminationDate>string</TerminationDate>
</DescribeJobResult>

响应体内具体元素描述如下所示：

名称

描述

DescribeJobResult

包含批量处理规则信息的容器。

  • 类型：容器

  • 父节点：无

JobId

任务ID。规则创建成功后，KS3会自动返回该参数，每个规则对应唯一的任务ID。

  • 类型：String

  • 父节点：DescribeJobResult

CreationTime

任务创建时间。

  • 类型：String

  • 父节点：DescribeJobResult

采用ISO 8601日期和时间表示法，示例：2024-08-17T17:04:52Z，加8小时表示中国北京时间。

Description

任务描述。

  • 类型：String

  • 父节点：DescribeJobResult

Status

任务执行的当前状态。合法参数值包括：New、Active、Complete。

  • 类型：String

  • 父节点：DescribeJobResult

New：批量处理任务刚被创建，任务正在解析中。

Active：批量操作任务进行中。

Complete：批量操作任务已完成，处于最终状态。

Manifest

待处理的文件信息。

  • 类型：容器

  • 父节点：DescribeJobResult

Location

待处理的文件位置信息。

  • 类型：容器

  • 父节点：Manifest

Filter

指定需要进行批量操作的桶或前缀。

  • 类型：容器

  • 父节点：Location

Bucket

指定需要进行批量操作桶的资源标识符。

  • 类型：String

  • 父节点：Filter

  • 示例值：krn:ksc:ks3:::examplebucket

Prefix

指定需要进行批量操作的前缀。

  • 类型：String

  • 父节点：Filter

Prefix参数值设置为空，表示对桶内的全部文件进行批量操作。

Spec

描述待处理文件列表的格式信息。

  • 类型：容器

  • 父节点：Manifest

Format

指定待处理文件列表的格式信息。固定取值：KS3BatchOperations_Bucket_V1。

  • 类型：String

  • 父节点：Spec

Operation

具体操作。支持批量解冻、批量修改ACL、批量删除操作。

  • 类型：容器

  • 父节点：DescribeJobResult

KS3RestoreObject

对归档类型文件批量执行解冻操作的具体参数。

  • 类型：容器

  • 父节点：Operation

StorageClass

表示需要解冻的存储类型。

  • 可选值：ARCHIVE

  • 类型：String

  • 父节点：KS3RestoreObject

Days

设置解冻持续时间。

  • 可选值：1-7的整数

  • 类型：Int

  • 父节点：KS3RestoreObject

KS3PutObjectAcl

批量设置ACL的具体参数。

  • 类型：容器

  • 父节点：Operation

CannedAccessControlList

预定义ACL，针对所有用户生效。

  • 取值：private、public-read

  • 类型：String

  • 父节点：KS3PutObjectAcl

1. 设置为private表示只有文件的拥有者可以对该文件进行读写操作，其他人无法访问该文件。

2. 设置为public-read表示任何人（包括匿名访问者）都可以对该文件进行读操作。

AccessControlList

针对指定用户设置ACL权限。

  • 类型：容器

  • 父节点：KS3PutObjectAcl

Grant

包含被授权者和其ACL信息。

  • 类型：容器

  • 父节点：AccessControlList

Grantee

被授权者的账号（UID）信息。

  • 类型：String

  • 父节点：Grant

Permission

指明授予被授权者的权限信息。

  • 取值：FULL_CONTROL、READ

  • 类型：String

  • 父节点：Grant

1. FULL_CONTROL表示被授权者具有对文件的读写权限。

2. READ表示被授权者具有对文件的只读权限。

KS3DeleteObject

对文件批量执行删除操作的具体参数。

  • 父节点：Operation

Priority

任务优先级。取值越大表示任务执行的优先级越高。

  • 取值范围：0-2147483647

  • 类型：Int

  • 父节点：DescribeJobResult

ProgressSummary

任务执行状况概述。描述该批量处理任务中所执行的操作总数，成功的操作数量以及失败的操作数量。

  • 类型：容器

  • 父节点：DescribeJobResult

TotalNumberOfTasks

总操作数。

  • 类型：Long

  • 父节点：ProgressSummary

NumberOfTasksFailed

当前失败的操作数。

  • 类型：Long

  • 父节点：ProgressSummary

NumberOfTasksSucceeded

当前成功的操作数。

  • 类型：Long

  • 父节点：ProgressSummary

Report

任务完成报告。仅支持导出操作失败列表报告。

  • 类型：容器

  • 父节点：DescribeJobResult

有关任务完成报告的详细内容，请参见文档：批量处理。

Enabled

是否输出任务完成报告。

  • 取值：true、false

  • 类型：Boolean

  • 父节点：Report

取值为true表示输出任务完成报告，取值为false表示不输出任务完成报告。

Bucket

任务完成报告的投递存储桶。

  • 类型：String

  • 父节点：Report

Prefix

任务完成报告投递的前缀信息。

  • 类型：String

  • 父节点：Report

ReportScope

任务完成报告内容类型。

  • 取值：固定取值FailedTasksOnly

  • 类型：String

  • 父节点：Report

TerminationDate

任务终止的时间。

  • 类型：String

  • 父节点：DescribeJobResult

采用ISO 8601日期和时间表示法，示例：2024-08-17T17:04:52Z，加8小时表示中国北京时间。

示例

请求示例

GET /?jobs&jobId=184ce261-18af-5e3d-3e30-253723cfd937 HTTP/1.1
Host: ks3-cn-beijing.ksyuncs.com
Date: Wed, 01 Mar 2025 12:00:00 GMT
Authorization: authorization string

响应示例

HTTP/1.1 200 OK
x-kss-request-id: 56594298207FB3044385****
Date: Wed, 01 Mar 2025 12:00:00 GMT
Server: ks3
Content-Length: length

<DescribeJobResult>
    <JobId>184ce261-18af-5e3d-3e30-253723cfd937</JobId>
    <CreationTime>2025-04-17T16:04:52Z</CreationTime>
    <Description>myjob</Description>
    <Status>Complete</Status>
    <Manifest>
        <Location>
            <Filter>
                <Bucket>krn:ksc:ks3:::bucket1</Bucket>
                <Prefix>Prefix1</Prefix>
                <Prefix>Prefix2</Prefix>
            </Filter>
            <Filter>
                <Bucket>krn:ksc:ks3:::bucket2</Bucket>
                <Prefix>Prefix1</Prefix>
                <Prefix>Prefix2</Prefix>
            </Filter>
        </Location>
        <Spec>
            <Format>KS3BatchOperations_Bucket_V1</Format>
        </Spec>
    </Manifest>
    <Operation>
        <KS3RestoreObject>
            <StorageClass>ARCHIVE</StorageClass>
            <Days>2</Days>
        </KS3RestoreObject>
    </Operation>
    <Priority>1</Priority>
    <ProgressSummary>
        <TotalNumberOfTasks>1000</TotalNumberOfTasks>
        <NumberOfTasksFailed>0</NumberOfTasksFailed>
        <NumberOfTasksSucceeded>1000</NumberOfTasksSucceeded>
    </ProgressSummary>
    <Report>
        <Enabled>true</Enabled>
        <Bucket>krn:ksc:ks3:::bucket</Bucket>
        <Prefix>job-result</Prefix>
        <ReportScope>FailedTasksOnly</ReportScope>
    </Report>
    <TerminationDate>2025-04-17T17:04:52Z</TerminationDate>
</DescribeJobResult>

错误码

状态码（Status）

错误码（Code）

描述

404

NoSuchJob

指定任务不存在

400

InvalidRequest

请求不合法

文档导读
上一篇：CreateJob
下一篇：ListJobs
纯净模式常规模式

纯净模式

点击可全屏预览文档内容
文档反馈