你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Timezone - Get Timezone By Coordinates
使用 获取指定纬度-经度对的当前、历史和未来时区信息。
API Get Timezone By Coordinates
是一个 HTTP GET
请求,返回指定纬度-经度对的当前、历史和未来时区信息。 此外,API 提供给定位置的日落和日出时间。
GET https://atlas.microsoft.com/timezone/byCoordinates/json?api-version=1.0&query={query}
GET https://atlas.microsoft.com/timezone/byCoordinates/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 |
number[] |
请求时区信息的点的坐标。 此参数是一个坐标列表,其中包含一对坐标 (纬度、长) 。 直接调用此终结点时,坐标将作为包含坐标的单个字符串传入,以逗号分隔。 |
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 帐户的唯一 ID,可从 Azure Maps 管理平面帐户 API 检索。 若要在 Azure Maps 中使用 Microsoft Entra ID 安全性,请参阅以下 文章 以获取指导。 |
|
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 的一个或多个权限组成的自定义角色授予任何用户、组或服务主体的访问权限。
若要实现方案,建议查看 身份验证概念。 总之,此安全定义提供了一种解决方案,用于通过能够对特定 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 资源 上的列出 SAS 操作创建的共享访问签名令牌。
使用此令牌,任何应用程序都有权使用 Azure 基于角色的访问控制进行访问,并精细控制特定令牌的过期、速率和区域 () 。 换句话说,SAS 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。
对于公开的应用程序,我们建议在 Map 帐户资源 上配置允许的来源的特定列表,以限制呈现滥用,并定期续订 SAS 令牌。
类型:
apiKey
在:
header
示例
Successfully retrieve timezone by coordinates
示例请求
GET https://atlas.microsoft.com/timezone/byCoordinates/json?api-version=1.0&options=all&query=47,-122
示例响应
{
"Version": "2019a",
"ReferenceUtcTimestamp": "2019-06-17T22:16:59.0765556Z",
"TimeZones": [
{
"Id": "America/Los_Angeles",
"Aliases": [
"US/Pacific",
"US/Pacific-New"
],
"Countries": [
{
"Name": "United States",
"Code": "US"
}
],
"Names": {
"ISO6391LanguageCode": "en",
"Generic": "Pacific Time",
"Standard": "Pacific Standard Time",
"Daylight": "Pacific Daylight Time"
},
"ReferenceTime": {
"Tag": "PDT",
"StandardOffset": "-08:00:00",
"DaylightSavings": "01:00:00",
"WallTime": "2019-06-17T15:16:59.0765556-07:00",
"PosixTzValidYear": 2019,
"PosixTz": "PST+8PDT,M3.2.0,M11.1.0",
"Sunrise": "2019-06-17T05:12:21.267-07:00",
"Sunset": "2019-06-17T21:05:18.017-07:00"
},
"RepresentativePoint": {
"Latitude": 34.05222222222222,
"Longitude": -118.24277777777777
},
"TimeTransitions": [
{
"Tag": "PDT",
"StandardOffset": "-08:00:00",
"DaylightSavings": "01:00:00",
"UtcStart": "2019-03-10T10:00:00Z",
"UtcEnd": "2019-11-03T09:00:00Z"
},
{
"Tag": "PST",
"StandardOffset": "-08:00:00",
"DaylightSavings": "00:00:00",
"UtcStart": "2019-11-03T09:00:00Z",
"UtcEnd": "2020-03-08T10:00:00Z"
},
{
"Tag": "PDT",
"StandardOffset": "-08:00:00",
"DaylightSavings": "01:00:00",
"UtcStart": "2020-03-08T10:00:00Z",
"UtcEnd": "2020-11-01T09:00:00Z"
}
]
}
]
}
定义
名称 | 说明 |
---|---|
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 |
string |
ReferenceTime
当地时间生效的详细信息。
名称 | 类型 | 说明 |
---|---|---|
DaylightSavings |
string |
在 上生效 |
PosixTz |
string |
用于设置时区环境变量的 POSIX 字符串。 |
PosixTzValidYear |
integer |
此 POSIX 字符串的有效年份。 注意:POSIX 字符串仅在给定年份有效。 |
StandardOffset |
string |
在 处生效的 |
Sunrise |
string |
给定时区的日出,如 属性中 |
Sunset |
string |
给定时区的日落,如 属性中 |
Tag |
string |
参考时间戳上生效的时区名称 (即 PST 或 PDT,具体取决于夏令时是否) 生效。 |
WallTime |
string |
给定时区的当前墙时间,如 属性中 |
RepresentativePoint
代表点属性
名称 | 类型 | 说明 |
---|---|---|
Latitude |
number |
Latitude 属性 |
Longitude |
number |
Longitude 属性 |
TimeTransition
名称 | 类型 | 说明 |
---|---|---|
DaylightSavings |
string |
DaylightSavings 属性 |
StandardOffset |
string |
StandardOffset 属性 |
Tag |
string |
Tag 属性 |
UtcEnd |
string |
结束日期,此过渡期的结束时间 |
UtcStart |
string |
开始日期,此过渡期的开始时间 |
TimezoneId
名称 | 类型 | 说明 |
---|---|---|
Aliases |
string[] |
时区 ID 别名的数组。 仅在 [options]=zoneinfo 或 all 时返回。 注意: 可以为 null。 |
Countries |
国家/地区记录的数组。 仅在 [options]=zoneinfo 或 all 时返回。 |
|
Id |
string |
Id 属性 |
Names |
时区名称对象。 |
|
ReferenceTime |
当地时间生效的详细信息。 |
|
RepresentativePoint |
代表点属性 |
|
TimeTransitions |
时区 DST 从 [transitionsFrom] 转换到时间戳 + 1 年。 |
TimezoneNames
时区名称对象。
名称 | 类型 | 说明 |
---|---|---|
Daylight |
string |
夏令时名称 |
Generic |
string |
Generic Name |
ISO6391LanguageCode |
string |
名称的 ISO 639-1 语言代码 |
Standard |
string |
标准姓名 |
TimezoneOptions
或者,使用别名“o”。 可用于结果中返回的信息类型的选项。
名称 | 类型 | 说明 |
---|---|---|
all |
string |
在结果中包含 zoneinfo 和转换。 |
none |
string |
不要在结果中包含 zoneinfo 或转换。 |
transitions |
string |
在结果中包括转换信息 (转换数当前上限为 250) 。 |
zoneInfo |
string |
在结果中包含其他时区信息。 |
TimezoneResult
此对象是从成功的时区按 ID 调用或按坐标调用返回的
名称 | 类型 | 说明 |
---|---|---|
ReferenceUtcTimestamp |
string |
引用 Utc 时间戳属性 |
TimeZones |
TimeZoneId 数组 |
|
Version |
string |
Version 属性 |