Обработка ошибок

При вызове метода возможно возникновение ошибок и предупреждений:

  • Ошибки, исключающие возможность выполнения запроса: неверный формат запроса (в том числе отсутствие обязательного параметра), неверный токен, недоступность сервера API и т. п.

  • Ошибки и предупреждения при выполнении операции с одним из объектов в запросе, которые не влияют на успешность выполнения операции с другими объектами. Подробно об ошибках операции читайте в разделе Операции над массивом объектов.

Коды и описания ошибок и предупреждений приведены в разделе Ошибки и предупреждения.

Примечание

Язык сообщений об ошибках определяется заголовком запроса Accept-Language.

Ошибки выполнения запроса

Если выполнение запроса невозможно, возвращается следующая структура:

<SOAP-ENV:Fault>
  <faultcode>SOAP-ENV:Client</faultcode>
  <faultstring>(string)</faultstring>
  <detail>
    <ns3:FaultResponse xmlns:ns3="http://direct.yandex.com/api/v5/general">
      <requestId>(string)</requestId>
      <errorCode>(int)</errorCode>
      <errorDetail>(string)</errorDetail>
    </ns3:FaultResponse>
  </detail>
</SOAP-ENV:Fault>

Параметр

Тип

Описание

Объект Fault

faultstring

string

Текст сообщения об ошибке.

detail

ApiExceptionMessage

Сведения об ошибке.

Объект ApiExceptionMessage

requestId

string

Уникальный идентификатор запроса, присвоенный сервером API Директа. Также передается в HTTP-заголовке RequestId.

errorCode

int

Числовой код ошибки.

errorDetail

string

Подробное описание ошибки.

{
  "error" : {
    "request_id": (string),
    "error_code": (int),
    "error_string": (string),
    "error_detail": (string)
  }
}

Параметр

Тип

Описание

request_id

string

Уникальный идентификатор запроса, присвоенный сервером API Директа. Также передается в HTTP-заголовке RequestId.

error_code

int

Числовой код ошибки.

error_string

string

Текст сообщения об ошибке.

error_detail

string

Подробное описание ошибки.

Предыдущая