NerdGraph 튜토리얼: 공지사항 흐름 생성 및 관리

뉴켈릭 알림의 경우 NerdGraph 사용해 생성하고 관리할 수 API 있습니다.

워크플로 나열 및 필터링

workflows 쿼리를 사용하면 계정당 모든 워크플로를 페이지로 나눌 수 있습니다.또한 계정 워크플로에서 일부 필터링 기능을 허용합니다.다음은 몇 가지 사용 사례입니다.

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiWorkflows {
        workflows(filters: {}) {
          entities {
            id
            name
            workflowEnabled
            destinationConfigurations {
              channelId
              name
              type
              notificationTriggers
            }
            enrichments {
              configurations {
                ... on AiWorkflowsNrqlConfiguration {
                  query
                }
              }
              id
              name
            }
          }
          nextCursor
          totalCount
        }
      }
    }
  }
}

워크플로를 페이지로 나누려면 초기 쿼리에서 nextCursor 필드를 요청해야 합니다.

커서 페이지 매김을 사용하면 응답에서 반환된 nextCursor 이(가) 비어 있을 때까지 결과 집합을 통해 계속 요청합니다.이것은 결과의 끝에 도달했음을 나타냅니다.

첫 번째 전화:

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiWorkflows {
        workflows(filters: {}) {
          entities {
            id
            name
          }
          nextCursor
          totalCount
        }
      }
    }
  }
}

응답:

{
  "data": {
    "actor": {
      "account": {
        "aiWorkflows": {
          "workflows": {
            "entities": [
              {
                "id": <WORKFLOW ID>, 
                "name": <WORKFLOW NAME>
              },
              {
                "id": <WORKFLOW ID>, 
                "name": <WORKFLOW NAME>
              },
              // ... more workflows would be here 
            ]
          }
          "nextCursor": "/8o0y2qiR54m6thkdgHgwg==:jZTXDFKbTkhKwvMx+CtsPVM="
          "totalCount": 157
        }
      }
    }
  }
}

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiWorkflows {
        workflows(filters: { id: WORKFLOW_ID }) {
          entities {
            id
            name
          }
          nextCursor
          totalCount
        }
      }
    }
  }
}

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiWorkflows {
        workflows(filters: { name: WORKFLOW_NAME }) {
          entities {
            id
            name
          }
          nextCursor
          totalCount
        }
      }
    }
  }
}

특정 유형의 대상 구성이 하나 이상 있는 모든 워크플로를 찾습니다.

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiWorkflows {
        workflows(filters: { destinationType: DESTINATION_TYPE }) {
          entities {
            id
            name
            destinationConfigurations {
              type
            }
          }
          nextCursor
          totalCount
        }
      }
    }
  }
}

워크플로 만들기

워크플로를 만들려면 먼저 대상과 채널을 만들어야 합니다 .

중요

채널 ID는 고유하므로 여러 워크플로에서 사용하거나 동일한 워크플로에서 여러 번 사용할 수 없습니다.

issuesFilter 속성은 워크플로에서 포착할 문제 이벤트를 결정합니다.

predicates 속성의 값을 빈 목록으로 유지하면 워크플로에서 가능한 모든 문제 이벤트를 포착합니다.속성 값을 선택하면 문제 이벤트를 필터링할 수 있습니다.

예를 들어 특정 팀과 관련된 문제만 필터링하는 속성을 선택할 수 있습니다.

mutation {
  aiWorkflowsCreateWorkflow(
    accountId: YOUR_ACCOUNT_ID
    createWorkflowData: {
      destinationsEnabled: true
      workflowEnabled: true
      name: "API Demo Workflow"
      issuesFilter: {
        name: "team specific issues"
        predicates: [
          {
            attribute: "accumulations.tag.team"
            operator: EXACTLY_MATCHES
            values: ["security"]
          }
        ]
        type: FILTER
      }
      destinationConfigurations: {
        channelId: "CHANNEL_ID"
        notificationTriggers: [ACTIVATED, ACKNOWLEDGED, CLOSED]
      }
      enrichmentsEnabled: true
      enrichments: { nrql: [] }
      mutingRulesHandling: DONT_NOTIFY_FULLY_MUTED_ISSUES
    }
  ) {
    workflow {
      id
      name
      destinationConfigurations {
        channelId
        name
        type
        notificationTriggers
      }
      enrichmentsEnabled
      destinationsEnabled
      issuesFilter {
        accountId
        id
        name
        predicates {
          attribute
          operator
          values
        }
        type
      }
      lastRun
      workflowEnabled
      mutingRulesHandling
    }
    errors {
      description
      type
    }
  }
}

