Timezone - Get Timezone By ID
Используется для получения информации о текущем, историческом и будущем часовом поясе для указанного идентификатора часового пояса IANA.
API Get Timezone By ID — это запрос HTTP GET, который возвращает текущие, исторические и будущие сведения часового пояса для указанного идентификатора часового пояса IANA.
GET {endpoint}/timezone/byId/json?api-version=1.0&query={query}
GET {endpoint}/timezone/byId/json?api-version=1.0&options={options}&timeStamp={timeStamp}&transitionsFrom={transitionsFrom}&transitionsYears={transitionsYears}&query={query}
Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
endpoint
|
path | True |
string |
|
|
format
|
path | True |
Требуемый формат ответа. Поддерживается только |
|
|
api-version
|
query | True |
string minLength: 1 |
Версия API, используемая для данной операции. |
|
query
|
query | True |
string |
Идентификатор часового пояса IANA. |
|
options
|
query |
Кроме того, используйте псевдоним "o". Параметры, доступные для типов сведений, возвращаемых в результате. |
||
|
time
|
query |
string (date-time) |
Кроме того, используйте псевдоним "stamp" или "s". Время ссылки, если опущено, API будет использовать время компьютера, обслуживая запрос. |
|
|
transitions
|
query |
string (date-time) |
Кроме того, используйте псевдоним "tf". Дата начала, из которой запрашиваются переходы с летнего времени (DST), применяется только при переходе "options" = all или "options". |
|
|
transitions
|
query |
integer (int32) |
Кроме того, используйте псевдоним "ty". Число лет от "transitionsFrom", для которого запрашиваются переходы DST, применяется только в том случае, если "параметры" = все или "параметры" = переходы. |
Заголовок запроса
| Имя | Обязательно | Тип | Описание |
|---|---|---|---|
| x-ms-client-id |
string |
Указывает аккаунт, предназначенный для использования с моделью безопасности Microsoft Entra ID. Этот уникальный идентификатор для Azure Maps аккаунта можно получить с управляющего плана Azure Maps Account API. Для получения дополнительной информации об использовании Microsoft Entra ID безопасности в Azure Maps см. раздел Управление аутентификацией в Azure Maps. |
|
| Accept-Language |
string |
Указывает языковой код, в котором должны быть возвращены имена часовых поясов. Если код языка не указан, ответ будет находиться в "EN". Дополнительные сведения см. в поддерживаемых языках. |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
Запрос выполнен успешно. |
|
| Other Status Codes |
Непредвиденное сообщение об ошибке. |
Безопасность
AadToken
Это Microsoft Entra OAuth 2.0 потоки. В сочетании с управлением Azure ролевым доступом он может использоваться для управления доступом к Azure Maps REST API. Ролевые контроли доступа Azure используются для обозначения доступа к одной или нескольким учетной записи ресурсов или подресурсам Azure Maps. Любой пользователь, группа или принципал сервиса может получить доступ через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений Azure Maps REST API.\n\nДля реализации сценариев рекомендуем ознакомиться с концепциями аутентификационные концепции. В заключение, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, способных контролировать доступ к определённым API и областям видимости.\n\n#### Примечания\n* Это определение безопасности требует использование заголовка x-ms-client-id для указания, к какому Azure Maps ресурсу приложение запрашивает доступ. Её можно получить через API управления Maps.\n* \nAuthorization URL специфичен для экземпляра публичного облака Azure. Облака Sovereign имеют уникальные URL-адреса авторизации и конфигурации Microsoft Entra ID. \n* \nУправление доступом на основе ролей Azure настраивается с плоскости управления Azure через портал Azure, PowerShell, CLI, Azure SDKs или REST API.\n* \nИспользование Azure Maps Web SDK позволяет настраивать приложение на основе конфигурации для нескольких сценариев использования.\n* Для получения дополнительной информации о платформа удостоверений Майкрософт см. платформа удостоверений Майкрософт обзор.
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
| Имя | Описание |
|---|---|
| https://atlas.microsoft.com/.default |
subscription-key
Это общий ключ, который создаётся при Создайте Azure Maps аккаунт в Azure-портале или с помощью PowerShell, CLI, Azure SDKs или REST API.\n\n С помощью этого ключа любое приложение может получить доступ ко всем REST API. Другими словами, этот ключ может использоваться как мастер-ключ на счете, на котором они выпущены.\n\n Для публично открытых приложений мы рекомендуем использовать подход confidential client applications для доступа к Azure Maps REST API, чтобы ваш ключ можно было безопасно хранить.
Тип:
apiKey
В:
header
SAS Token
Это токен общего доступа, созданный из операции List SAS на ресурсе
Тип:
apiKey
В:
header
Примеры
Successfully retrieve timezone by ID
Образец запроса
GET {endpoint}/timezone/byId/json?api-version=1.0&options=all&query=Asia/Bahrain
Пример ответа
{
"referenceUtcTimestamp": "2018-01-31T00:03:15.1349348Z",
"timeZones": [
{
"aliases": [
"Asia/Bahrain"
],
"countries": [
{
"code": "QA",
"name": "Qatar"
},
{
"code": "BH",
"name": "Bahrain"
}
],
"id": "Asia/Qatar",
"names": {
"daylight": "Arabian Daylight Time",
"generic": "Arabian Time",
"iso6391LanguageCode": "en",
"standard": "Arabian Standard Time"
},
"referenceTime": {
"daylightSavings": "00:00:00",
"posixTz": "<+03>-3",
"posixTzValidYear": 2018,
"standardOffset": "03:00:00",
"tag": "+03",
"wallTime": "2018-01-31T03:03:15.1349348+03:00"
},
"representativePoint": {
"latitude": 25.283333333333335,
"longitude": 51.53333333333333
},
"timeTransitions": [
{
"daylightSavings": "00:00:00",
"standardOffset": "03:00:00",
"tag": "+03",
"utcEnd": "9999-12-31T23:59:59.9999999Z",
"utcStart": "1972-05-31T20:00:00Z"
}
]
}
],
"version": "2018c"
}
Определения
| Имя | Описание |
|---|---|
|
Country |
Запись страны или региона. |
|
Error |
Дополнительные сведения об ошибке управления ресурсами. |
|
Error |
Сведения об ошибке. |
|
Error |
Обычный ответ на ошибку для всех API Azure Resource Manager для возврата деталей ошибок при неудачных операциях. (Это также следует формату ответа об ошибках OData.). |
|
Json |
Требуемый формат ответа. Поддерживается только |
|
Reference |
Сведения о действии в локальное время. |
|
Representative |
Свойство Репрезентативной точки |
|
Time |
Обозначает переход между часовыми поясами. |
|
Timezone |
Информация о часовом поясе. |
|
Timezone |
Объект имен часового пояса. |
|
Timezone |
Варианты информации о часовом поясе возвращаются в результате. |
|
Timezone |
Этот объект возвращается из успешного вызова Часового пояса по идентификатору или по координатам |
CountryRecord
Запись страны или региона.
| Имя | Тип | Описание |
|---|---|---|
| code |
string |
Iso-3166 2-буквенный код страны или региона для страны или региона. |
| name |
string |
имя страны или региона |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
| Имя | Тип | Описание |
|---|---|---|
| info |
object |
Дополнительные сведения. |
| type |
string |
Дополнительный тип сведений. |
ErrorDetail
Сведения об ошибке.
| Имя | Тип | Описание |
|---|---|---|
| additionalInfo |
Дополнительные сведения об ошибке. |
|
| code |
string |
Код ошибки. |
| details |
Сведения об ошибке. |
|
| message |
string |
Сообщение об ошибке. |
| target |
string |
Целевой объект ошибки. |
ErrorResponse
Обычный ответ на ошибку для всех API Azure Resource Manager для возврата деталей ошибок при неудачных операциях. (Это также следует формату ответа об ошибках OData.).
| Имя | Тип | Описание |
|---|---|---|
| error |
Объект ошибки. |
JsonFormat
Требуемый формат ответа. Поддерживается только json формат.
| Значение | Описание |
|---|---|
| json |
ReferenceTime
Сведения о действии в локальное время.
| Имя | Тип | Описание |
|---|---|---|
| daylightSavings |
string |
Экономия времени в минутах в |
| posixTz |
string |
Строка POSIX, используемая для задания переменной среды часового пояса. |
| posixTzValidYear |
integer (int32) |
Год этой строки POSIX действителен. Примечание. Строка POSIX будет действительна только в течение заданного года. |
| standardOffset |
string |
Смещение в формате UTC в |
| sunrise |
string (date-time) |
Восход в заданном часовом поясе, как показано в свойстве |
| sunset |
string (date-time) |
Закат в заданном часовом поясе, как показано в свойстве |
| tag |
string |
Имя часового пояса в действии в метке времени ссылки (т. е. PST или PDT в зависимости от того, действует ли время летнего времени). |
| wallTime |
string |
Текущее время стены в заданном часовом поясе, как показано в свойстве |
RepresentativePoint
Свойство Репрезентативной точки
| Имя | Тип | Описание |
|---|---|---|
| latitude |
number (float) |
Свойство Latitude |
| longitude |
number (float) |
Свойство Долготы |
TimeTransition
Обозначает переход между часовыми поясами.
| Имя | Тип | Описание |
|---|---|---|
| daylightSavings |
string |
Свойство DaylightSavings |
| standardOffset |
string |
Свойство StandardOffset |
| tag |
string |
Свойство tag |
| utcEnd |
string (date-time) |
Дата окончания, время окончания этого переходного периода |
| utcStart |
string (date-time) |
Дата начала, время начала этого переходного периода |
TimezoneId
Информация о часовом поясе.
| Имя | Тип | Описание |
|---|---|---|
| aliases |
string[] |
Массив псевдонимов идентификаторов часового пояса. Возвращается только в том случае, если [параметры]=zoneinfo или всех. Примечание. Может иметь значение NULL. |
| countries |
Массив записей страны или региона. Возвращается только в том случае, если [параметры]=zoneinfo или всех. |
|
| id |
string |
Свойство Id |
| names |
Объект имен часового пояса. |
|
| referenceTime |
Сведения о действии в локальное время. |
|
| representativePoint |
Свойство Репрезентативной точки |
|
| timeTransitions |
Часовой пояс DST переходит от [transitionsFrom] до метки времени + 1 год. |
TimezoneNames
Объект имен часового пояса.
| Имя | Тип | Описание |
|---|---|---|
| daylight |
string |
Имя дневного света |
| generic |
string |
Универсальное имя |
| iso6391LanguageCode |
string |
Код языка ISO 639-1 имен |
| standard |
string |
Стандартное имя |
TimezoneOptions
Варианты информации о часовом поясе возвращаются в результате.
| Значение | Описание |
|---|---|
| none |
Не включайте в результат zoneinfo или переходы. |
| zoneInfo |
Включите в результат дополнительную информацию о часовом поясе. |
| transitions |
Включите в результат информацию о переходе (в настоящее время количество переходов ограничено 250). |
| all |
Включите в результат как zoneinfo, так и переходы. |
TimezoneResult
Этот объект возвращается из успешного вызова Часового пояса по идентификатору или по координатам
| Имя | Тип | Описание |
|---|---|---|
| referenceUtcTimestamp |
string (date-time) |
Свойство Reference UTC Timestamp |
| timeZones |
Массив TimeZoneId |
|
| version |
string |
Свойство Version |