ListBatchInferenceJobs - 获取批量推理任务列表--火山方舟大模型服务平台-火山引擎

文档中心

立即注册

导航

ListBatchInferenceJobs - 获取批量推理任务列表

最近更新时间：2025.01.15 18:47:47首次发布时间：2024.09.29 10:33:19

获取批量推理任务列表

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ListBatchInferenceJobs	要执行的操作，取值：ListBatchInferenceJobs。
Version	String	是	2024-01-01	API的版本，取值：2024-01-01。
ProjectName	String	否	-	项目名称
PageNumber	Integer	否	-	分页查询时的起始页码，从 1 开始，默认为 1
PageSize	Integer	否	10	分页查询时每页显示的记录数，取值： - 最小值：1 - 最大值：100 - 默认值：10
SortOrder	String	否	-	指定排序顺序。可指定值: - Asc：升序排列 - Desc: 降序排列
SortBy	String	否	CreateTime	指定排序指标。可指定值: * CreateTime：创建时间 * UpdateTime：更新时间
TagFilters	Array of Object	否	-	基于绑定的标签的筛选条件
Filter	Object	否	-	带查询批量推理任务的筛选条件

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
TotalCount	Integer	-	批量推理任务数量
PageNumber	Integer	1	分页查询时的起始页码，从 1 开始，默认为 1。
PageSize	Integer	10	分页查询时每页显示的记录数，取值： - 最小值：1 - 最大值：100 - 默认值：10
Items	Array of Object	-	批量推理任务数组

请求示例

POST /?Action=ListBatchInferenceJobs&Version=2024-01-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250115T095231Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250115/cn-beijing/ark/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "ProjectName": "\\-",
  "PageNumber": 0,
  "PageSize": 10,
  "SortOrder": "\\-",
  "SortBy": "CreateTime",
  "TagFilters": [
    {
      "Key": "4e74qI",
      "Values": [
        "oEG"
      ]
    }
  ],
  "Filter": {
    "Ids": [
      "PhiQsNAH3Z"
    ],
    "Name": "Sy0pz",
    "FoundationModels": [
      {
        "Name": "jWyMB1c9ar",
        "ModelVersions": [
          "l"
        ]
      }
    ],
    "CustomModelIds": [
      "8iwBx"
    ],
    "Phases": [
      "f5yt"
    ]
  }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024091819503335D2321703C1A3CCA381",
        "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-pro-32k",
                        "ModelVersion": "240615"
                    }
                },
                "RequestCounts": {
                    "Total": 2,
                    "Completed": 2,
                    "Failed": 0
                },
                "Tags": [
                    {
                        "Key": "sys:ark:createdBy",
                        "Value": "IAMUser/30805480/test@bytedance.com"
                    },
                    {
                        "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"
            }
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。