Timezone - Get Timezone By ID
用于获取指定 IANA 时区 ID 的当前、历史和未来时区信息。
Get Timezone By ID API 是一个 HTTP GET 请求,它返回指定 IANA 时区 ID 的当前、历史时区和将来时区信息。
GET https://atlas.microsoft.com/timezone/byId/json?api-version=1.0&query={query}
GET https://atlas.microsoft.com/timezone/byId/json?api-version=1.0&options={options}&timeStamp={timeStamp}&transitionsFrom={transitionsFrom}&transitionsYears={transitionsYears}&query={query}
URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
format
|
path | True |
响应的所需格式。 仅支持 |
|
|
api-version
|
query | True |
string |
Azure Maps API 的版本号。 |
|
query
|
query | True |
string |
IANA 时区 ID。 |
|
options
|
query |
或者,使用别名“o”。 可用于结果中返回的信息类型的选项。 |
||
|
time
|
query |
string (date-time) |
或者,使用别名“stamp”或“s”。 如果省略引用时间,API 将使用提供请求的计算机时间。 |
|
|
transitions
|
query |
string (date-time) |
或者,使用别名“tf”。 从中请求夏令时(DST)转换的开始日期,仅当“options”= all 或“options”= transitions 时适用。 |
|
|
transitions
|
query |
integer |
或者,使用别名“ty”。 请求 DST 转换的“transitionsFrom”的年数,仅当“options”= all 或“options”= transitions 时适用。 |
请求头
| 名称 | 必需 | 类型 | 说明 |
|---|---|---|---|
| x-ms-client-id |
string |
指示用于 Microsoft Entra ID 安全模型的帐户。 可以从 Azure Maps 管理平面帐户 API 获取 Azure Maps 帐户的唯一 ID。 有关在 Azure Maps 中使用 Microsoft Entra ID 安全性的详细信息,请参阅 在 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 的权限组成的自定义角色授予访问权限。
若要实现方案,建议查看
注释
- 此安全定义 要求 使用
x-ms-client-id标头来指示应用程序请求访问的 Azure Maps 资源。 这可以从 地图管理 API获取。
Authorization URL 特定于 Azure 公有云实例。 主权云具有唯一的授权 URL,Microsoft Entra ID 配置。
* Azure 基于角色的访问控制是通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 从 Azure 管理平面 配置的。
* 使用 azure Maps Web SDK 允许为多个用例设置基于应用程序的配置。
- 有关Microsoft标识平台的详细信息,请参阅 Microsoft标识平台概述。
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
| 名称 | 说明 |
|---|---|
| https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
这是在 Azure 门户中或使用 PowerShell、CLI、Azure SDK 或 REST API 创建 Azure Maps 帐户 时预配的共享密钥。
使用此密钥,任何应用程序都可以访问所有 REST API。 换句话说,此密钥可用作颁发密钥的帐户中的主密钥。
对于公开的应用程序,我们建议使用 机密客户端应用程序 方法来访问 Azure Maps REST API,以便安全地存储密钥。
类型:
apiKey
在:
query
SAS Token
这是一个共享访问签名令牌,它通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 通过 Azure 管理平面在 azure Maps 资源
使用此令牌,任何应用程序都有权使用 Azure 基于角色的访问控制进行访问,并精细控制特定令牌的过期、速率和区域。 换句话说,SAS 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。
对于公开的应用程序,建议在 映射帐户资源 上配置允许的源的特定列表,以限制呈现滥用并定期续订 SAS 令牌。
类型:
apiKey
在:
header
示例
Successfully retrieve timezone by ID
示例请求
GET https://atlas.microsoft.com/timezone/byId/json?api-version=1.0&options=all&query=Asia/Bahrain
示例响应
{
"Version": "2018c",
"ReferenceUtcTimestamp": "2018-01-31T00:03:15.1349348Z",
"TimeZones": [
{
"Id": "Asia/Qatar",
"Aliases": [
"Asia/Bahrain"
],
"Countries": [
{
"Name": "Qatar",
"Code": "QA"
},
{
"Name": "Bahrain",
"Code": "BH"
}
],
"Names": {
"ISO6391LanguageCode": "en",
"Generic": "Arabian Time",
"Standard": "Arabian Standard Time",
"Daylight": "Arabian Daylight Time"
},
"ReferenceTime": {
"Tag": "+03",
"StandardOffset": "03:00:00",
"DaylightSavings": "00:00:00",
"WallTime": "2018-01-31T03:03:15.1349348+03:00",
"PosixTzValidYear": 2018,
"PosixTz": "<+03>-3"
},
"RepresentativePoint": {
"Latitude": 25.283333333333335,
"Longitude": 51.53333333333333
},
"TimeTransitions": [
{
"Tag": "+03",
"StandardOffset": "03:00:00",
"DaylightSavings": "00:00:00",
"UtcStart": "1972-05-31T20:00:00Z",
"UtcEnd": "9999-12-31T23:59:59.9999999Z"
}
]
}
]
}
定义
| 名称 | 说明 |
|---|---|
|
Country |
国家/地区记录。 |
|
Error |
资源管理错误附加信息。 |
|
Error |
错误详细信息。 |
|
Error |
错误响应 |
|
Json |
响应的所需格式。 仅支持 |
|
Reference |
当地时间生效的详细信息。 |
|
Representative |
代表点属性 |
|
Time |
|
|
Timezone |
|
|
Timezone |
时区名称对象。 |
|
Timezone |
或者,使用别名“o”。 可用于结果中返回的信息类型的选项。 |
|
Timezone |
此对象是从成功的时区按 ID 调用或按坐标调用返回的 |
CountryRecord
国家/地区记录。
| 名称 | 类型 | 说明 |
|---|---|---|
| Code |
string |
国家/地区的 ISO-3166 2 字母国家/地区代码。 |
| Name |
string |
国家/地区名称 |
ErrorAdditionalInfo
资源管理错误附加信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| info |
object |
其他信息。 |
| type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| additionalInfo |
错误附加信息。 |
|
| code |
string |
错误代码。 |
| details |
错误详细信息。 |
|
| message |
string |
错误消息。 |
| target |
string |
错误目标。 |
ErrorResponse
错误响应
| 名称 | 类型 | 说明 |
|---|---|---|
| error |
错误对象。 |
JsonFormat
响应的所需格式。 仅支持 json 格式。
| 值 | 说明 |
|---|---|
| json |
ReferenceTime
当地时间生效的详细信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| DaylightSavings |
string |
在 |
| PosixTz |
string |
用于设置时区环境变量的 POSIX 字符串。 |
| PosixTzValidYear |
integer |
此 POSIX 字符串的年份有效。 注意:POSIX 字符串仅在给定年份有效。 |
| StandardOffset |
string |
|
| Sunrise |
string (date-time) |
给定时区的日出,如 |
| Sunset |
string (date-time) |
给定时区的日落,如 |
| Tag |
string |
参考时间戳生效的时区名称(即 PST 或 PDT,具体取决于夏令时是否有效)。 |
| WallTime |
string |
给定时区的当前墙时间,如 |
RepresentativePoint
代表点属性
| 名称 | 类型 | 说明 |
|---|---|---|
| Latitude |
number |
Latitude 属性 |
| Longitude |
number |
经度属性 |
TimeTransition
| 名称 | 类型 | 说明 |
|---|---|---|
| DaylightSavings |
string |
DaylightSavings 属性 |
| StandardOffset |
string |
StandardOffset 属性 |
| Tag |
string |
Tag 属性 |
| UtcEnd |
string (date-time) |
此过渡期的结束日期、结束时间 |
| UtcStart |
string (date-time) |
开始日期、此过渡期的开始时间 |
TimezoneId
| 名称 | 类型 | 说明 |
|---|---|---|
| Aliases |
string[] |
时区 ID 别名数组。 仅当 [options]=zoneinfo 或 所有时才返回。 注意:可能为 null。 |
| Countries |
国家/地区记录的数组。 仅当 [options]=zoneinfo 或 所有时才返回。 |
|
| Id |
string |
Id 属性 |
| Names |
时区名称对象。 |
|
| ReferenceTime |
当地时间生效的详细信息。 |
|
| RepresentativePoint |
代表点属性 |
|
| TimeTransitions |
时区 DST 从 [transitionsFrom] 转换到时间戳 + 1 年。 |
TimezoneNames
时区名称对象。
| 名称 | 类型 | 说明 |
|---|---|---|
| Daylight |
string |
夏令时名称 |
| Generic |
string |
泛型名称 |
| ISO6391LanguageCode |
string |
Names 的 ISO 639-1 语言代码 |
| Standard |
string |
标准名称 |
TimezoneOptions
或者,使用别名“o”。 可用于结果中返回的信息类型的选项。
| 值 | 说明 |
|---|---|
| none |
不要在结果中包含 zoneinfo 或过渡。 |
| zoneInfo |
在结果中包含其他时区信息。 |
| transitions |
在结果中包含转换信息(转换数量当前上限为 250)。 |
| all |
在结果中同时包含 zoneinfo 和 transitions。 |
TimezoneResult
此对象是从成功的时区按 ID 调用或按坐标调用返回的
| 名称 | 类型 | 说明 |
|---|---|---|
| ReferenceUtcTimestamp |
string (date-time) |
引用 Utc 时间戳属性 |
| TimeZones |
TimeZoneId 数组 |
|
| Version |
string |
Version 属性 |