콘텐츠로 이동

목록 조회



GET /api/v1/monitor/mute/list

개요

현재 워크스페이스의 음소거 규칙과 범위, 시간, 알림 설정 및 파생 상태를 조회합니다.

호출 전 및 사용 단계

먼저 type/isEnable 및 유지보수 범위로 필터링한 다음 페이지 단위로 읽습니다. 목록은 업데이트 시간과 생성 시간을 기준으로 내림차순 정렬됩니다. 삭제된 레코드는 반환되지 않으며, 비활성화 및 만료된 규칙도 조회할 수 있습니다.

목록의 workStatus는 파생 표시입니다. 1회성 실행은 start<=현재<end일 때만 active로 표시됩니다. 현재 알고리즘은 end=-1인 종료 없는 1회성 규칙을 expired로 잘못 표시하지만, 실행 측에서는 여전히 사용할 수 있습니다. 반복 규칙의 표시도 전체 start를 먼저 제한하지 않으므로, 미래에 시작되는 규칙이 active로 조기에 표시될 수 있습니다. status, 전체 시간 및 실제 알림 억제 여부를 함께 확인하세요.

규칙은 일치하는 이벤트의 알림 음소거를 제어하며, 이벤트 및 모니터링 데이터는 기존 프로세스에 따라 계속 처리됩니다. muteIncident는 인시던트 알림 확장 기능으로, 현재 공개 쓰기 파라미터에는 포함되어 있지 않습니다. 조정이 필요하면 콘솔에서 작업하세요. 내부 파라미터를 공개 요청 필드로 제출하지 마세요.

반환되는 start/end/repeatExpire는 Unix 초 단위이며, startTime/endTime/repeatExpireTime은 각 규칙의 timezone에 따라 표시됩니다. 반복 설정은 repeatCrontabSet에서 읽을 수 있습니다. 결과가 없으면 data=[]가 반환됩니다.

요청 헤더

파라미터명 유형 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI 인증 자격 증명입니다.
예시: <DF-API-KEY>
가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다.

Query 요청 파라미터

파라미터명 유형 필수 설명
creator commaArray 선택 사항인 생성자 ID UUID이며, 여러 개는 쉼표로 구분합니다.
null 허용: False
예시: wsak_example
가져오기 또는 입력 방법: 기존 목록의 creator 또는 멤버 계정 UUID에서 실제 ID를 가져옵니다.
isEnable commaArray 선택 사항인 활성화/비활성화 필터이며, 생략하면 활성화 및 비활성화 규칙이 모두 포함됩니다.
null 허용: False
예시: 1
가져오기 또는 입력 방법: 1은 활성화, 0은 비활성화이며, 쉼표로 구분하여 동시에 선택할 수 있습니다.
pageIndex integer 선택 사항인 페이지 번호이며, 최소 1, 기본값 1입니다.
null 허용: False
$minValue: 1
예시: 1
가져오기 또는 입력 방법: 1부터 페이지 단위로 읽습니다.
pageSize integer 선택 사항인 페이지당 항목 수이며, 기본값 50입니다.
null 허용: False
$maxValue: 100
$minValue: 1
예시: 50
가져오기 또는 입력 방법: 클라이언트의 페이지 분할 용량에 따라 1-100을 선택합니다.
search string 선택 사항인 키워드이며, 생략하면 키워드로 필터링하지 않습니다.
null 허용: False
예시: 유지보수
가져오기 또는 입력 방법: 규칙 이름의 텍스트로 검색하며, 설명이나 UUID는 검색하지 않습니다.
type commaArray 선택 사항인 유형 필터이며, 여러 개는 쉼표로 구분합니다. 이전 유형에는 monitor가 있을 수 있습니다.
null 허용: False
예시: custom
가져오기 또는 입력 방법: 음소거 범위에 따라 custom/checker/alertPolicy/tag를 선택합니다.
updator commaArray 선택 사항인 최근 업데이트자 ID UUID이며, 여러 개는 쉼표로 구분합니다.
null 허용: False
예시: wsak_example
가져오기 또는 입력 방법: 기존 목록의 updator 또는 멤버 계정 UUID에서 실제 ID를 가져옵니다.
workStatus commaArray 선택 사항인 파생 상태 필터이며, 여러 값은 합집합으로 처리됩니다. 생략하면 모두 포함됩니다. 표시 제한은 사용 설명을 참조하세요.
null 허용: False
예시: pending_activation,active
가져오기 또는 입력 방법: pending_activation/active/expired에서 선택하며, 쉼표로 구분합니다.

