你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Timezone - Get Timezone By ID

Service:

Maps

API Version:

1.0

用于获取指定 IANA 时区 ID 的当前、历史和未来时区信息。

API Get Timezone By ID 是一个 HTTP GET 请求，返回指定 IANA 时区 ID 的当前、历史和未来时区信息。

GET https://atlas.microsoft.com/timezone/byId/json?api-version=1.0&query={query}

With optional parameters:

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	JsonFormat	响应的所需格式。 仅支持 json 格式。
api-version	query	True	string	Azure Maps API 的版本号。
query	query	True	string	IANA 时区 ID。
options	query		TimezoneOptions	或者，使用别名“o”。 可用于结果中返回的信息类型的选项。
timeStamp	query		string date-time	或者，使用别名“stamp”或“s”。 引用时间（如果省略），API 将使用为请求提供服务的计算机时间。
transitionsFrom	query		string date-time	或者，使用别名“tf”。 请求夏令时 (DST) 转换的开始日期，仅当“options”= all 或“options”= transitions 时适用。
transitionsYears	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	TimezoneResult	确定
Other Status Codes	ErrorResponse	发生了意外错误。

安全性

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 标识平台概述。

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

Scopes

名称	说明
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

这是在Azure 门户中使用 PowerShell、CLI、Azure SDK 或 REST API Create Azure Maps 帐户时预配的共享密钥。

使用此密钥，任何应用程序都可以访问所有 REST API。 换句话说，此密钥可用作颁发密钥的帐户中的主密钥。

对于公开的应用程序，我们建议使用机密客户端应用程序方法来访问Azure Maps REST API，以便安全地存储密钥。

Type: apiKey
In: query

SAS Token

这是一个共享访问签名令牌，通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API，通过 Azure 管理平面在Azure Maps资源上列出 SAS 操作创建。

使用此令牌，任何应用程序都有权使用 Azure 基于角色的访问控制进行访问，并精细控制特定令牌的过期、速率和区域 () 。 换句话说，SAS 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。

对于公开的应用程序，我们建议在 Map 帐户资源 上配置允许的来源的特定列表，以限制呈现滥用，并定期续订 SAS 令牌。

Type: apiKey
In: header

示例

Successfully retrieve timezone by ID

Sample Request

HTTP

GET https://atlas.microsoft.com/timezone/byId/json?api-version=1.0&options=all&query=Asia/Bahrain

Sample Response

Status code:

200

{
  "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"
        }
      ]
    }
  ]
}

定义

名称	说明
CountryRecord	国家/地区记录。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
JsonFormat	响应的所需格式。 仅支持 json 格式。
ReferenceTime	当地时间生效的详细信息。
RepresentativePoint	代表点属性
TimeTransition
TimezoneId
TimezoneNames	时区名称对象。
TimezoneOptions	或者，使用别名“o”。 可用于结果中返回的信息类型的选项。
TimezoneResult	此对象是从成功的时区按 ID 调用或按坐标调用返回的

CountryRecord

国家/地区记录。

名称	类型	说明
Code	string	ISO-3166 国家/地区的 2 个字母国家/地区代码。
Name	string	国家/地区名称

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

JsonFormat

响应的所需格式。 仅支持 json 格式。

名称	类型	说明
json	string	JavaScript 对象表示法数据交换格式

ReferenceTime

当地时间生效的详细信息。

名称	类型	说明
DaylightSavings	string	在 上生效 ReferenceUTCTimestamp的时间以分钟为单位节省时间。
PosixTz	string	用于设置时区环境变量的 POSIX 字符串。
PosixTzValidYear	integer	此 POSIX 字符串的有效年份。 注意：POSIX 字符串仅在给定年份有效。
StandardOffset	string	在 处生效的 ReferenceUTCTimestampUTC 偏移量。
Sunrise	string	给定时区的日出，如 属性中 Tag 所示。 日出以ISO8601格式描述。 (仅当调用为 byCoordinates)
Sunset	string	给定时区的日落，如 属性中 Tag 所示。 日落以ISO8601格式描述。 (仅当调用为按坐标)
Tag	string	参考时间戳上生效的时区名称 (即 PST 或 PDT，具体取决于夏令时是否) 生效。
WallTime	string	给定时区的当前墙时间，如 属性中 Tag 所示。

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	CountryRecord[]	国家/地区记录的数组。 仅在 [options]=zoneinfo 或 all 时返回。
Id	string	Id 属性
Names	TimezoneNames	时区名称对象。
ReferenceTime	ReferenceTime	当地时间生效的详细信息。
RepresentativePoint	RepresentativePoint	代表点属性
TimeTransitions	TimeTransition[]	时区 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[]	TimeZoneId 数组
Version	string	Version 属性