워크플로 업데이트

워크플로우를 업데이트할 때 제공해야 하는 유일한 필수 속성은 aiWorkflowsUpdateWorkflow 아래의 accountId 과 updateWorkflowData 아래의 워크플로우의 id 입니다. 나머지는 선택사항입니다. 예를 들어, 이름만 업데이트하려는 경우에만 이름을 제공하면 됩니다.

플로우 플로우 ID를 확인하려면 플로우 플로우 테이블로 이동하여 행 끝에 있는 아이콘을 클릭하세요. 그런 다음 Copy workflow id to clipboard 선택합니다.

다음은 워크플로우의 이름과 채널 2개를 업데이트하는 예입니다.

mutation {
  aiWorkflowsUpdateWorkflow(
    accountId: YOUR_ACCOUNT_ID
    updateWorkflowData: {
      name: "UPDATED_WORKFLOW_NAME"
      id: WORKFLOW_ID
      destinationConfigurations: [
        {
          channelId: "12345abc-6de7-8f90-g123-4h56i78j9klm"
          notificationTriggers: [ACTIVATED]
        }
        {
          channelId: "zy0987xw-v65u-432t-10s9-r876qpo543n2"
          notificationTriggers: [ACTIVATED]
        }
      ]
    }
  ) {
    workflow {
      id
      name
      destinationConfigurations {
        channelId
        name
        type
        notificationTriggers
      }
      enrichmentsEnabled
      destinationsEnabled
      issuesFilter {
        accountId
        id
        name
        predicates {
          attribute
          operator
          values
        }
        type
      }
      lastRun
      workflowEnabled
      mutingRulesHandling
    }
    errors {
      description
      type
    }
  }
}

워크플로 삭제

다음은 워크플로를 삭제하는 예입니다.

mutation {
  aiWorkflowsDeleteWorkflow(id: WORKFLOW_ID, accountId: YOUR_ACCOUNT_ID) {
    id
    errors {
      description
      type
    }
  }
}

워크플로 테스트

테스트는 입력과 일치하는 이전 문제를 검색하고 이를 기반으로 가짜 알림을 생성합니다.입력과 일치하는 이전 문제가 발견되지 않으면 오류가 반환됩니다.

예를 들어:

mutation {
  aiWorkflowsTestWorkflow(
    accountId: YOUR_ACCOUNT_ID
    testWorkflowData: {
      destinationConfigurations: { channelId: YOUR_CHANNEL_ID, type: SLACK }
      issuesFilter: { predicates: [], type: YOUR_FILTER }
    }
  ) {
    status
    notificationResponses {
      status
      evidence
      channelId
    }
    errors {
      description
      type
    }
  }
}

사용자의 편의를 위해 제공되는 기계 번역입니다.

NerdGraph 튜토리얼: 공지사항 흐름 생성 및 관리

워크플로 나열 및 필터링

계정의 모든 워크플로 나열

ID로 워크플로 찾기

이름으로 워크플로 찾기

대상 유형별로 워크플로 찾기

워크플로 만들기

중요

모든 문제를 파악하는 워크플로 만들기

워크플로 업데이트

워크플로 삭제

워크플로 테스트

사용자의 편의를 위해 제공되는 기계 번역입니다.

NerdGraph 튜토리얼: 공지사항 흐름 생성 및 관리

워크플로 나열 및 필터링 .css-21sua1{background:none;border:none;width:0;padding:0;}

커서 페이지 매김으로 정책 페이지 매김:

ID로 워크플로 찾기

이름으로 워크플로 찾기

대상 유형별로 워크플로 찾기

워크플로 만들기

중요

모든 문제를 파악하는 워크플로 만들기

워크플로 업데이트

워크플로 삭제

워크플로 테스트

워크플로 나열 및 필터링