Skip to main content
Astra Automation
본 한국어 번역은 사용자 편의를 위해 제공되는 기계 번역입니다. 영어 버전과 한국어 버전이 서로 어긋나는 경우에는 언제나 영어 버전이 우선합니다.

알림 검색

PDF

GET /accounts/{account_id}/core/v1/notifications/{notification_id}

JSON 응답 본문에 저장된 알림 API 리소스를 반환합니다.

매개변수

이름 유형 에서 필수 요소입니다 설명

account_id

문자열

경로

참

포함하는 계정 리소스의 ID

  • 예: {{.Account}}

notification_id

문자열

경로

참

나열할 알림 컬렉션의 ID입니다

응답

Status: 200, Returns the stored Notification API resource in the JSON response body.
이름 유형 필수 요소입니다 설명

유형

문자열

참

리소스의 미디어 유형입니다. 정의된 값은 다음과 같습니다.

  • "application/astra-notification"

버전

문자열

참

리소스 버전입니다. 정의된 값은 다음과 같습니다.

  • "1.0"

  • "1.1"

  • "1.2"

  • "1.3"

ID입니다

문자열

참

리소스의 전역 고유 식별자입니다. 정의된 값은 다음과 같습니다.

  • UUIDv4 스키마를 준수합니다.

이름

문자열

참

이벤트에 대한 점 표기법(.) 계층적 이름을 포함하는 JSON 문자열입니다. 정의된 값은 다음과 같습니다.

  • 최소 길이: 3

  • 최대 길이: 127

  • 정의된 정규식은 "^[a-z])(\.([a-z])+$"입니다.

sequenceCount

숫자

참

시퀀스 카운트를 포함하는 JSON 숫자입니다. 이 숫자는 새로운 이벤트가 수신될 때마다 시스템에서 증가합니다.

요약

문자열

참

이벤트에 대한 간략한 요약(40자 미만)을 포함하는 JSON 문자열입니다. 정의된 값은 다음과 같습니다.

  • 최소 길이: 3

  • 최대 길이: 79

eventTime

문자열

참

이벤트 발생 시점을 나타내는 타임스탬프가 포함된 JSON 문자열입니다. 정의된 값은 다음과 같습니다.

  • ISO-8601 날짜/시간 스키마를 준수합니다.

소스

문자열

참

이벤트를 생성하는 서비스의 소문자 이름을 포함하는 JSON 문자열입니다. 정의된 값은 다음과 같습니다.

  • 최소 길이: 1

  • 최대 길이: 19

  • 정의된 정규 표현식은 "^([a-z-])*$"입니다.

resourceID

문자열

참

이벤트와 연결된 리소스 ID가 포함된 JSON 문자열입니다. 정의된 값은 다음과 같습니다.

  • Astra 식별자 스키마를 준수합니다.

additionalResourceIDs

배열[string]

참

이벤트와 연결된 추가 리소스의 리소스 ID를 각각 포함하는 JSON 문자열의 JSON 배열입니다. "resourceID" 필드에는 이 이벤트와 연결된 기본 리소스가 포함되지만, 이 필드에는 동일한 이벤트와 연결될 추가 리소스 ID가 여러 개 포함됩니다. 이벤트와 연결된 추가 리소스가 없는 경우 배열은 비어 있습니다. 정의된 값은 다음과 같습니다.

  • Astra 식별자 스키마를 준수합니다.

resourceType

문자열

참

이벤트와 연결된 리소스의 미디어 유형을 포함하는 JSON 문자열입니다. 정의된 값은 다음과 같습니다.

  • 최소 길이: 4

  • 최대 길이: 79

  • 정의된 정규 표현식은 다음과 같습니다: "^application\/astra-([a-zA-Z])+$"

correlationID

문자열

참

관련 이벤트를 그룹화할 수 있도록 UUIDv4 상관 관계 ID가 포함된 JSON 문자열입니다. 정의된 값은 다음과 같습니다.

  • Astra 식별자 스키마를 준수합니다.

