> ## Documentation Index
> Fetch the complete documentation index at: https://ppio.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 查询任务列表

## 请求头

<ParamField header="Authorization" type="string" required={true}>
  Bearer 身份验证格式，例如：Bearer \{\{API 密钥}}。
</ParamField>

## 查询参数

<ParamField query="pageSize" type="integer" required={false}>
  获取 x 条/页。整数，取值范围：大于等于 0。
</ParamField>

<ParamField query="pageNum" type="integer" required={false}>
  获取第 x 页。整数，取值范围：大于等于 0。
</ParamField>

<ParamField query="jobId" type="string" required={false}>
  过滤任务 ID。字符串，长度限制：0-255 字符。
</ParamField>

<ParamField query="type" type="string" required={false}>
  过滤任务类型。可选值：

  * `saveImage`：保存镜像
  * `instanceMigrate`：实例迁移
  * `autoInstanceMigrate`：实例自动迁移
</ParamField>

<ParamField query="state" type="string" required={false}>
  过滤任务状态。可选值：

  * `pulling`：准备中
  * `running`：运行中
  * `fail`：失败
  * `success`：成功
  * `break`：中断
</ParamField>

<ParamField query="startTime" type="integer" required={false}>
  查询开始时间戳，单位秒。取值范围：大于等于 0，默认：0。
</ParamField>

<ParamField query="endTime" type="integer" required={false}>
  查询截止时间戳，单位秒。取值范围：大于等于 0，默认：0。
</ParamField>

<ParamField query="creators" type="string" required={false}>
  过滤任务创建人 ID。字符串，长度限制：0-255 字符。
</ParamField>

## 响应参数

<ResponseField name="jobs" type="object[]" required={true}>
  任务列表。

  <Expandable title="properties" defaultOpen={true}>
    <ResponseField name="Id" type="string" required={true}>
      任务 ID。
    </ResponseField>

    <ResponseField name="user" type="string" required={true}>
      发起该任务的用户 ID。
    </ResponseField>

    <ResponseField name="type" type="string" required={true}>
      任务类型。可选值：`saveImage`、`instanceMigrate`、`autoInstanceMigrate`。
    </ResponseField>

    <ResponseField name="envs" type="object[]" required={false}>
      执行任务的环境变量配置。
    </ResponseField>

    <ResponseField name="state" type="object" required={true}>
      当前任务状态信息。

      <Expandable title="properties" defaultOpen={true}>
        <ResponseField name="state" type="string" required={true}>
          当前任务状态。可选值：`pulling`、`running`、`fail`、`success`、`break`。
        </ResponseField>

        <ResponseField name="error" type="string" required={false}>
          错误代码（如有）。
        </ResponseField>

        <ResponseField name="errorMessage" type="string" required={false}>
          错误描述（如有）。
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="logAddress" type="string" required={false}>
      日志访问地址，可查看任务执行日志。
    </ResponseField>

    <ResponseField name="createdAt" type="string" required={true}>
      任务创建时间（Unix 时间戳，单位秒）。
    </ResponseField>

    <ResponseField name="instanceId" type="string" required={true}>
      任务执行时关联的实例 ID。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="total" type="integer" required={true}>
  当前任务总数。
</ResponseField>

## 示例

### 请求示例

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

### 响应示例

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