› › ›

API синхронизации задач подключений

Данная функциональность находится в стадии бета-тестирования и может быть изменена. Дизайн и код менее зрелые, чем у официальных функций GA, и предоставляются как есть без каких-либо гарантий. Бета-функции не подпадают под SLA поддержки официальных функций GA.

Возвращает информацию обо всех сохраненных задачах синхронизации подключений, отсортированных по дате создания по возрастанию.

Чтобы начать работу с API подключений, ознакомьтесь с нашим учебным пособием.

Запрос

GET _connector/_sync_job

Предварительные условия

Для синхронизации данных с помощью собственных подключений, необходимо развернуть службу подключения Elastic на вашей собственной инфраструктуре. Эта служба автоматически запускается в Elastic Cloud для управляемых Elastic подключений.

Параметры пути

size: (Необязательно, целое число) Максимальное количество результатов для получения. По умолчанию равно 100.
from: (Необязательно, целое число) Смещение от первого результата для получения. По умолчанию равно 0.
status: (Необязательно, состояние задачи) Статус задачи для фильтрации результатов. Доступные статусы включают: canceling, canceled, completed, error, in_progress, pending, suspended.
connector_id: (Необязательно, строка) Идентификатор подключения, для которого необходимо получить задачи синхронизации.
job_type: (Необязательно, тип задачи) Запятой-разделенный список типов задач. Доступные типы задач: full, incremental и access_control.

Примеры

Следующий пример отображает все задачи синхронизации подключений:

resp = client.perform_request(
    "GET",
    "/_connector/_sync_job",
)
print(resp)

response = client.connector.sync_job_list
puts response

const response = await client.transport.request({
  method: "GET",
  path: "/_connector/_sync_job",
});
console.log(response);

GET _connector/_sync_job

Следующий пример отображает первые две задачи синхронизации подключений:

resp = client.perform_request(
    "GET",
    "/_connector/_sync_job",
    params={
        "from": "0",
        "size": "2"
    },
)
print(resp)

response = client.connector.sync_job_list(
  from: 0,
  size: 2
)
puts response

const response = await client.transport.request({
  method: "GET",
  path: "/_connector/_sync_job",
  querystring: {
    from: "0",
    size: "2",
  },
});
console.log(response);

GET _connector/_sync_job?from=0&size=2

Следующий пример отображает ожидающие задачи синхронизации подключений (по умолчанию первые 100):

resp = client.perform_request(
    "GET",
    "/_connector/_sync_job",
    params={
        "status": "pending"
    },
)
print(resp)

response = client.connector.sync_job_list(
  status: 'pending'
)
puts response

const response = await client.transport.request({
  method: "GET",
  path: "/_connector/_sync_job",
  querystring: {
    status: "pending",
  },
});
console.log(response);

GET _connector/_sync_job?status=pending

Следующий пример отображает задачи синхронизации подключений (по умолчанию первые 100) для подключения с идентификатором connector-1:

resp = client.perform_request(
    "GET",
    "/_connector/_sync_job",
    params={
        "connector_id": "connector-1"
    },
)
print(resp)

response = client.connector.sync_job_list(
  connector_id: 'connector-1'
)
puts response

const response = await client.transport.request({
  method: "GET",
  path: "/_connector/_sync_job",
  querystring: {
    connector_id: "connector-1",
  },
});
console.log(response);

GET _connector/_sync_job?connector_id=connector-1

Следующий пример отображает задачи синхронизации подключений (по умолчанию первые 100) для подключения с типом задачи full или incremental:

resp = client.perform_request(
    "GET",
    "/_connector/_sync_job",
    params={
        "job_type": "full,incremental"
    },
)
print(resp)

response = client.connector.sync_job_list(
  job_type: 'full,incremental'
)
puts response

const response = await client.transport.request({
  method: "GET",
  path: "/_connector/_sync_job",
  querystring: {
    job_type: "full,incremental",
  },
});
console.log(response);

GET _connector/_sync_job?job_type=full,incremental

Коды ответов

200: Указывает, что результаты были успешно возвращены (результаты также могут быть пустыми).

400: Указывает, что запрос имеет неправильный формат.

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/list-connector-sync-jobs-api.html