GET события

Материал из Документация Ключ-АСТРОМ

API Ключ-АСТРОМ / Эндпойнты среды / Развёртывание / События v1 / GET события

Перечисляет параметры указанного события.

Запрос создает application/jsonполезную нагрузку.

GET Managed https://{your-domain}/e/{your-environment-id}/api/v1/events/{eventId}
Среда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/api/v1/events/{eventId}

Аутентификация

Чтобы выполнить этот запрос , вам необходимо разрешение на проблему с доступом и канал событий, метрики и топологию ( DataExport) , назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Параметр Тип Описание In Необходимость
eventId string ID требуемого события. path требуется

Ответ

Коды ответов

Код Тип Описание
200 EventRestEntry Успех

Объекты тела ответа

Объект EventRestEntry

Набор параметров события.

Помимо общих свойств, упомянутых здесь, которые есть у каждого события, фактическое событие имеет набор метаданных, которые различаются в зависимости от типа события.

Элемент Тип Описание
startTime integer Отметка времени обнаружения события в миллисекундах UTC.

Может быть null.

endTime integer Отметка времени закрытия события в миллисекундах UTC.

Может быть null.

entityId string Идентификатор затронутого объекта Ключ-АСТРОМ.

Может быть null.

entityName string Имя затронутого объекта Ключ-АСТРОМ.

Может быть null.

severityLevel string Тяжесть события.

Элемент может содержать эти значения

  • AVAILABILITY
  • CUSTOM_ALERT
  • ERROR
  • MONITORING_UNAVAILABLE
  • PERFORMANCE
  • RESOURCE_CONTENTION

Может быть null.

impactLevel string Уровень воздействия события. Он показывает, на что влияет проблема: на инфраструктуру, службу или приложение.

Элемент может содержать эти значения

  • APPLICATION
  • ENVIRONMENT
  • INFRASTRUCTURE
  • SERVICE

Может быть null.

eventType string Тип события.

