GetIntegrationList

Prev Next

Integration 목록을 조회합니다.

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
POST /cw_fea/real/cw/api/integration/page

Cloud Insight API에서 공통으로 사용하는 헤더에 대한 정보는 Cloud Insight 요청 헤더를 참조해 주십시오.

요청 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
query String Required 조회 키워드
  • 지정한 조건의 Integration만 조회 가능
pageNum Integer Required 페이지 번호
  • 1~N
pageSize Integer Required 페이지 출력 수
  • 1~N

요청 예시는 다음과 같습니다.

curl --location --request POST 'https://cw.apigw.fin-ntruss.com/cw_fea/real/cw/api/integration/page' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
  "query": "****",
  "pageNum": 1,
  "pageSize": 20
}'
Shell

응답 형식을 설명합니다.

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
data Array - Integration 목록 정보
pageNum Integer - 페이지 번호
pageSize Integer - 페이지 출력 개수
totalPages Integer - 전체 페이지 수
totalRecords Integer - 응답 결과 수

data

data에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
headers Object - 호출 헤더
headers.content-type String - 데이터 타입
id String - Integration 아이디
name String - Integration 이름
payload String - 호출 페이로드
  • 변수를 포함한 전송 데이터
type String - Integration 유형
updateTime Integer - Integration 수정 시간(밀리초)
  • Unix Timestamp 형식
url String - 엔드포인트 주소

네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Cloud Insight API 응답 상태 코드를 참조해 주십시오.

응답 예시는 다음과 같습니다.

{
  "data": [
    {
      "headers": {
        "content-type": "application/json; charset=utf-8"
      },
      "id": "111",
      "name": "event test",
      "payload": "{\n\t\"text\": \"#{DOMAIN_CODE} => #{RULE_NAME} 's event is #{EVENT_STATUS}. The condition is #{RESOURCE_NAME} 's #{DIMENSIONS} #{METRIC} #{OPERATOR} #{CRITERIA}. The current value is #{VALUE}\"\n}",
      "type": "OUT_GOING",
      "updateTime": 1682667085590,
      "url": "https://url"
    },
    {
      "headers": {
        "content-type": "application/json; charset=utf-8"
      },
      "id": "222",
      "name": "event test2",
      "payload": "{\n\t\"text\": \"#{DOMAIN_CODE} => #{RULE_NAME} 's event is #{EVENT_STATUS}. The condition is #{RESOURCE_NAME} 's #{DIMENSIONS} #{METRIC} #{OPERATOR} #{CRITERIA}. The current value is #{VALUE}\"\n}",
      "type": "OUT_GOING",
      "updateTime": 1682667085590,
      "url": "https://url"
    }
  ],
  "pageNum": 1,
  "pageSize": 20,
  "totalPages": 1,
  "totalRecords": 2
}
JSON