Feature State - Get States Preview

Применимо к: Ценовая категория S1.
Этот API возвращает сведения о текущем состоянии, связанные с данным компонентом в заданном состоянии.

GET https://atlas.microsoft.com/featureState/state?api-version=1.0&statesetId={statesetId}&featureId={featureId}
GET https://atlas.microsoft.com/featureState/state?subscription-key={subscription-key}&api-version=1.0&statesetId={statesetId}&featureId={featureId}

Параметры URI

Name In Required Type Description
api-version
query True
  • string

Номер версии Azure Maps API. Текущая версия — 1,0

featureId
query True
  • string

Идентификатор компонента в заданном наборе состояний. Если для Феатуреид в наборе состояний не было задано состояние, будет возвращен недопустимый ответ на запрос.

statesetId
query True
  • string

Идентификатор созданного состояния.

subscription-key
query
  • string

Один из Azure Maps ключей, предоставленных из учетной записи службы "схема Azure". Дополнительные сведения об управлении проверкой подлинности см. в этой статье .

Ответы

Name Type Description
200 OK

Запрос на получение успешно выполнен.

400 Bad Request

Недопустимый запрос: один или несколько параметров были неправильно указаны или являются взаимоисключающими.

401 Unauthorized

Отказано в доступе из-за недопустимого ключа подписки или токена носителя Azure Active Directory. Обязательно укажите допустимый ключ для активной подписки Azure и сопоставляет ресурс. В противном случае проверьте заголовок WWW-Authenticate для кода ошибки и описание предоставленного токена носителя AAD.

Headers

  • WWW-Authenticate: string
403 Forbidden

Проблемы с разрешением, емкостью или проверкой подлинности.

404 Not Found

Не найдено: не удалось найти запрошенный ресурс, но он может быть снова доступен в будущем.

500 Internal Server Error

При обработке этого запроса возникла ошибка. Повторите попытку позже.

Безопасность

azure_auth

Это Azure Active Directory потоки OAuth2 . В сочетании с контролем доступа на основе ролей Azure ее можно использовать для управления доступом к Azure Maps интерфейсам API. Элементы управления доступом на основе ролей Azure используются для обозначения доступа к одной или нескольким Azure Maps учетной записи ресурса или подресурсам. Любому пользователю, группе или субъекту-службе можно предоставить доступ через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений для Azure Maps интерфейсов API.

Для реализации сценариев рекомендуется просмотреть Основные понятия проверки подлинности. В целом это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, способных управлять доступом к конкретным интерфейсам API и областям.

Примечание

  • Это определение безопасности требует использования x-ms-client-id заголовка для указания того, какой Azure Maps ресурс, к которому приложение запрашивает доступ. Это можно получить с помощью API управления картами.
  • Authorization URLОтносится только к экземпляру общедоступного облака Azure. Облака независимых имеют уникальные URL-адреса авторизации и конфигурации Azure Active Directory.
  • Управление доступом на основе ролей Azure настраивается на плоскости управления Azure с помощью портал Azure, POWERSHELL, CLI, пакетов SDK для Azure или интерфейсов API.
  • Использование веб-пакета SDK Azure Maps позволяет настроить приложение на основе конфигурации для нескольких вариантов использования.
  • Сейчас поддерживаются маркеры Azure Active Directory v 1.0 .

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

subscription-key

Это общий ключ, который подготавливается при создании Azure Maps ресурса с помощью плоскости управления Azure с помощью портал Azure, POWERSHELL, CLI, пакетов SDK для Azure или интерфейсов API. С помощью этого ключа любое приложение имеет право доступа ко всем интерфейсам API-интерфейса RESTFUL. Другими словами, в настоящее время они могут рассматриваться как главные ключи для учетной записи, для которой они выдаются. Для общедоступных приложений мы рекомендуем использовать сервер для доступа к Azure Maps API-интерфейсам RESTFUL, где этот ключ можно безопасно хранить.

Type: apiKey
In: query

Примеры

Get the current states of a feature

Sample Request

GET https://atlas.microsoft.com/featureState/state?subscription-key=[subscription-key]&api-version=1.0&statesetId=b24bdb73-1305-3212-1909-a428d937b64&featureId=SPC4709

Sample Response

{
  "states": [
    {
      "keyName": "s1",
      "value": true,
      "eventTimestamp": "2019-08-16 13:01"
    }
  ]
}
{
  "error": {
    "code": "400 BadRequest",
    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
  }
}
{
  "error": {
    "code": "401 Unauthorized",
    "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
  }
}
{
  "error": {
    "code": "403 Forbidden",
    "message": "Permission, capacity, or authentication issues."
  }
}
{
  "error": {
    "code": "404 NotFound",
    "message": "Not Found: the requested resource could not be found, but it may be available again in the future."
  }
}
{
  "error": {
    "code": "500 InternalServerError",
    "message": "An error occurred while processing the request. Please try again later."
  }
}

Определения

FeatureStateObject

Модель состояния одного компонента.

FeatureStatesStructure

Модель состояний функций для компонента.

ODataError

Этот объект возвращается при возникновении ошибки в API Maps.

ODataErrorResponse

Этот объект ответа возвращается при возникновении ошибки в API Maps.

FeatureStateObject

Модель состояния одного компонента.

Name Type Description
eventTimestamp
  • string

Отметка времени записи состояния компонента.

keyName
  • string

KeyName состояние компонента.

value
  • object

Значение для состояния компонента.

FeatureStatesStructure

Модель состояний функций для компонента.

Name Type Description
states

Массив состояний компонентов.

ODataError

Этот объект возвращается при возникновении ошибки в API Maps.

Name Type Description
code
  • string

Код ODataError.

details

Этот объект возвращается при возникновении ошибки в API Maps.

message
  • string

Понятное текстовое описание ошибки, если оно доступно.

target
  • string

Если это возможно, целевой объект, вызвавший ошибку.

ODataErrorResponse

Этот объект ответа возвращается при возникновении ошибки в API Maps.

Name Type Description
error

Этот объект возвращается при возникновении ошибки в API Maps.