Yandex.Cloud
  • Сервисы
  • Почему Yandex.Cloud
  • Сообщество
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Yandex Certificate Manager
  • Начало работы
  • Пошаговые инструкции
    • Все инструкции
    • Сертификат от Let's Encrypt®
      • Создание сертификата
      • Получение содержимого сертификата
      • Прохождение процедуры проверки прав на домен
      • Обновление сертификата
      • Изменение сертификата
      • Удаление сертификата
    • Пользовательский сертификат
      • Создание сертификата
      • Получение содержимого сертификата
      • Обновление сертификата
      • Изменение сертификата
      • Удаление сертификата
    • Домен
      • Создание домена
      • Обновление сертификата у домена
      • Изменение домена
      • Удаление домена
    • Резервное копирование
    • Добавление алерта для сертификата
  • Концепции
    • Обзор
    • Сертификат от Let's Encrypt®
    • Пользовательский сертификат
    • Проверка прав на домен
    • Интеграция с сервисами Yandex.Cloud
    • Квоты и лимиты
    • Домен
      • Обзор
      • Интеграция с сервисами Yandex.Cloud
  • Управление доступом
  • Правила тарификации
  • Справочник API
    • Аутентификация в API
    • gRPC
      • Обзор
      • CertificateContentService
      • CertificateService
      • OperationService
    • REST
      • Обзор
      • Certificate
        • Обзор
        • create
        • delete
        • get
        • list
        • listAccessBindings
        • listOperations
        • requestNew
        • setAccessBindings
        • update
        • updateAccessBindings
      • CertificateContent
        • Обзор
        • get
  • Вопросы и ответы
  1. Справочник API
  2. REST
  3. Certificate
  4. get

Метод get

  • HTTP-запрос
  • Path-параметры
  • Query-параметры
  • Ответ

Возвращает информацию об указанном сертификате.

Чтобы получить список доступных сертификатов, используйте запрос list.

HTTP-запрос

GET https://certificate-manager.api.cloud.yandex.net/certificate-manager/v1/certificates/{certificateId}

Path-параметры

Параметр Описание
certificateId Обязательное поле. Идентификатор возвращаемого сертификата. Чтобы получить идентификатор сертификата, используйте запрос list. Максимальная длина строки в символах — 50.

Query-параметры

Параметр Описание
view Тип вывода сертификата.
  • BASIC: Вывод основной информации о сертификате.
  • FULL: Вывод полной информации о сертификате, включающей данные для прохождения процедуры проверки прав владения доменом.

Ответ

HTTP Code: 200 - OK

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "type": "string",
  "domains": [
    "string"
  ],
  "status": "string",
  "issuer": "string",
  "subject": "string",
  "serial": "string",
  "updatedAt": "string",
  "issuedAt": "string",
  "notAfter": "string",
  "notBefore": "string",
  "challenges": [
    {
      "domain": "string",
      "type": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "status": "string",
      "message": "string",
      "error": "string",

      // `challenges[]` включает только одно из полей `dnsChallenge`, `httpChallenge`
      "dnsChallenge": {
        "name": "string",
        "type": "string",
        "value": "string"
      },
      "httpChallenge": {
        "url": "string",
        "content": "string"
      },
      // конец списка возможных полей`challenges[]`

    }
  ]
}

Сертификат. Подробнее об этом читайте в документации.

Поле Описание
id string

Идентификатор сертификата. Генерируется при создании.

folderId string

Идентификатор каталога, которому принадлежит сертификат.

createdAt string (date-time)

Время создания ресурса.

Строка в формате RFC3339.

name string

Имя сертификата. Имя должно быть уникальным в каталоге.

description string

Описание сертификата.

labels object

Метки ресурса в формате ключ:значение.

type string

Тип сертификата.

Поддерживаемые типы сертификатов.

  • IMPORTED: Сертификат импортирован пользователем.
  • MANAGED: Сертификат создан сервисом.
domains[] string

Полные доменные имена сертификата.

status string

Статус сертификата.

  • VALIDATING: Требуется проверка доменов сертификатов. Используется только для сертификатов от Let's Encrypt®.
  • INVALID: Выдача сертификата не удалась. Используется только для сертификатов от Let's Encrypt®.
  • ISSUED: Сертификат выдан.
  • REVOKED: Сертификат отозван или аннулирован.
  • RENEWING: Сертификат обновляется. Используется только для сертификатов от Let's Encrypt®.
  • RENEWAL_FAILED: Обновление сертификата не удалось. Используется только для сертификатов от Let's Encrypt®.
issuer string

Уникальное имя Distinguished Name центра сертификации, выпустившего сертификат.

subject string

Уникальное имя Distinguished Name сущности, связанной с открытым ключом, содержащимся в сертификате.

serial string

Серийный номер сертификата.

updatedAt string (date-time)

Время последнего изменения сертификата.

Строка в формате RFC3339.

issuedAt string (date-time)

Время выдачи сертификата.

Строка в формате RFC3339.

notAfter string (date-time)

Время, по истечении которого сертификат считается недействительным.

Строка в формате RFC3339.

notBefore string (date-time)

Время, после наступления которого сертификат считается действительным.

Строка в формате RFC3339.

challenges[] object

Процедура проверки домена.

challenges[].
domain
string

Домен, права на владение которым проверяются.

challenges[].
type
string
Тип процедуры проверки.

Поддерживаемые типы проверки домена.

  • DNS: Тип проверки домена, использующий DNS-записи.
  • HTTP: Тип проверки домена, использующий HTTP-файлы.
challenges[].
createdAt
string (date-time)

Время, когда была начата процедура проверки.

Строка в формате RFC3339.

challenges[].
updatedAt
string (date-time)

Время последней проверки.

Строка в формате RFC3339.

challenges[].
status
string
Статус процедуры проверки.
  • PENDING: Процедура проверки ждет, пока пользователь выполнит действия, необходимые для прохождения проверки.
  • PROCESSING: Процедура проверки ожидает одобрения от Let's Encrypt®.
  • VALID: Процедура проверки пройдена.
  • INVALID: Проверка прав для определенного домена завершилась неудачно или истек недельный период, выделенный для проверки.
challenges[].
message
string

Описание процедуры проверки.

challenges[].
error
string

Ошибка процедуры проверки.

challenges[].
dnsChallenge
object
DNS-запись.
challenges[] включает только одно из полей dnsChallenge, httpChallenge

challenges[].
dnsChallenge.
name
string

Имя DNS-записи.

challenges[].
dnsChallenge.
type
string

Тип DNS-записи.

challenges[].
dnsChallenge.
value
string

Значение DNS-записи.

challenges[].
httpChallenge
object
HTTP-файл.
challenges[] включает только одно из полей dnsChallenge, httpChallenge

challenges[].
httpChallenge.
url
string

Расположение HTTP-файла.

challenges[].
httpChallenge.
content
string

Содержимое HTTP-файла.

В этой статье:
  • HTTP-запрос
  • Path-параметры
  • Query-параметры
  • Ответ
Language
Вакансии
Политика конфиденциальности
Условия использования
© 2021 ООО «Яндекс.Облако»