Availability Statuses - Get By Resource

Ссылка

Служба:: Resource Health

Версия API:: 2024-02-01

Возвращает текущее состояние доступности для одного ресурса.

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

Имя	В	Обязательно	Тип	Описание
resourceUri	path	True	string	Полный идентификатор ресурса содержит имя и тип ресурса. В настоящее время API поддерживает не вложенные и один тип ресурсов уровня вложения: /subscriptions/{subscriptionId}/resourceGroups/{имя группы ресурсов}/providers/{resource-provider-name}/{resource-type}/{resource-type}/{resource-group-name}. name} и /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName}
api-version	query	True	string	Версия API, используемая для данной операции.
$expand	query		string	Задание $expand=recommendedactions в запросе URL-адреса расширяет рекомендуемые действия в ответе.
$filter	query		string	Фильтр, применяемый к операции. Дополнительные сведения см. в разделе https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN

Ответы

Имя	Тип	Описание
200 OK	availabilityStatus	Текущее состояние доступности для одного ресурса
Other Status Codes	ErrorResponse	DefaultErrorResponse

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

GetCurrentHealthByResource

Образец запроса

HTTP

GET https://management.azure.com/resourceUri/providers/Microsoft.ResourceHealth/availabilityStatuses/current?api-version=2024-02-01&$expand=recommendedactions

Пример ответа

Код состояния:: 200

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

Определения

Имя	Описание
AvailabilityStateValues	Состояние затронутого ресурса.
availabilityStatus	availabilityStatus ресурса.
ErrorResponse	Сведения об ошибке.
IncidentProperties	Свойства события, влияющего на службу.
Properties	Свойства состояния доступности.
reasonChronicityTypes	Хроничность перехода доступности.
RecentlyResolved	Заметка, описывающая изменение параметра availabilityState на Available (Недоступно) с типом reasonType типа Unplanned
recommendedAction	Списки действия, которые пользователь может предпринять на основе текущего состояния доступности ресурса.
serviceImpactingEvent	Списки, что служба влияет на события, которые могут повлиять на работоспособность ресурса.
Status	Состояние события, влияющего на службу.

AvailabilityStateValues

Состояние затронутого ресурса.

Имя	Тип	Описание
Available	string
Degraded	string
Unavailable	string
Unknown	string

availabilityStatus

availabilityStatus ресурса.

Имя	Тип	Описание
id	string	Azure Resource Manager Identity для ресурса availabilityStatuses.
location	string	Azure Resource Manager географическое расположение ресурса.
name	string	Текущего.
properties	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	Идентификатор статьи
availabilityState	AvailabilityStateValues	Состояние доступности ресурса. Если значение равно NULL, этот объект availabilityStatus представляет событие, влияющее на доступность.
category	string	Если для поля контекста задано значение Платформа, это поле будет отражать, было ли событие запланированным или незапланированным. Если поле контекста не имеет значения Platform, это поле будет игнорироваться.
context	string	При создании события оно может быть активировано клиентом или платформой ресурса, и это проиллюстрирует это в этом поле. Это поле связано с полем категории в этом объекте.
detailedStatus	string	Сведения о состоянии доступности.
healthEventCategory	string	В случае события, влияющего на доступность, описывается категория события, влияющего на работоспособность PlatformInitiated. Примеры: Planned, Unplanned и т. д.
healthEventCause	string	В случае события, влияющего на доступность, он описывает, где возникло событие, влияющее на работоспособность. Примеры: PlatformInitiated, UserInitiated и т. д.
healthEventId	string	Это уникальный идентификатор, определяющий событие.
healthEventType	string	В случае события, влияющего на доступность, в нем описывается, когда возникло событие, влияющее на работоспособность. Примеры: жизненный цикл, время простоя, анализ сбоев и т. д.
occuredTime	string	Метка времени последнего изменения состояния работоспособности.
reasonChronicity	reasonChronicityTypes	Хроничность перехода доступности.
reasonType	string	Если состояние доступности ресурса недоступно, оно описывает, где возникло событие, влияющее на работоспособность. Примерами являются запланированные, незапланированные, инициированные пользователем или сбои и т. д.
recentlyResolved	RecentlyResolved	Заметка, описывающая изменение параметра availabilityState на Available (Недоступно) с типом reasonType типа Unplanned
recommendedActions	recommendedAction[]	Списки действия, которые пользователь может предпринять на основе текущего состояния доступности ресурса.
reportedTime	string	Метка времени последней проверки работоспособности.
resolutionETA	string	Если значение availabilityState ресурса недоступно, а аргумент reasonType не инициирован пользователем, он предоставляет дату и время, когда ожидается, что проблема будет устранена.
rootCauseAttributionTime	string	Если состояние доступности ресурса недоступно, он предоставляет метку времени для получения события, влияющего на работоспособность.
serviceImpactingEvents	serviceImpactingEvent[]	Списки, что служба влияет на события, которые могут повлиять на работоспособность ресурса.
summary	string	Краткое описание состояния доступности.
title	string	Описание заголовка состояния доступности.

reasonChronicityTypes

Хроничность перехода доступности.

Имя	Тип	Описание
Persistent	string
Transient	string

RecentlyResolved

Заметка, описывающая изменение параметра availabilityState на Available (Недоступно) с типом reasonType типа Unplanned

Имя	Тип	Описание
resolvedTime	string	Метка времени, когда availabilityState изменится на Доступно.
unavailableOccuredTime	string	Метка времени изменения значения availabilityState на Недоступно
unavailableSummary	string	Краткое описание причины недоступности ресурса.

recommendedAction

Списки действия, которые пользователь может предпринять на основе текущего состояния доступности ресурса.

Имя	Тип	Описание
_ActionUrl.Comment	string	комментарий к действию
action	string	Рекомендуемое действие.
actionUrl	string	Ссылка на действие
actionUrlText	string	Подстрока действия описывает, в каком тексте должен размещаться URL-адрес действия.

serviceImpactingEvent

Списки, что служба влияет на события, которые могут повлиять на работоспособность ресурса.

Имя	Тип	Описание
correlationId	string	Идентификатор корреляции для события
eventStartTime	string	Метка времени начала события.
eventStatusLastModifiedTime	string	Метка времени отправки или обнаружения события.
incidentProperties	IncidentProperties	Свойства события, влияющего на службу.
status	Status	Состояние события, влияющего на службу.

Status

Состояние события, влияющего на службу.

Имя	Тип	Описание
value	string	Текущее состояние события

Поделиться через