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

Timezone - Get Timezone By ID

服务:: Maps

API 版本:: 1.0

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

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 (uri)	Azure Maps 服务主机名。 Azure公有云使用`https://atlas.microsoft.com`。要针对特定Azure Maps地理或主权云，请参见Azure Maps地理范围。
format	path	True	JsonFormat	响应的所需格式。仅支持 `json` 格式。
api-version	query	True	string minLength: 1	用于此作的 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 (int32)	或者，使用别名“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安全的更多信息，请参见管理认证在Azure Maps。
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标识平台概述。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

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

subscription-key

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

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

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

类型: apiKey
在: header

SAS Token

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

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

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

类型: apiKey
在: header

示例

Successfully retrieve timezone by ID

示例请求

HTTP

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

示例响应

状态代码:: 200

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

定义

名称	说明
CountryRecord	国家/地区记录。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	所有 Azure 资源管理器 API 的通用错误响应，用于返回失败操作的错误细节。（这也遵循 OData 错误响应格式）。
JsonFormat	响应的所需格式。仅支持 `json` 格式。
ReferenceTime	当地时间生效的详细信息。
RepresentativePoint	代表点属性
TimeTransition	代表时区的转换。
TimezoneId	时区ID信息。
TimezoneNames	时区名称对象。
TimezoneOptions	结果中返回了时区信息选项。
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

对象

所有 Azure 资源管理器 API 的通用错误响应，用于返回失败操作的错误细节。（这也遵循 OData 错误响应格式）。

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

JsonFormat

枚举

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

值	说明
json	JavaScript 对象表示法数据交换格式

ReferenceTime

对象

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

名称	类型	说明
daylightSavings	string	在 `ReferenceUTCTimestamp`上节省几分钟的时间。
posixTz	string	用于设置时区环境变量的 POSIX 字符串。
posixTzValidYear	integer (int32)	此 POSIX 字符串的年份有效。注意：POSIX 字符串仅在给定年份有效。
standardOffset	string	`ReferenceUTCTimestamp`生效的 UTC 偏移量。
sunrise	string (date-time)	给定时区的日出，如 `Tag` 属性中所示，仅在调用 `byCoordinates`时填充。日出以 ISO 8601 格式描述。请注意，时区 API 不会返回在请求区域中观测太阳日时的日出和日落时间。
sunset	string (date-time)	给定时区的日落，如 `Tag` 属性中所示，仅在调用 `byCoordinates`时填充。日落采用 ISO 8601 格式进行描述。请注意，时区 API 不会返回在请求区域中观测太阳日时的日出和日落时间。
tag	string	参考时间戳生效的时区名称（即 PST 或 PDT，具体取决于夏令时是否有效）。
wallTime	string	给定时区的当前墙时间，如 `Tag` 属性所示。

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

对象

时区ID信息。

名称	类型	说明
aliases	string[]	时区 ID 别名数组。仅当 [options]=zoneinfo 或所有时才返回。注意：可能为 null。
countries	CountryRecord[]	国家/地区记录的数组。仅当 [options]=zoneinfo 或所有时才返回。
id	string	Id 属性
names	TimezoneNames	时区名称对象。
referenceTime	ReferenceTime	当地时间生效的详细信息。
representativePoint	RepresentativePoint	代表点属性
timeTransitions	TimeTransition[]	时区 DST 从 [transitionsFrom] 转换到时间戳 + 1 年。

TimezoneNames

对象

时区名称对象。

名称	类型	说明
daylight	string	夏令时名称
generic	string	泛型名称
iso6391LanguageCode	string	Names 的 ISO 639-1 语言代码
standard	string	标准名称

TimezoneOptions

枚举

结果中返回了时区信息选项。

值	说明
none	不要在结果中包含 zoneinfo 或过渡。
zoneInfo	在结果中包含其他时区信息。
transitions	在结果中包含转换信息（转换数量当前上限为 250）。
all	在结果中同时包含 zoneinfo 和 transitions。

TimezoneResult

对象

此对象是从成功的时区按 ID 调用或按坐标调用返回的

名称	类型	说明
referenceUtcTimestamp	string (date-time)	引用 Utc 时间戳属性
timeZones	TimezoneId[]	TimeZoneId 数组
version	string	Version 属性