跳转到主要内容
GET
https://api.ppinfra.com
/
gpu-instance
/
openapi
/
v1
/
jobs
查询任务列表
curl --request GET \
  --url https://api.ppinfra.com/gpu-instance/openapi/v1/jobs \
  --header 'Authorization: <authorization>'
{
  "jobs": [
    {
      "Id": "<string>",
      "user": "<string>",
      "type": "<string>",
      "envs": [
        {}
      ],
      "state": {
        "state": "<string>",
        "error": "<string>",
        "errorMessage": "<string>"
      },
      "logAddress": "<string>",
      "createdAt": "<string>",
      "instanceId": "<string>"
    }
  ],
  "total": 123
}

​
请求头

​
Authorization
string
必填
Bearer 身份验证格式，例如：Bearer {{API 密钥}}。

​
查询参数

​
pageSize
integer
获取 x 条/页。整数，取值范围：大于等于 0。
​
pageNum
integer
获取第 x 页。整数，取值范围：大于等于 0。
​
jobId
string
过滤任务 ID。字符串，长度限制：0-255 字符。
​
type
string
过滤任务类型。可选值：
  • saveImage：保存镜像
  • instanceMigrate：实例迁移
  • autoInstanceMigrate：实例自动迁移
​
state
string
过滤任务状态。可选值：
  • pulling：准备中
  • running：运行中
  • fail：失败
  • success：成功
  • break：中断
​
startTime
integer
查询开始时间戳，单位秒。取值范围：大于等于 0，默认：0。
​
endTime
integer
查询截止时间戳，单位秒。取值范围：大于等于 0，默认：0。
​
creators
string
过滤任务创建人 ID。字符串，长度限制：0-255 字符。

​
响应参数

​
jobs
object[]
必填
任务列表。
​
total
integer
必填
当前任务总数。

​
示例

​
请求示例

curl --location --request GET 'https://api.ppinfra.com/gpu-instance/openapi/v1/jobs?pageSize=5&pageNum=1&jobId&type&state&startTime&endTime&creators' \
--header 'Authorization: Bearer {{API 密钥}}'

​
响应示例

{
  "jobs": [
    {
      "Id": "osjl7wr6my1vuefg",
      "user": "xxx",
      "type": "saveImage",
      "envs": [],
      "state": {
        "state": "break",
        "error": "",
        "errorMessage": ""
      },
      "logAddress": "https://osjl7wr6my1vuefg-xxxxxx/job",
      "createdAt": "1755052230",
      "instanceId": "6334d0f2c779ae1d"
    }
  ],
  "total": 56
}