你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Weather - Get Tropical Storm Search
用于获取国家天气预报机构发布的风暴列表。
API Get Tropical Storm Search
是一个 HTTP GET
请求,可按年份、盆地 ID 和政府 ID 返回政府颁发的热带风暴列表。 有关热带风暴的信息包括、政府 ID、盆地 ID、状态、年份、名称以及是否为亚热带。
GET https://atlas.microsoft.com/weather/tropical/storms/json?api-version=1.1&year={year}
GET https://atlas.microsoft.com/weather/tropical/storms/json?api-version=1.1&year={year}&basinId={basinId}&govId={govId}
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
format
|
path | True |
响应的所需格式。 仅支持 |
|
api-version
|
query | True |
string |
Azure Maps API 的版本号。 |
year
|
query | True |
integer int32 |
气旋年 () |
basin
|
query |
盆地标识符 |
||
gov
|
query |
integer int32 |
政府风暴 ID |
请求头
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
x-ms-client-id |
string |
指定要与Microsoft Entra ID安全模型结合使用的帐户。 它表示Azure Maps帐户的唯一 ID,可从Azure Maps管理平面帐户 API 检索。 若要在 Azure Maps 中使用Microsoft Entra ID安全性,请参阅以下文章以获取指导。 |
响应
名称 | 类型 | 说明 |
---|---|---|
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 标识平台概述。
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
示例
Get Tropical Storm Search |
Get Tropical Storm Search With Three Properties |
Get Tropical Storm Search
Sample Request
GET https://atlas.microsoft.com/weather/tropical/storms/json?api-version=1.1&year=2021&basinId=AL
Sample Response
{
"results": [
{
"year": "2021",
"basinId": "AL",
"govId": 1,
"name": "Ana",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 2,
"name": "Bill",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 3,
"name": "Claudette",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 4,
"name": "Danny",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 5,
"name": "Elsa",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 6,
"name": "Fred",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 7,
"name": "Grace",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 8,
"name": "Henri",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 9,
"name": "Ida",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 10,
"name": "Kate",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 11,
"name": "Julian",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 12,
"name": "Larry",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 13,
"name": "Mindy",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 14,
"name": "Nicholas",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 15,
"name": "ODETTE",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 16,
"name": "Peter",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 17,
"name": "Rose",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 18,
"name": "Sam",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 19,
"name": "Teresa",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 20,
"name": "Victor",
"isActive": false,
"isRetired": false,
"isSubtropical": false
},
{
"year": "2021",
"basinId": "AL",
"govId": 21,
"name": "Wanda",
"isActive": false,
"isRetired": false,
"isSubtropical": false
}
]
}
Get Tropical Storm Search With Three Properties
Sample Request
GET https://atlas.microsoft.com/weather/tropical/storms/json?api-version=1.1&year=2021&basinId=AL&govId=1
Sample Response
{
"results": [
{
"year": "2021",
"basinId": "AL",
"govId": 1,
"name": "Ana",
"isActive": false,
"isRetired": false,
"isSubtropical": false
}
]
}
定义
名称 | 说明 |
---|---|
basin |
盆地标识符 |
Error |
资源管理错误附加信息。 |
Error |
错误详细信息。 |
Error |
错误响应 |
Json |
响应的所需格式。 仅支持 |
Storm |
搜索政府发布的风暴 |
Storm |
政府发布的活动风暴事件 |
basinId
盆地标识符
名称 | 类型 | 说明 |
---|---|---|
AL |
string |
大西洋 |
CP |
string |
中太平洋 |
EP |
string |
东太平洋 |
NI |
string |
北印度洋 |
NP |
string |
西北太平洋 |
SI |
string |
印度洋西南部 |
SP |
string |
南太平洋 |
ErrorAdditionalInfo
资源管理错误附加信息。
名称 | 类型 | 说明 |
---|---|---|
info |
object |
其他信息。 |
type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
additionalInfo |
错误附加信息。 |
|
code |
string |
错误代码。 |
details |
错误详细信息。 |
|
message |
string |
错误消息。 |
target |
string |
错误目标。 |
ErrorResponse
错误响应
名称 | 类型 | 说明 |
---|---|---|
error |
错误对象。 |
JsonFormat
响应的所需格式。 仅支持 json
格式。
名称 | 类型 | 说明 |
---|---|---|
json |
string |
StormSearchResult
搜索政府发布的风暴
名称 | 类型 | 说明 |
---|---|---|
nextLink |
string |
是指向返回的功能的下一页的链接。 如果是最后一页,则不使用此字段。 |
results |
搜索政府发布的风暴 |
StormSearchResultItem
政府发布的活动风暴事件
名称 | 类型 | 说明 |
---|---|---|
basinId |
盆地标识符 (AL、EP、SI、NI、CP、NP、SP) |
|
govId |
integer |
政府风暴 ID。 这将与抑郁症数字匹配。 |
isActive |
boolean |
如果最近更新了抑郁症,则为 True。 |
isRetired |
boolean |
如此 如果风暴名称已在源盆地中永久停用。 |
isSubtropical |
boolean |
当抑郁症被归类为亚热带气旋时,正确。 |
name |
string |
萧条的名字。 |
year |
string |
起源年份 |