你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Availability Statuses - Get By Resource
获取单个资源的当前可用性状态
GET https://management.azure.com/{resourceUri}/providers/Microsoft.ResourceHealth/availabilityStatuses/current?api-version=2024-02-01
GET https://management.azure.com/{resourceUri}/providers/Microsoft.ResourceHealth/availabilityStatuses/current?api-version=2024-02-01&$filter={$filter}&$expand={$expand}
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
resource
|
path | True |
string |
资源的完全限定 ID,包括资源名称和资源类型。 目前,API 不支持嵌套和一种嵌套级别资源类型:/subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-name}/{resource-name} 和 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName} |
api-version
|
query | True |
string |
要用于此操作的 API 版本。 |
$expand
|
query |
string |
在 url 查询中设置 $expand=recommendedactions 会扩展响应中的建议操作。 |
|
$filter
|
query |
string |
要应用于操作的筛选器。 有关详细信息,请参阅 https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
单个资源的当前可用性状态 |
|
Other Status Codes |
DefaultErrorResponse |
安全性
azure_auth
Azure Active Directory OAuth2 流
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
GetCurrentHealthByResource
示例请求
GET https://management.azure.com/resourceUri/providers/Microsoft.ResourceHealth/availabilityStatuses/current?api-version=2024-02-01&$expand=recommendedactions
示例响应
{
"id": "/subscriptions/4abcdefgh-ijkl-mnop-qrstuvwxyz/resourceGroups/rhctestenv/providers/Microsoft.ClassicCompute/virtualMachines /rhctestenvV1PI/providers/Microsoft.ResourceHealth/availabilityStatuses/current",
"name": "current",
"type": "Microsoft.ResourceHealth/AvailabilityStatuses",
"location": "eastus",
"properties": {
"availabilityState": "Unavailable",
"title": "Unavailable",
"summary": "We're sorry, we couldn't automatically recover your virtual machine",
"reasonType": "Unplanned",
"context": "Platform Initiated",
"category": "Unplanned",
"reasonChronicity": "Persistent",
"detailedStatus": "Disk problems are preventing us from automatically recovering your virtual machine",
"occuredTime": "2016-03-29T09:12:00Z",
"reportedTime": "2016-05-04T14:11:29.7598931Z",
"rootCauseAttributionTime": "2016-03-29T09:13:00Z",
"resolutionETA": "2016-03-29T09:37:00Z",
"recommendedActions": [
{
"action": "To start this virtual machine, open the resource blade and click Start",
"actionUrl": "<#ResourceBlade>",
"actionUrlText": "resource blade"
},
{
"action": "If you are experiencing problems you believe are caused by Azure, contact support",
"actionUrl": "<#SupportCase>",
"actionUrlText": "contact support"
}
]
}
}
定义
名称 | 说明 |
---|---|
Availability |
资源的受影响资源状态。 |
availability |
availabilityStatus of a resource。 |
Error |
错误详细信息。 |
Incident |
影响事件的服务的属性。 |
Properties |
可用性状态的属性。 |
reason |
可用性转换的慢性性。 |
Recently |
描述将 availabilityState 更改为“不可用”的注释,其中 reasonType 类型为 Unplanned |
recommended |
Lists用户可以根据资源的当前 availabilityState 执行的操作。 |
service |
Lists影响可能影响资源运行状况的事件的服务。 |
Status |
影响事件的服务状态。 |
AvailabilityStateValues
资源的受影响资源状态。
名称 | 类型 | 说明 |
---|---|---|
Available |
string |
|
Degraded |
string |
|
Unavailable |
string |
|
Unknown |
string |
availabilityStatus
availabilityStatus of a resource。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
azure 资源管理器 availabilityStatuses 资源的标识。 |
location |
string |
Azure 资源管理器资源的地理位置。 |
name |
string |
当前。 |
properties |
可用性状态的属性。 |
|
type |
string |
Microsoft.ResourceHealth/AvailabilityStatuses。 |
ErrorResponse
错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
错误代码。 |
details |
string |
错误详细信息。 |
message |
string |
错误消息。 |
IncidentProperties
影响事件的服务的属性。
名称 | 类型 | 说明 |
---|---|---|
incidentType |
string |
事件类型。 |
region |
string |
受事件影响的区域。 |
service |
string |
受事件影响的服务。 |
title |
string |
事件的标题。 |
Properties
可用性状态的属性。
名称 | 类型 | 说明 |
---|---|---|
articleId |
string |
文章 ID |
availabilityState |
资源的可用性状态。 如果为 null,则此 availabilityStatus 对象表示影响可用性的事件 |
|
category |
string |
当上下文字段设置为“平台”时,此字段将反映事件是计划内还是计划外事件。 如果上下文字段没有“平台”值,则将忽略此字段。 |
context |
string |
创建事件时,可由客户或资源平台触发,此字段将对此进行说明。 此字段连接到此对象中的类别字段。 |
detailedStatus |
string |
可用性状态的详细信息。 |
healthEventCategory |
string |
如果出现影响可用性的事件,它将描述 PlatformInitiated 运行状况影响事件的类别。 示例包括计划内、计划外等。 |
healthEventCause |
string |
如果发生影响可用性的事件,它将描述影响运行状况事件的来源。 示例包括 PlatformInitiated、UserInitiated 等。 |
healthEventId |
string |
它是标识事件的唯一 ID |
healthEventType |
string |
如果发生影响可用性的事件,它会描述影响运行状况事件的发生时间。 示例包括生命周期、停机时间、故障分析等。 |
occuredTime |
string |
上次运行状况更改的时间戳。 |
reasonChronicity |
可用性转换的慢性性。 |
|
reasonType |
string |
当资源的 availabilityState 为“不可用”时,它将描述影响运行状况的事件的来源。 示例包括计划内、计划外、用户启动或中断等。 |
recentlyResolved |
描述将 availabilityState 更改为“不可用”的注释,其中 reasonType 类型为 Unplanned |
|
recommendedActions |
Lists用户可以根据资源的当前 availabilityState 执行的操作。 |
|
reportedTime |
string |
上次检查运行状况的时间戳。 |
resolutionETA |
string |
当资源的 availabilityState 为“不可用”且 reasonType 不是“用户启动”时,它会提供预期问题解决的日期和时间。 |
rootCauseAttributionTime |
string |
当资源的 availabilityState 为“不可用”时,它会提供收到影响运行状况的事件的时间戳。 |
serviceImpactingEvents |
Lists影响可能影响资源运行状况的事件的服务。 |
|
summary |
string |
可用性状态的摘要说明。 |
title |
string |
可用性状态的标题说明。 |
reasonChronicityTypes
可用性转换的慢性性。
名称 | 类型 | 说明 |
---|---|---|
Persistent |
string |
|
Transient |
string |
RecentlyResolved
描述将 availabilityState 更改为“不可用”的注释,其中 reasonType 类型为 Unplanned
名称 | 类型 | 说明 |
---|---|---|
resolvedTime |
string |
availabilityState 更改为 Available 时的时间戳。 |
unavailableOccuredTime |
string |
availabilityState 更改为“不可用”时的时间戳 |
unavailableSummary |
string |
有关资源不可用的原因的简要说明。 |
recommendedAction
Lists用户可以根据资源的当前 availabilityState 执行的操作。
名称 | 类型 | 说明 |
---|---|---|
_ActionUrl.Comment |
string |
操作的注释 |
action |
string |
建议的操作。 |
actionUrl |
string |
指向操作的链接 |
actionUrlText |
string |
操作的子字符串,描述应承载操作 URL 的文本。 |
serviceImpactingEvent
Lists影响可能影响资源运行状况的事件的服务。
名称 | 类型 | 说明 |
---|---|---|
correlationId |
string |
事件的关联 ID |
eventStartTime |
string |
事件开始时间的时间戳。 |
eventStatusLastModifiedTime |
string |
提交/检测到事件的时间戳。 |
incidentProperties |
影响事件的服务的属性。 |
|
status |
影响事件的服务状态。 |
Status
影响事件的服务状态。
名称 | 类型 | 说明 |
---|---|---|
value |
string |
事件的当前状态 |