심각성

문자열

참

이벤트의 심각도를 나타내는 다음 값 중 하나를 포함하는 JSON 문자열입니다. 정의된 값은 다음과 같습니다.

  • "cleared" - 이전에 보고된 상태 관련 이벤트가 더 이상 활성화되지 않았음을 나타냅니다. 심각도가 "cleared"인 이벤트는 동일한 요약 및 상관 관계 ID를 사용하여 매칭이 가능하도록 합니다.

  • "indeterminate" - 심각도를 판단할 수 없음을 나타냅니다.

  • "informational" - 예상되고 정상적인 상태 변화를 나타냅니다(X.733에 정의되어 있지 않음).

  • "warning" - 심각한 영향이 발생하기 전에 서비스에 영향을 미칠 수 있는 잠재적 또는 임박한 오류가 감지되었음을 나타냅니다.

  • "critical" - 서비스에 영향을 미치는 상태가 발생했으며 즉각적인 시정 조치가 필요함을 나타냅니다. "cleared", "indeterminate", "warning" 및 "critical"에 대한 정의는 CCITT X.733의 8.1.2.3절에 있는 정의를 기반으로 합니다.

클래스

문자열

참

이벤트 클래스를 나타내는 다음 값 중 하나를 포함하는 JSON 문자열입니다. 정의된 값은 다음과 같습니다.

  • "system" - 이 이벤트는 내부 이벤트 또는 요청과 관련이 있습니다.

  • "user" - 이 이벤트는 사용자가 시작한 이벤트 또는 요청과 관련이 있습니다.

  • "security" - 이 이벤트는 보안 문제와 관련이 있습니다.

설명

문자열

참

이벤트에 대한 자세한 설명이 담긴 JSON 문자열입니다. 정의된 값은 다음과 같습니다.

  • 최소 길이: 3

  • 최대 길이: 1023

descriptionURL

문자열

거짓

배너의 버튼을 활성화하고 외부 문서에 연결하는 URL이 포함된 JSON 문자열입니다. 정의된 값은 다음과 같습니다.

  • 최소 길이: 3

  • 최대 길이: 4095

correctiveAction

문자열

거짓

이벤트에 대응하여 취해야 할 시정 조치에 대한 자세한 설명이 담긴 JSON 문자열입니다. 정의된 값은 다음과 같습니다.

  • 최소 길이: 3

  • 최대 길이: 1023

correctiveActionURL

문자열

거짓

배너의 버튼을 UI 내 문제 해결 페이지로 연결하는 URL이 포함된 JSON 문자열입니다. 정의된 값은 다음과 같습니다.

  • 최소 길이: 3

  • 최대 길이: 4095

가시성

배열[string]

거짓

이벤트 조회 권한이 있는 RBAC 역할을 나타내는 JSON 문자열의 JSON 배열입니다. 역할은 OR 연산자로 정의됩니다. 선택 사항입니다. 생략할 경우 모든 RBAC 역할을 가진 사용자가 이벤트를 조회할 수 있습니다. 정의된 값은 다음과 같습니다.

  • 최소 길이: 1

  • 최대 길이: 63

대상

배열[string]

거짓

JSON 문자열의 JSON 배열로, 각 문자열은 이벤트의 추가 대상을 나타냅니다. 이를 통해 서비스는 Activity 서비스의 활동 로그 외에도 이벤트가 라우팅되어야 하는 위치에 대한 힌트를 제공할 수 있습니다. 선택 사항입니다. 정의된 값은 다음과 같습니다:

  • "notification" - 해당 이벤트는 알림으로 표시되며, 알림 API 엔드포인트를 통해 접근할 수 있습니다.

  • "banner" - 해당 이벤트는 배너로 표시됩니다.

  • "support" - 해당 이벤트는 지원 관련 이벤트로 표시됩니다.

resourceURI

문자열

거짓

