Поделиться через

Псевдонимы списка (предварительная версия REST API)

применимо к: 2023-07-01-Preview. Эта версия больше не поддерживается. немедленное обновление до более новой версии.

Важный

2023-07-01-Preview (без изменений).

2021-04-30-Preview добавляет API.

Операция псевдонимов списка возвращает список псевдонимов в службе поиска ИИ Azure.

GET https://[service name].search.windows.net/aliases?api-version=[api-version]      
  Content-Type: application/json  
  api-key: [admin key]

Параметры URI

Параметр Описание
Имя службы Обязательно. Задайте для этого уникальное, определяемое пользователем имя службы поиска.
версия API Обязательно. Дополнительные версии API см. в версиях API.

Заголовки запросов

В следующей таблице описаны обязательные и необязательные заголовки запросов.

Поля Описание
Тип контента Обязательно. Задайте для этого значение application/json
api-key Необязательно, если вы используете роли Azure и маркер носителя предоставляется в запросе, в противном случае требуется ключ. Ключ API — это уникальная, созданная системой строка, которая проверяет подлинность запроса в службе поиска. Запросы к службе поиска должны содержать заголовок api-key, заданный для ключа администратора (в отличие от ключа запроса). Дополнительные сведения см. в статье Connect to Azure AI Search using key authentication.

Текст запроса

Никакой.

Ответ

Для успешного запроса: 200 OK. Ниже приведен пример текста ответа:

    {  
      "value" : [  
        {  
          "name": "my-alias",  
          "indexes": [
                "my-index"
            ]
        }]  
    }

Вы можете отфильтровать ответ до только интересующих вас свойств. Например, если требуется только список имен псевдонимов, используйте параметр запроса OData выбрать параметр запроса:

GET https://[service name].search.windows.net/aliases?api-version=[api-version]&$select=name
api-key: [admin key]

В этом случае ответ из приведенного выше примера будет выглядеть следующим образом:

    {  
      "value" : [ { "name": "my-alias" }, ... ]  
    }

См. также