批量任务列表

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListBatchTask

系统规定参数。取值:ListBatchTask。

PageNumber Long 1

当前页数

PageSize Long 10

分页大小

ClientToken String C86D03D1-253E-4462-A4B1-195F945BCEEB

幂等Token

BatchTaskType String 1

批量任务类型(1. OSS方式 2. 文件方式)

Status String 1

任务状态(0. 排队中 1. 处理中(meta文件解析中) 2. 已完成 3. 失败 4. 部分失败 5. 处理中(子任务处理中))

InstanceId String vs-abcabc***abc

任务所属实例名称

BucketName String testBucket

筛选条件(OSS Bucket)

DataPath String testPath

筛选条件(数据路径)

RegionId String cn-hangzhou

区域(非必传)

返回数据

名称 类型 示例值 描述
Data Struct

返回结果

Count Long 1007

任务总数

List Array of BatchTask

当前页数据

Arn String xxx

授权参数

BucketName String bucket名称

OSS任务的bucketName参数

DataPath String 数据路径

OSS任务中的数据路径参数

MetaFile String 元数据文件名

OSS任务中的元数据文件名

ModifiedTime Long 1618396147

任务最后修改时间

ProcessMessage String http://mult***re.oss-cn-hangzhou.aliyuncs.com/batchProcessMessage//1989587002255388/096cae3e-5a0e-4cb6-9f07-9d9cb81f9b95?Expires=1601449075&OSSAccessKeyId=LTAI4Fsi******Y7maLLvP&Signature=jdbmaJ2rKY5%2B*****2h6E8U0%3D

处理结果url

RegionId String cn-hangzhou

区域

Status Integer 2

任务状态(0. 排队中 1. 处理中(meta文件解析中) 2. 已完成 3. 失败 4. 部分失败 5. 处理中(子任务处理中))

SubTaskDetail String http://xxx

子任务详情地址

TaskId String 10876

批量任务id

TaskType Integer 1

任务类型(1. OSS方式 2. 文件方式)

PageNumber Long 1

当前页数

PageSize Long 10

分页大小

RequestId String C86D03D1-253E-4462-A4B1-195F945BCEEB

请求id

示例

请求示例

http(s)://[Endpoint]/?Action=ListBatchTask
&<公共请求参数>

正常返回示例

XML格式

<RequestId>C86D03D1-253E-4462-A4B1-195F945BCEEB</RequestId>
<Data>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <List>
        <Status>2</Status>
        <BucketName>bucket名称</BucketName>
        <TaskId>10876</TaskId>
        <ModifiedTime>2020-09-15 13:40:01</ModifiedTime>
        <DataPath>数据路径</DataPath>
        <TaskType>1</TaskType>
        <ProcessMessage>http://mult***re.oss-cn-hangzhou.aliyuncs.com/batchProcessMessage//1989587002255388/096cae3e-5a0e-4cb6-9f07-9d9cb81f9b95?Expires=1601449075&amp;OSSAccessKeyId=LTAI4Fsi******Y7maLLvP&amp;Signature=jdbmaJ2rKY5%2B*****2h6E8U0%3D</ProcessMessage>
        <MetaFile>元数据文件名</MetaFile>
        <RegionId>cn-hangzhou</RegionId>
    </List>
    <Count>1007</Count>
</Data>

JSON格式

{
    "RequestId": "C86D03D1-253E-4462-A4B1-195F945BCEEB",
    "Data": {
        "PageSize": 10,
        "PageNumber": 1,
        "List": {
            "Status": 2,
            "BucketName": "bucket名称",
            "TaskId": 10876,
            "ModifiedTime": "2020-09-15 13:40:01",
            "DataPath": "数据路径",
            "TaskType": 1,
            "ProcessMessage": "http://mult***re.oss-cn-hangzhou.aliyuncs.com/batchProcessMessage//1989587002255388/096cae3e-5a0e-4cb6-9f07-9d9cb81f9b95?Expires=1601449075&amp;OSSAccessKeyId=LTAI4Fsi******Y7maLLvP&amp;Signature=jdbmaJ2rKY5%2B*****2h6E8U0%3D",
            "MetaFile": "元数据文件名",
            "RegionId": "cn-hangzhou"
        },
        "Count": 1007
    }
}

错误码

HttpCode 错误码 错误信息 描述
400 Duplicate.TagKey The Tag.N.Key contains duplicate keys. 标签key重复
403 ForBidden You are not authorized to perform the operation. 无权限,请求被拒绝
400 InvalidInstanceStatus The status of the instance %s is invalid. 实例状态无效,不能用于处理任务
400 InvalidParameter.%s The specified parameter %s is invalid. 参数无效
400 InvalidParameterList You must specify the parameter %s. 缺少参数
400 InvalidTagCount The maximum number of tags is exceeded. 标签个数过多
400 InvalidTagKey.Malformed The specified Tag.N.Value is not valid. 无效的标签key
400 InvalidTagValue.Malformed The specified Tag.N.Value is not valid. 无效的标签值
401 ServiceNotOpened The service is not activated. 服务未开通
500 SystemError An error occurred while processing your request. 系统异常
401 Unauthorized You are not authorized to perform the operation. 没有访问权限

访问错误中心查看更多错误码。

访问错误中心查看更多错误码。