이벤트와 연결된 URI를 포함하는 JSON 문자열입니다. API 작업과 관련된 이벤트에만 포함됩니다. 정의된 값은 다음과 같습니다.

  • 최소 길이: 3

  • 최대 길이: 4095

resourceCollectionURL

배열[string]

거짓

이벤트와 관련된 리소스의 전체 액세스 URL을 나타내는 JSON 문자열들의 JSON 배열입니다. 정의된 값은 다음과 같습니다.

  • 최소 길이: 1

  • 최대 길이: 1023

resourceMethod

문자열

거짓

호출된 HTTP 메서드를 포함하는 JSON 문자열입니다. API 작업과 관련된 이벤트에만 포함됩니다. 정의된 값은 다음과 같습니다.

  • "options" - OPTIONS API 작업

  • "post" - POST API 작업

  • "get" - GET API 작업

  • "put" - PUT API 작업

  • "delete" - DELETE API 작업

resourceMethodResult

문자열

거짓

호출된 HTTP 메서드의 결과를 담은 JSON 문자열입니다. API 작업과 관련된 이벤트에만 포함됩니다. 정의된 값은 다음과 같습니다.

  • 정의된 정규 표현식은 다음과 같습니다: "^[1-5][0-9]{2}$"

userID

문자열

거짓

이벤트와 연결된 사용자 ID가 포함된 JSON 문자열입니다. 사용자가 시작한 작업과 관련된 이벤트에만 포함됩니다. 정의된 값은 다음과 같습니다.

  • Astra 식별자 스키마를 준수합니다.

accountID

문자열

거짓

이벤트와 연결된 계정 ID가 포함된 JSON 문자열입니다. 계정과 연결된 이벤트에만 포함됩니다. 정의된 값은 다음과 같습니다.

  • Astra 식별자 스키마를 준수합니다.

데이터

"데이터"

거짓

이벤트별 추가 정보를 포함하는 JSON 객체입니다.

메타데이터

"type_astra_메타데이터"

참

리소스와 연결된 클라이언트 및 서비스 지정 메타데이터입니다. 정의된 값은 다음과 같습니다.

  • Astra 메타데이터 스키마를 준수합니다.
응답 예 
{
  "type": "application/astra-notification",
  "version": "1.3",
  "id": "03c645d6-75f0-59b0-95f2-862ae344ea27",
  "name": "astra.app.discovery.failed",
  "sequenceCount": 48923,
  "summary": "Application Discovery Failed",
  "eventTime": "2020-08-06T12:24:51.846543Z",
  "source": "composite-compute",
  "resourceID": "f670bf11-8850-44bd-b330-815af6186a06",
  "additionalResourceIDs": [
    "84dfee99-b7b2-46d2-9021-0a1a9a5df1d6",
    "abb32003-07b9-49b1-9938-1cf6d2f33566"
  ],
  "resourceType": "application/astra-app",
  "correlationID": "3c603442-cfca-4af9-9f1b-40dde5c7a806",
  "severity": "warning",
  "class": "user",
  "description": "Discovering the application 'mysql' was unsuccessful. K8s error 442. Application marked in state 'error'.",
  "destinations": [
    "notification"
  ],
  "resourceURI": "/accounts/fdaa655c-15ab-4d34-aa61-1e9098e67be0/topology/v1/managedClusters/dfd9de2d-6f0b-437b-a737-c8f7f176cd14/apps/f670bf11-8850-44bd-b330-815af6186a06",
  "resourceCollectionURL": [
    "https://www.astra.io/accounts/fdaa655c-15ab-4d34-aa61-1e9098e67be0/topology/v1/clouds/0df3f1a0-7203-4c12-aabf-a7bee6302671/clusters/dfd9de2d-6f0b-437b-a737-c8f7f176cd14/namespaces/f8b58091-4b9c-4c64-9b40-018dbaf7c5de/apps/f670bf11-8850-44bd-b330-815af6186a06",
    "https://www.astra.io/accounts/fdaa655c-15ab-4d34-aa61-1e9098e67be0/topology/v1/clouds/0df3f1a0-7203-4c12-aabf-a7bee6302671/clusters/dfd9de2d-6f0b-437b-a737-c8f7f176cd14/namespaces/923708f8-0435-45b5-8c00-fbdef3ffaf25/apps/f670bf11-8850-44bd-b330-815af6186a06"
  ],
  "userID": "abda967f-cd2c-4237-908e-99266648c553",
  "accountID": "f126d214-bccf-4558-86b4-2137a41e734f",
  "metadata": {
    "labels": [],
    "creationTimestamp": "2022-10-06T20:58:16.305662Z",
    "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
    "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
  }
}