Элемент может содержать эти значения

  • APPLICATION_JS_FRAMEWORK_DETECTED
  • APPLICATION_OVERLOAD_PREVENTION
  • AVAILABILITY_EVENT
  • CONNECTION_LOST
  • CPU_SATURATED
  • CUSTOM_ALERT
  • CUSTOM_ANNOTATION
  • CUSTOM_APPLICATION_OVERLOAD_PREVENTION
  • CUSTOM_APP_CRASH_RATE_INCREASED
  • CUSTOM_CONFIGURATION
  • CUSTOM_DEPLOYMENT
  • CUSTOM_INFO
  • DATABASE_CONNECTION_FAILURE
  • DEPLOYMENT_CHANGED_CHANGE
  • DEPLOYMENT_CHANGED_NEW
  • DEPLOYMENT_CHANGED_REMOVED
  • ASTROMKEY_INTERNAL
  • EBS_VOLUME_HIGH_LATENCY
  • ELASTIC_LOAD_BALANCER_HIGH_BACKEND_FAILURE_RATE
  • ELASTIC_LOAD_BALANCER_HIGH_FAILURE_RATE
  • ELASTIC_LOAD_BALANCER_HIGH_UNHEALTHY_HOST_RATE
  • ERROR_EVENT
  • ESXI_HOST_VM_MOTION_ARRIVED
  • ESXI_HOST_VM_MOTION_LEFT
  • ESXI_HOST_VM_STARTED
  • ESXI_START
  • ESXI_VM_DISCONNECTED
  • ESXI_VM_MOTION
  • ESXI_VM_POWER_OFF
  • ESXI_VM_START
  • FAILURE_RATE_INCREASED
  • HIGH_CONNECTIVITY_FAILURES
  • HIGH_DROPPED_PACKETS_RATE
  • HIGH_GC_ACTIVITY
  • HIGH_LATENCY
  • HIGH_NETWORK_ERROR_RATE
  • HIGH_NETWORK_LOSS_RATE
  • HIGH_NETWORK_UTILIZATION
  • HOST_CONNECTION_FAILED
  • HOST_CONNECTION_LOST
  • HOST_DATASTORE_LOW_DISK_SPACE
  • HOST_DISK_LOW_INODES
  • HOST_GRACEFULLY_SHUTDOWN
  • HOST_LOG_AVAILABILITY
  • HOST_LOG_ERROR
  • HOST_LOG_MATCHED
  • HOST_LOG_PERFORMANCE
  • HOST_MAINTENANCE
  • HOST_NO_CONNECTION
  • HOST_OF_SERVICE_UNAVAILABLE
  • HOST_SHUTDOWN
  • HOST_TIMEOUT
  • HTTP_CHECK_GLOBAL_OUTAGE
  • HTTP_CHECK_LOCAL_OUTAGE
  • HTTP_CHECK_TEST_LOCATION_SLOWDOWN
  • INSUFFICIENT_DISK_QUEUE_DEPTH
  • JAVASCRIPT_ERROR_RATE_INCREASED
  • LAMBDA_FUNCTION_HIGH_ERROR_RATE
  • LOG_AVAILABILITY
  • LOG_ERROR
  • LOG_MATCHED
  • LOG_PERFORMANCE
  • LOW_DISK_SPACE
  • LOW_STORAGE_SPACE
  • MARKED_FOR_TERMINATION
  • MEMORY_RESOURCES_EXHAUSTED
  • MEMORY_SATURATED
  • MOBILE_APPLICATION_OVERLOAD_PREVENTION
  • MOBILE_APP_CRASH_RATE_INCREASED
  • MONITORING_UNAVAILABLE
  • OPENSTACK_HOST_VM_SHUTDOWN
  • OPENSTACK_HOST_VM_STARTED
  • OPENSTACK_KEYSTONE_SLOW
  • OPENSTACK_KEYSTONE_UNHEALTHY
  • OPENSTACK_VM_LAUNCH_FAILED
  • OPENSTACK_VM_MOTION
  • OSI_DOCKER_DEVICEMAPPER_LOW_DATA_SPACE
  • OSI_DOCKER_DEVICEMAPPER_LOW_METADATA_SPACE
  • OVERLOADED_STORAGE
  • PERFORMANCE_EVENT
  • PGI_CRASHED_INFO
  • PGI_HAPROXY_QUEUED_REQUESTS_HIGH
  • PGI_HAPROXY_SESSION_USAGE_HIGH
  • PGI_LOG_MATCHED
  • PGI_MEMDUMP
  • PGI_MYSQL_SLOW_QUERIES_RATE_HIGH
  • PGI_OF_SERVICE_UNAVAILABLE
  • PGI_RMQ_HIGH_FILE_DESC_USAGE
  • PGI_RMQ_HIGH_MEM_USAGE
  • PGI_RMQ_HIGH_PROCESS_USAGE
  • PGI_RMQ_HIGH_SOCKETS_USAGE
  • PGI_RMQ_LOW_DISK_SPACE
  • PROCESS_CRASHED
  • PROCESS_CUSTOM_AVAILABILITY
  • PROCESS_CUSTOM_ERROR
  • PROCESS_CUSTOM_PERFORMANCE
  • PROCESS_GROUP_LOW_INSTANCE_COUNT
  • PROCESS_LOG_AVAILABILITY
  • PROCESS_LOG_ERROR
  • PROCESS_LOG_PERFORMANCE
  • PROCESS_RESTART
  • PROCESS_UNAVAILABLE
  • RDS_AZ_FAILOVER_COMPLETED
  • RDS_AZ_FAILOVER_STARTED
  • RDS_BACKUP_COMPLETED
  • RDS_BACKUP_STARTED
  • RDS_OF_SERVICE_UNAVAILABLE
  • RDS_RESTART
  • RDS_RESTART_SEQUENCE
  • RESOURCE_CONTENTION
  • SERVICE_RESPONSE_TIME_DEGRADED
  • SLOW_DISK
  • SYNTHETIC_AVAILABILITY
  • SYNTHETIC_NODE_OUTAGE
  • SYNTHETIC_PRIVATE_LOCATION_OUTAGE
  • SYNTHETIC_SLOWDOWN
  • THREADS_RESOURCES_EXHAUSTED
  • UNEXPECTED_HIGH_LOAD
  • UNEXPECTED_LOW_LOAD
  • USER_ACTION_DURATION_DEGRADATION
  • VIRTUAL_MACHINE_SHUTDOWN
  • WEB_CHECK_GLOBAL_OUTAGE
  • WEB_CHECK_LOCAL_OUTAGE