요청 예시

curl --get 'https://openapi.guance.com/api/v1/monitor/mute/list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode pageIndex=1 \
  --data-urlencode pageSize=50 \
  --data-urlencode type=custom

응답

HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.

필드 유형 설명
content object 페이지 분할 콘텐츠이며, pageInfo는 응답 최상위에 있습니다.
content.data array<object> 조건에 맞는 음소거 규칙이며, 결과가 없으면 []입니다.
content.data[].id integer 규칙 레코드 번호이며, 작업에는 uuid를 사용합니다.
content.data[].uuid string mute_ 규칙 UUID입니다.
content.data[].workspaceUUID string 소속 워크스페이스입니다.
content.data[].name string 규칙 이름입니다.
content.data[].description string 설명입니다.
content.data[].type string custom/checker/alertPolicy/tag이며, 이전 레코드에는 monitor가 나타날 수도 있습니다.
content.data[].tags object 저장된 필드 값 조건입니다.
content.data[].tags.字段 JSON 해당 이벤트 필드의 일치 값입니다.
content.data[].filterString string 이벤트 속성 조건이며, 비어 있지 않으면 tags보다 우선합니다.
content.data[].muteRanges array<object> 저장된 범위 배열이며, 각 UUID의 의미는 요청 파라미터를 참조하세요.
content.data[].muteRanges[].checkerUUID string 또는 array 모니터 식별자이며, 이전 레코드에서는 배열일 수 있습니다.
content.data[].muteRanges[].sloUUID string 또는 array SLO 식별자이며, 이전 레코드에서는 배열일 수 있습니다.
content.data[].muteRanges[].alertPolicyUUID string 알림 정책 UUID입니다.
content.data[].muteRanges[].tagUUID string 또는 array 모니터 태그 UUID입니다.
content.data[].muteRanges[].name string 표시 이름이며, 생략할 수 있습니다.
content.data[].muteRanges[].type string 표시 유형이며, 생략할 수 있습니다.
content.data[].notifyTargets array<object> 음소거 규칙 알림 대상입니다.
content.data[].notifyTargets[].type string mail/notifyObject/memberGroup입니다.
content.data[].notifyTargets[].to array<string> 해당 유형의 UUID 배열입니다.
content.data[].notifyTargets[].to[] string 단일 대상 UUID입니다.
content.data[].notifyMessage string 음소거 규칙 알림 본문입니다.
content.data[].notifyTime integer 알림 시간(Unix 초)이며, -1은 즉시 의도를 나타내고 실제 발송 여부는 작업에서 판단합니다.
content.data[].notifyTimeStr string timezone에 따라 알림 시각을 포맷하며, 즉시 의도인 경우 빈 문자열입니다.
content.data[].start integer 시작 Unix 초입니다.
content.data[].end integer 1회성 실행 종료 Unix 초이며, -1은 종료 없음입니다.
content.data[].startTime string timezone 기준 YYYY/MM/DD HH:MM:SS입니다.
content.data[].endTime string 동일 형식의 종료 시간이며, end=-1이면 빈 문자열입니다.
content.data[].repeatExpire integer -1은 1회성 실행, 0은 영구 반복, 양수는 주기 종료 Unix 초입니다.
content.data[].repeatExpireTime string -1/0 또는 timezone 기준으로 포맷된 종료 시간입니다.
content.data[].crontab string 반복 시 5개 필드의 Cron 문자열이며, 1회성 실행에서는 일반적으로 비어 있습니다.
content.data[].crontabDuration integer 각 반복 윈도우의 지속 시간(초)입니다.
content.data[].cycleNotifyAt integer 최근 주기 설정 알림 시각(Unix 초)이며, 아직 알림이 없으면 -1입니다.
content.data[].timezone string 규칙 시간대입니다.
content.data[].declaration object 규칙 사용자 지정 선언이며, 이 워크스페이스의 공용 선언이 아닙니다.
content.data[].declaration.自定义字段 JSON 호출자가 저장한 사용자 지정 값입니다.
content.data[].muteIncident boolean 인시던트 알림도 함께 음소거할지 여부입니다. 현재 OpenAPI에는 이 쓰기 파라미터가 선언되어 있지 않습니다. 생성 시 기본값은 false이며, 기존 규칙은 콘솔 설정을 반영할 수 있습니다. alertPolicy 범위는 이 인시던트 매칭을 지원하지 않습니다.
content.data[].status integer 0은 활성화, 2는 비활성화, 3은 삭제입니다. 활성화는 현재 시간대에 이미 적용되었음을 의미하지 않습니다.
content.data[].creator string 생성자 ID입니다.
content.data[].updator string 최근 업데이트자 ID입니다.
content.data[].createAt integer 생성 시간(Unix 초)입니다.
content.data[].updateAt integer 업데이트 시간(Unix 초)이며, 초기값은 -1입니다.
content.data[].deleteAt integer 삭제 시간(Unix 초)이며, 삭제되지 않은 경우 -1입니다.
content.data[].repeatCrontabSet object 목록 조회 및 반복 규칙 생성 시 제공되는 Cron 역파싱 객체이며, 수정 응답에서는 항상 제공되지 않습니다.
content.data[].repeatCrontabSet.min string 해당 Cron 세그먼트입니다.
content.data[].repeatCrontabSet.hour string 해당 Cron 세그먼트입니다.
content.data[].repeatCrontabSet.day string 해당 Cron 세그먼트입니다.
content.data[].repeatCrontabSet.month string 해당 Cron 세그먼트입니다.
content.data[].repeatCrontabSet.week string 해당 Cron 세그먼트입니다.
content.data[].workStatus string pending_activation/active/expired이며, 파생 표시로 사용 설명에 있는 경계 조건이 있습니다.
content.data[].creatorInfo object 고정된 5개 표시 키이며, 일치하는 ID가 없으면 name/username은 null이고 나머지는 빈 문자열입니다.
content.data[].creatorInfo.name string 또는 null 표시 이름입니다.
content.data[].creatorInfo.username string 또는 null 로그인 이름입니다.
content.data[].creatorInfo.acntWsNickname string 또는 null 워크스페이스 닉네임입니다.
content.data[].creatorInfo.email string 또는 null 이메일 또는 시스템 ID 식별자입니다.
content.data[].creatorInfo.iconUrl string 또는 null 프로필 이미지 주소입니다.
content.data[].updatorInfo object 고정된 5개 표시 키이며, 일치하는 ID가 없으면 name/username은 null이고 나머지는 빈 문자열입니다.
content.data[].updatorInfo.name string 또는 null 표시 이름입니다.
content.data[].updatorInfo.username string 또는 null 로그인 이름입니다.
content.data[].updatorInfo.acntWsNickname string 또는 null 워크스페이스 닉네임입니다.
content.data[].updatorInfo.email string 또는 null 이메일 또는 시스템 ID 식별자입니다.
content.data[].updatorInfo.iconUrl string 또는 null 프로필 이미지 주소입니다.
content.allCreatorInfo array<object> 전체 워크스페이스의 삭제되지 않은 규칙과 연결된 ID 후보이며, 현재 필터 및 페이지 분할에 따라 축소되지 않습니다.
content.allCreatorInfo[].uuid string 계정 UUID이며, 생략할 수 있습니다.
content.allCreatorInfo[].status integer 계정 상태입니다.
content.allCreatorInfo[].wsAccountStatus integer 워크스페이스 계정 상태입니다.
content.allCreatorInfo[].username string 로그인 이름입니다.
content.allCreatorInfo[].name string 표시 이름입니다.
content.allCreatorInfo[].iconUrl string 프로필 이미지 URL이며, 생략할 수 있습니다.
content.allCreatorInfo[].email string 이메일 또는 시스템 ID 이름입니다.
content.allCreatorInfo[].mobile string 휴대폰 번호이며, 비어 있을 수 있습니다.
content.allCreatorInfo[].countryCode string 국가/지역 코드이며, 생략할 수 있습니다.
content.allCreatorInfo[].acntWsNickname string 워크스페이스 닉네임이며, 생략할 수 있습니다.
content.allUpdatorInfo array<object> 전체 워크스페이스의 삭제되지 않은 규칙과 연결된 ID 후보이며, 현재 필터 및 페이지 분할에 따라 축소되지 않습니다.
content.allUpdatorInfo[].uuid string 계정 UUID이며, 생략할 수 있습니다.
content.allUpdatorInfo[].status integer 계정 상태입니다.
content.allUpdatorInfo[].wsAccountStatus integer 워크스페이스 계정 상태입니다.
content.allUpdatorInfo[].username string 로그인 이름입니다.
content.allUpdatorInfo[].name string 표시 이름입니다.
content.allUpdatorInfo[].iconUrl string 프로필 이미지 URL이며, 생략할 수 있습니다.
content.allUpdatorInfo[].email string 이메일 또는 시스템 ID 이름입니다.
content.allUpdatorInfo[].mobile string 휴대폰 번호이며, 비어 있을 수 있습니다.
content.allUpdatorInfo[].countryCode string 국가/지역 코드이며, 생략할 수 있습니다.
content.allUpdatorInfo[].acntWsNickname string 워크스페이스 닉네임이며, 생략할 수 있습니다.
content.declaration object 워크스페이스 공용 선언이며, 빈 객체일 수 있습니다.
pageInfo object 페이지 분할 정보입니다.
pageInfo.pageIndex integer 현재 페이지 번호입니다.
pageInfo.pageSize integer 페이지당 항목 수입니다.
pageInfo.count integer 현재 페이지의 실제 항목 수입니다.
pageInfo.totalCount integer 필터 조건에 맞는 총 항목 수입니다.
{
  "code": 200,
  "content": {
    "data": [
      {
        "id": 42,
        "uuid": "mute_example",
        "workspaceUUID": "wksp_example",
        "name": "프로덕션 유지보수 음소거",
        "description": "프로덕션 서비스 유지보수 기간입니다.",
        "type": "custom",
        "tags": {},
        "filterString": "service:checkout-api",
        "muteRanges": [],
        "notifyTargets": [],
        "notifyMessage": "",
        "notifyTime": -1,
        "start": 1795136400,
        "end": 1795140000,
        "repeatExpire": -1,
        "cycleNotifyAt": -1,
        "crontab": "",
        "crontabDuration": 0,
        "declaration": {},
        "muteIncident": false,
        "timezone": "Asia/Shanghai",
        "status": 0,
        "creator": "wsak_example",
        "updator": "",
        "createAt": 1785430800,
        "updateAt": -1,
        "deleteAt": -1,
        "startTime": "2026/11/20 09:00:00",
        "endTime": "2026/11/20 10:00:00",
        "notifyTimeStr": "",
        "repeatExpireTime": "-1",
        "workStatus": "pending_activation",
        "creatorInfo": {
          "name": null,
          "username": null,
          "acntWsNickname": "",
          "email": "",
          "iconUrl": ""
        },
        "updatorInfo": {
          "name": null,
          "username": null,
          "acntWsNickname": "",
          "email": "",
          "iconUrl": ""
        }
      }
    ],
    "allCreatorInfo": [],
    "allUpdatorInfo": [],
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE",
  "pageInfo": {
    "pageIndex": 1,
    "pageSize": 50,
    "count": 1,
    "totalCount": 1
  }
}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 선언되지 않은 Query 파라미터를 사용하거나 파라미터가 규칙을 위반함 파라미터 파싱 실패 Query 파라미터 표 및 예시를 확인하세요.
500 ft.InternalServerError 읽기, 시간 포맷 또는 ID 정보 처리 실패 내부 오류 필터를 좁히고, 계속 실패하면 traceId를 제공하세요.

문서 평가

이 페이지가 도움이 되었나요?