응답

Status: 401, Unauthorized
이름 유형 필수 요소입니다 설명

유형

문자열

참

제목

문자열

참

세부 정보

문자열

참

상태

문자열

참

correlationID

문자열

거짓
응답 예 
{
  "type": "https://astra.netapp.io/problems/3",
  "title": "Missing bearer token",
  "detail": "The request is missing the required bearer token.",
  "status": "401"
}

응답

Status: 400, Bad request
이름 유형 필수 요소입니다 설명

유형

문자열

참

제목

문자열

참

세부 정보

문자열

참

상태

문자열

참

correlationID

문자열

거짓

invalidParams

배열["invalidParams"]

거짓

유효하지 않은 쿼리 매개변수 목록
응답 예 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

응답

Status: 403, Forbidden
이름 유형 필수 요소입니다 설명

유형

문자열

참

제목

문자열

참

세부 정보

문자열

참

상태

문자열

참

correlationID

문자열

거짓
응답 예 
{
  "type": "https://astra.netapp.io/problems/11",
  "title": "Operation not permitted",
  "detail": "The requested operation isn't permitted.",
  "status": "403"
}

오류

Status: 404, Not found
이름 유형 필수 요소입니다 설명

유형

문자열

참

제목

문자열

참

세부 정보

문자열

참

상태

문자열

참

correlationID

문자열

거짓
예시 오류 응답 
{
  "type": "https://astra.netapp.io/problems/2",
  "title": "Collection not found",
  "detail": "The collection specified in the request URI wasn't found.",
  "status": "404"
}

정의

정의를 참조하세요

데이터

이벤트별 추가 정보를 포함하는 JSON 객체입니다.

이름 유형 필수 요소입니다 설명

ttl

숫자

거짓

eventTime 이후 경과된 시간(초)을 나타내는 JSON 숫자입니다. 이 시간이 지나면 이벤트가 보관됩니다. 이 필드는 지정된 시간(초)이 경과한 후 이벤트가 자동으로 삭제될 때만 포함됩니다. 삭제될 때 이벤트에 알림 대상이 있으면 관련된 모든 알림도 삭제됩니다. 삭제될 때 이벤트에 배너 대상이 있으면 배너도 제거됩니다. 이 필드가 없거나 값이 "0"인 경우 이벤트가 자동으로 삭제되지 않습니다.

isAcknowledgeable

문자열

거짓

배너를 닫을 수 있는지 여부를 나타내는 JSON 문자열입니다. 정의된 값은 다음과 같습니다.

  • "true" - 배너는 닫을 수 있습니다

  • "false" - 배너는 닫을 수 없습니다

type_astra_label

이름 유형 필수 요소입니다 설명

이름

문자열

참

값

문자열

참

type_astra_메타데이터

리소스와 연결된 클라이언트 및 서비스 지정 메타데이터입니다. 정의된 값은 다음과 같습니다.

  • Astra 메타데이터 스키마를 준수합니다.

이름 유형 필수 요소입니다 설명

라벨

배열["type_astra_label"]

참

CreationTimestamp 를 클릭합니다

문자열

참

modificationTimestamp

문자열

참

생성 시

문자열

참

modifiedBy

문자열

거짓

invalidParams

이름 유형 필수 요소입니다 설명

이름

문자열

참

잘못된 쿼리 매개변수의 이름

이유

문자열

참

쿼리 매개변수가 유효하지 않은 이유