You need to enable JavaScript to run this app.
文档中心
火山方舟

火山方舟

复制全文
下载 pdf
批量(Job) API
获取批量推理任务列表
复制全文
下载 pdf
获取批量推理任务列表
POST https://ark.cn-beijing.volcengineapi.com/?Action=ListBatchInferenceJobs&Version=2024-01-01​
获取批量推理任务列表。支持按标签、任务状态、模型等条件筛选,并支持分页和排序。​
说明​
支持按标签(TagFilters)、任务属性(Filter)筛选,并通过 PageNumber / PageSize 分页。排序字段支持 CreateTime / UpdateTime,排序顺序支持 Asc / Desc。​
鉴权​
本接口支持鉴权方式如下,详情请参见 Base URL 及鉴权。​
  • Access Key 鉴权,请在 Access Key 管理 页面,获取 Access Key。本接口仅支持 Access Key 鉴权。​
​​
请求参数​
Body 参数​
Filter object | 属性筛选​
​
PageNumber integer 默认值 1 | 起始页码​
​
PageSize integer 默认值 10 | 每页条数​
​
ProjectName string 默认值 default | 项目名称​
​
SortBy string | 排序字段​
​
SortOrder string | 排序顺序​
​
TagFilters object[] | 标签筛选​
​
​
响应参数​
Items object[] | 任务列表​
​
PageNumber integer | 页码​
​
PageSize integer | 每页条数​
​
TotalCount integer | 任务总数​
​
​

Request

curl 'https://ark.cn-beijing.volcengineapi.com/?Action=ListBatchInferenceJobs&Version=2024-01-01' \
  -H 'Content-Type: application/json' \
  -H 'X-Date: <X-Date>' \
  -H 'X-Content-Sha256: <X-Content-Sha256>' \
  -H 'Authorization: HMAC-SHA256 Credential=<AK>/<X-Date>/cn-beijing/ark/request, SignedHeaders=content-type;host;x-content-sha256;x-date, Signature=<Signature>' \
  -d '{
  "ProjectName": "default",
  "PageNumber": 1,
  "PageSize": 10,
  "SortOrder": "Desc",
  "SortBy": "CreateTime",
  "TagFilters": [
    {
      "Key": "owner",
      "Values": [
        "team-a"
      ]
    }
  ],
  "Filter": {
    "Ids": [
      "bi-20240918194641-r2nwq"
    ],
    "Name": "批量推理任务",
    "FoundationModels": [
      {
        "Name": "doubao-seed-2-0-pro",
        "ModelVersions": ["260215"]
      }
    ],
    "CustomModelIds": [],
    "Phases": [
      "Completed"
    ]
  }
}
'

Response

{
    "ResponseMetadata": {
        "RequestId": "2024091819503335D2321703C1A3CCA3",
        "Action": "ListBatchInferenceJobs",
        "Version": "2024-01-01",
        "Service": "ark",
        "Region": "cn-beijing"
    },
    "Result": {
        "TotalCount": 1,
        "PageNumber": 1,
        "PageSize": 10,
        "Items": [
            {
                "Id": "bi-20240918194641-r2nwq",
                "Name": "批量推理任务",
                "Description": "这是一个批量推理任务",
                "InputFileTosLocation": {
                    "BucketName": "my-bucket-name",
                    "ObjectKey": "batch-inference-job/dataset/my-job.jsonl"
                },
                "OutputDirTosLocation": {
                    "BucketName": "my-bucket-name",
                    "ObjectKey": "batch-inference-job/output/"
                },
                "CompletionWindow": "1d",
                "Status": {
                    "Phase": "Completed",
                    "PhaseTime": "2024-09-18T11:50:00Z",
                    "Message": "批量推理任务已完成"
                },
                "ModelReference": {
                    "FoundationModel": {
                        "Name": "doubao-seed-2-0-pro",
                        "ModelVersion": "260215"
                    }
                },
                "RequestCounts": {
                    "Total": 2,
                    "Completed": 2,
                    "Failed": 0
                },
                "Tags": [
                    {
                        "Key": "owner",
                        "Value": "team-a"
                    },
                    {
                        "Key": "test_key",
                        "Value": "test_value"
                    }
                ],
                "ProjectName": "default",
                "CreateTime": "2024-09-18T11:46:41Z",
                "UpdateTime": "2024-09-18T11:50:00Z",
                "ExpireTime": "2024-09-19T11:46:41Z"
            }
        ]
    }
}
最近更新时间:2026.09.04 20:18:47
这个页面对您有帮助吗?
有用
有用
无用
无用