Yandex Cloud
КейсыДокументация
ПрезентацияСвязаться с намиНачать бесплатно
Создавайте контент и получайте гранты!Готовы написать своё руководство? Участвуйте в контент-программе и получайте гранты на работу с облачными сервисами!
Подробнее о программе
Сделано на Gravity UI
Проект Яндекса
© 2026 ООО «Яндекс.Облако»
Yandex Managed Service for YDB
  • Начало работы
  • Управление доступом
      • Все методы
        • BatchGetItem
        • BatchWriteItem
        • CreateTable
        • DeleteItem
        • DeleteTable
        • DescribeTable
        • DescribeTimeToLive
        • GetItem
        • ListTables
        • PutItem
        • Query
        • Scan
        • TransactGetItems
        • TransactWriteItems
        • UpdateItem
        • UpdateTimeToLive
        • UpdateTable
    • Общие ошибки при работе с Document API
  • Метрики Monitoring
  • Аудитные логи Audit Trails
  • Вопросы и ответы
  • Публичные материалы
  • Обучающие курсы

В этой статье:

  • Запрос
  • Параметры
  • Ответ
  • Параметры
  • Ошибки
  1. Document API, совместимый с Amazon DynamoDB
  2. Справочник Document API
  3. Actions
  4. DescribeTable

Метод DescribeTable

Статья создана
Yandex Cloud
Обновлена 5 февраля 2024 г.
Открыть в Markdown
  • Запрос
    • Параметры
  • Ответ
    • Параметры
  • Ошибки

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

ЗапросЗапрос

Запрос содержит данные в формате JSON.

{
   "TableName": "string"
}

ПараметрыПараметры

Параметр Описание
TableName Имя таблицы, о которой запрашивается информация.
Может содержать путь в иерархии каталогов вида path/to/table.

Тип: Строка
Длина: 3 - 255 символов
Шаблон: [a-zA-Z0-9_.-]+
Обязательно: Да

ОтветОтвет

В случае успеха вернется HTTP с кодом 200.
Запрос возвращает данные в формате JSON.

{
   "Table": { 
      "AttributeDefinitions": [ 
         { 
            "AttributeName": "string",
            "AttributeType": "string"
         }
      ],
      "CreationDateTime": number,
      "ItemCount": number,
      "KeySchema": [ 
         { 
            "AttributeName": "string",
            "KeyType": "string"
         }
      ],
      "StreamSpecification": {
          "StreamEnabled": boolean,
          "StreamViewType": "string"
      },
      "TableName": "string",
      "TableSizeBytes": number,
      "TableStatus": "string"
   }
}

ПараметрыПараметры

Параметр Описание
Table Свойства таблицы.

Тип: объект типа TableDescription.

ОшибкиОшибки

Параметр Описание
InternalServerError Произошла внутренняя ошибка на стороне сервера.

Код состояния HTTP: 500
ResourceNotFoundException Указанная таблица не существует, или она еще создается методом createTable

Код состояния HTTP: 400

Также могут возникать Общие ошибки, одинаковые для всех методов.

Была ли статья полезна?

Предыдущая
DeleteTable
Следующая
DescribeTimeToLive
Создавайте контент и получайте гранты!Готовы написать своё руководство? Участвуйте в контент-программе и получайте гранты на работу с облачными сервисами!
Подробнее о программе
Сделано на Gravity UI
Проект Яндекса
© 2026 ООО «Яндекс.Облако»