Перейти к содержимому

10.Управление задачами

1. Запрос сведений о подзадаче

Адрес интерфейса: /v1/task/{jobId}

Метод запроса:GET

Тип данных запроса:application/json

Тип данных ответа:*/*,application/json

Поддерживаемая версия:v1.0.0

Описание интерфейса:

Запрос сведений о выполнении одной подзадачи

Параметры запроса:

Имя параметра Описание параметра Местоположение Обязательно ли Тип данных Описание
jobId jobId, возвращенный после вызова интерфейса path true string id задачи

Пример запроса, в фактическом запросе замените значения параметров:

POST "/openapi/v1/task/5d5d1e43226f4a348c883643696e045f"

Параметры ответа:

Имя параметра Описание параметра Тип Описание
code Код возврата integer(int32)
message Возвращаемое сообщение обработки string
result Возвращаемый объект данных object
  traceId Бизнес-ID string
  jobId ID задачи string
  message Описание результата выполнения string
  uuid UUID ресурса string
  sn sn string Операция с платой: возвращается при заявке на плату, создании контейнера, монтировании/размонтировании облачного диска и т. д.
methodDesc Тип задачи string
  method Название метода string
  armCardIp IP платы string Операции с контейнером: перезапуск, сброс, запуск, остановка, резервное копирование и другие операции на уровне контейнера будут возвращать
  status Код статуса задачи integer -1,0:ошибка выполнения;1:ожидание; 2:успешное выполнение; 3:в процессе; 4:отмена в процессе; 5:отменено
  data Конкретное содержимое выполнения object
    stdOut Вывод содержимого выполнения list
    stdErr Вывод исключения выполнения list
  beginTime Время начала задачи string
  endTime Время завершения задачи string
timestamp Временная метка integer(int64)

Пример ответа:

{
    "message": "操作成功!",
    "code": 200,
    "result": {
        "traceId": "C20250822151033726037",
        "jobId": "5169daa682384453a6c523572b4587e4",
        "methodDesc": "执行异步命令",
        "method": "InstanceCommandSync",
        "data": {
            "stdOut": [
                "/",
                ""
            ],
            "stdErr": [
                ""
            ]
        },
        "beginTime": "2025-08-22 15:10:33",
        "endTime": "2025-08-22 15:10:34",
        "message": "任务成功",
        "uuid": "qs-fs-pre-fmmjbdac7ye24o40",
        "status": 2,
        "armCardIp": "172.30.0.40"
    },
    "timestamp": 1755847993501
}

2. Запрос списка подзадач

Адрес интерфейса: /v1/task/list

Метод запроса:GET

Тип данных запроса:application/json

Тип данных ответа:*/*,application/json

Поддерживаемая версия:v1.0.0

Описание интерфейса:

Запрос списка подзадач для одной или нескольких пакетных задач (основных задач)

Параметры запроса:

Имя параметра Описание параметра Местоположение Обязательно ли Тип данных Описание
traceIds Список traceId, возвращенный после вызова интерфейса body true string
offset Начальная позиция запроса body false integer если не заполнено, по умолчанию 0
limit Количество записей за один запрос body false integer если не заполнено, по умолчанию 100

Пример запроса:

POST "/openapi/v1/task/list"
body:
{
    "offset": 0,
    "limit": 100,
    "traceIds": [
        "C20250822151034530048"
    ]
}

Параметры ответа:

Имя параметра Описание параметра Тип Описание
code Код возврата integer(int32)
message Возвращаемое сообщение обработки string
result Возвращаемый объект данных object
  jobs Объект задачи object
    jobId ID задачи string
    message Описание результата выполнения string
    uuid uuid ресурса string
    status Код состояния integer -1,0:ошибка выполнения;1:ожидание;2:успешное выполнение; 3:в процессе; 4:отмена в процессе; 5:отменено
methodDesc Тип задачи string
    method Название метода string
armCardIp IP платы string
    sn sn платы string
    data Конкретное содержимое выполнения object
      stdOut Вывод содержимого выполнения List
      stdErr Вывод исключения выполнения List
    beginTime Время начала задачи string
    endTime Время завершения задачи string
timestamp Временная метка запроса interger(int64)
traceId ID обработки запроса пакетной задачи string

Пример ответа:

{
  "message": "操作成功!",
  "code": 200,
  "result": [
    {
      "traceId": "C20250822151034530048",
      "jobs": [
        {
          "traceId": "C20250822151034530048",
          "jobId": "f58a02ab832845f99348b3d26b85330a",
          "methodDesc": "执行异步命令",
          "method": "InstanceCommandSync",
          "data": {
            "stdOut": [
              "/",
              ""
            ],
            "stdErr": [
              ""
            ]
          },
          "beginTime": "2025-08-22 15:10:34",
          "endTime": "2025-08-22 15:10:34",
          "message": "任务成功",
          "uuid": "qs-fs-pre-fmmjbdac7ye24o40",
          "status": 2,
          "armCardIp": "172.30.0.40"
        }
      ]
    }
  ],
  "timestamp": 1755846640915
}