Может быть null.

resourceId string Идентификатор ресурса, на котором произошло событие.

Может быть null.

resourceName string Имя ресурса, на котором произошло событие.

Может быть null.

eventStatus string Состояние мероприятия: открытое или закрытое.

Элемент может содержать эти значения

  • CLOSED
  • OPEN

Может быть null.

tags TagInfo[] Теги объекта Ключ-АСТРОМ, вызвавшего событие.

Может быть null.

id string Закодированный идентификатор события. Формат — eventID_startTime .

Вы должны использовать значение из этого поля, когда вам нужен идентификатор события.

Может быть null.

Объект TagInfo

Тег сущности Ключ-АСТРОМ.

Элемент Тип Описание
context string Происхождение тега, например AWS или Cloud Foundry.

Пользовательские теги используют это CONTEXTLESSзначение.

Элемент может содержать эти значения

  • AWS
  • AWS_GENERIC
  • AZURE
  • CLOUD_FOUNDRY
  • CONTEXTLESS
  • ENVIRONMENT
  • GOOGLE_CLOUD
  • KUBERNETES
key string Ключ тега.

Пользовательские теги имеют значение тега здесь.

value string Значение тега.

Не применимо к пользовательским тегам.

Может быть null.

JSON-модель тела ответа

{
  "startTime": 1521042929000,
  "endTime": 1521542929000,
  "entityId": "HOST-0000000000000007",
  "entityName": "Example Host",
  "severityLevel": "PERFORMANCE",
  "impactLevel": "INFRASTRUCTURE",
  "eventType": "SLOW_DISK",
  "eventStatus": "OPEN",
  "tags": [
    {
      "context": "CONTEXTLESS",
      "key": "exampleTag"
    }
  ],
  "id": "5915682011263205071_1521042929000",
  "source": "builtin"
}

Пример

В этом примере запрос запрашивает параметры события с идентификатором 4166694657638834567_1533134704285 .

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

Маркер API передается в заголовке авторизации .

Curl

curl -X GET \
  https://mySampleEnv.live.astromkey.com/api/v1/events/4166694657638834567_1533134704285 \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

URL-адрес запроса

https://mySampleEnv.live.astromkey.com/api/v1/events/4166694657638834567_1533134704285

Содержание ответа

{
  "eventId": 4166694657638834567,
  "startTime": 1533134704285,
  "endTime": 1533134704285,
  "entityId": "SERVICE-0F579DCA105F190C",
  "entityName": "wmqiTestingWeb",
  "severityLevel": null,
  "impactLevel": "SERVICE",
  "eventType": "CUSTOM_DEPLOYMENT",
  "eventStatus": "CLOSED",
  "tags": [
    {
      "context": "CONTEXTLESS",
      "key": "deploy"
    }
  ],
  "id": "4166694657638834567_1533134704285",
  "customProperties": {
    "Build Number": "1.223.23432",
    "Owner": "Jason Miller (jason.miller@easytravel.com)",
    "Approver": "Alice McBright (alice.mcbright@easytravel.com)",
    "Git commit": "e5afbftc7eb"
  },
  "deploymentProject": "easyTravel service",
  "remediationAction": "http://tower.local/job/RemediateJob/38/",
  "deploymentVersion": "1.23.321",
  "deploymentName": "easyTravel service deployment",
  "source": "ServiceNow",
  "ciBackLink": "http://tower.local/job/DeployJob/38/artifact/build/Deployment-v1.23.321.zip"
}

Код ответа

200

Источник — https://doc.ruscomtech.ru/index.php?title=GET_события&oldid=3646