notificationChannels 쿼리를 사용하면 계정당 모든 알림 알림 채널 을 페이지로 나눌 수 있습니다.또한 notificationChannel 쿼리를 사용하여 해당 ID로 특정 알림 채널을 가져올 수 있습니다.
팁
특정 비밀 필드(예: 암호 또는 API 키)는 반환된 필드에서 난독화됩니다.
이 예에서는 제공된 계정 ID의 모든 공지 채널에 대한 모든 필드를 최대 200페이지까지 반환합니다. [인라인 조각][inline-fragments]을 사용하여 AlertsNotificationChannel 인터페이스를 구현하는 구체적인 유형의 특정 필드를 참조하는 방법에 유의하세요.
{
actor{
account(id:YOUR_ACCOUNT_ID){
alerts{
notificationChannels{
channels{
id
name
type
...onAlertsXMattersNotificationChannel{
config{
integrationUrl
}
}
...onAlertsWebhookNotificationChannel{
config{
baseUrl
basicAuth{
password
username
}
customHttpHeaders{
name
value
}
customPayloadBody
customPayloadType
}
}
...onAlertsVictorOpsNotificationChannel{
config{
key
routeKey
}
}
...onAlertsUserNotificationChannel{
config{
userId
}
}
...onAlertsSlackNotificationChannel{
config{
teamChannel
url
}
}
...onAlertsPagerDutyNotificationChannel{
config{
apiKey
}
}
...onAlertsOpsGenieNotificationChannel{
config{
apiKey
dataCenterRegion
recipients
tags
teams
}
}
...onAlertsHipChatNotificationChannel{
config{
authToken
baseUrl
roomId
}
}
...onAlertsEmailNotificationChannel{
config{
emails
includeJson
}
}
...onAlertsCampfireNotificationChannel{
config{
room
subdomain
token
}
}
}
totalCount
nextCursor
}
}
}
}
}
지정된 계정의 알림 채널 목록이 200개 채널 페이지 제한을 초과하는 경우 페이지 매김 커서를 사용하여 추가 페이지를 검색할 수 있습니다.
커서 페이지 매김을 사용하면 해당 필드가 응답에서 공백을 반환할 때까지 nextCursor 을 사용하여 추가 페이지를 계속 요청합니다. 비어 있는 nextCursor 은 결과 집합의 끝에 도달했음을 나타냅니다.
특정 공지채널의 ID가 있는 경우 API 직접 조회할 수 있습니다. 특정 채널은 AlertsNotificationChannel 인터페이스를 구현하는 구체적인 유형이므로 [인라인 프래그먼트][inline-fragments]에 대한 ... on 구문을 사용하여 특정 필드를 지정해야 할 수도 있습니다.
이 예에서는 Slack 채널을 검색합니다.
{
actor{
account(id:YOUR_ACCOUNT_ID){
alerts{
notificationChannel(id:YOUR_CHANNEL_ID){
id
name
type
...onAlertsSlackNotificationChannel{
config{
teamChannel
url
}
}
}
}
}
}
}
이 예에서는 제공된 계정 ID의 모든 알림 채널에 대한 ID, 이름 및 유형과 해당 채널과 연결된 모든 정책 목록을 반환합니다.
{
actor{
account(id:YOUR_ACCOUNT_ID){
alerts{
notificationChannels{
channels{
id
name
type
associatedPolicies{
policies{
id
name
}
totalCount
}
}
nextCursor
totalCount
}
}
}
}
}
알림 채널 만들기
공지 공지 채널을 생성하려면 생성하려는 공지 채널의 특정 유형(예: 이메일, Slack 등)과 이를 구성하는 데 필요한 세부 정보(채널에 따라 다름)를 알아야 합니다. 유형). 공지 채널이 생성되면 하나 이상의 [공지][공지]와 연결될 수 있습니다. 일단 연결되면 해당 채널은 조건 위반 시 해당 정책으로부터 공지를 받게 됩니다.
주의
기존 공지 채널 유형에 대해 쿼리할 수 있지만 해당 유형의 하위 집합만 생성할 수 있습니다. 특히, user 채널 유형에는 편집 가능한 필드가 없으며 Campfire 및 HipChat 채널 유형은 모두 더 이상 사용되지 않습니다.
경고 알림 채널을 업데이트하려면 변경하려는 특정 알림 채널 유형(예: 이메일, Slack 등)과 이를 구성하는 데 필요한 세부정보(채널에 따라 다름)를 알아야 합니다. 유형). 다른 GraphQL API와 일관되게 채널의 ID 외에 다른 정보를 몰라도 채널의 단일 필드를 업데이트할 수 있습니다.
주의
기존 공지 채널 유형에 대해 조회할 수 있지만 해당 유형의 하위 집합만 업데이트할 수 있습니다. 특히, user 채널 유형에는 편집 가능한 필드가 없으며 Campfire 및 HipChat 채널 유형은 모두 더 이상 사용되지 않습니다.
이름만 업데이트하는 이메일 알림 채널의 업데이트 변형 예:
mutation{
alertsNotificationChannelUpdate(
accountId:YOUR_ACCOUNT_ID
id:YOUR_CHANNEL_ID
notificationChannel:{email:{name:"Updated Name <email@example.com>"}}