Checkly(독립 게시자)(미리 보기)
최신 스택을 위한 모니터링 플랫폼은 프로그래밍 가능하고 유연하며 사랑이 많은 JavaScript입니다. 중요한 사이트 트랜잭션을 모니터링하고 유효성을 검사합니다. 실행할 때마다 오류 추적, 스크린샷 및 성능 메트릭을 자동으로 수집합니다.
이 커넥터는 다음 제품 및 지역에서 사용할 수 있습니다.
| 서비스 | 클래스 | Regions |
|---|---|---|
| Copilot Studio | Premium | 다음을 제외한 모든 Power Automate 지역 : - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD) |
| 논리 앱 | 스탠다드 | 다음을 제외한 모든 Logic Apps 지역 : - Azure Government 지역 - Azure 중국 지역 - 미국 국방부(DoD) |
| Power Apps | Premium | 다음을 제외한 모든 Power Apps 지역 : - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD) |
| Power Automate | Premium | 다음을 제외한 모든 Power Automate 지역 : - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD) |
| 연락처 | |
|---|---|
| 이름 | 트로이 테일러 |
| URL | https://www.hitachisolutions.com |
| 전자 메일 | ttaylor@hitachisolutions.com |
| 커넥터 메타데이터 | |
|---|---|
| 게시자 | 트로이 테일러 |
| 웹 사이트 | https://www.checklyhq.com/ |
| 개인 정보 보호 정책 | https://www.checklyhq.com/privacy |
| 카테고리 | IT 운영 |
연결을 만드는 중
커넥터는 다음 인증 유형을 지원합니다.
| 기본값 | 연결을 만들기 위한 매개 변수입니다. | 모든 지역 | 공유할 수 없음 |
기본값
적용 가능: 모든 지역
연결을 만들기 위한 매개 변수입니다.
공유 가능한 연결이 아닙니다. 전원 앱이 다른 사용자와 공유되면 다른 사용자에게 새 연결을 명시적으로 만들라는 메시지가 표시됩니다.
| 이름 | 유형 | Description | 필수 |
|---|---|---|---|
| 계정 ID | 시큐어스트링 (보안 문자열) | 이 API의 계정 ID입니다. | 진실 |
| API 키('Bearer apiKey' 형식) | 시큐어스트링 (보안 문자열) | 이 API에 대한 API 키('Bearer apiKey' 형식) | 진실 |
제한 한도
| Name | 호출 | 갱신 기간 |
|---|---|---|
| 연결당 API 호출 | 100 | 60초 |
동작
| API 검사 만들기 |
새 API 검사를 만듭니다. 계획의 한도를 |
| API 검사 업데이트 |
API 검사를 업데이트합니다. |
| 개인 위치 검색 |
특정 개인 위치의 세부 정보를 표시합니다. |
| 개인 위치 업데이트 |
개인 위치를 업데이트합니다. |
| 개인 위치 제거 |
프라이빗 위치를 영구적으로 제거합니다. |
| 검사 결과 검색 |
특정 검사 결과의 세부 정보를 표시합니다. |
| 검사 및 검사 그룹에 대한 집계 통계를 사용하여 보고서를 생성합니다. |
지정된 기간 동안 모든 검사 또는 필터링된 검사 집합에 대해 집계된 통계가 있는 보고서를 생성합니다. |
| 검사 업데이트 [사용되지 않음] |
[사용되지 않음] 이 엔드포인트는 2022년 7월 4일 월요일에 제거됩니다. 대신 |
| 경고 채널 검색 |
특정 경고 채널의 세부 정보를 표시합니다. |
| 경고 채널 만들기 |
새 경고 채널을 만듭니다. |
| 경고 채널 삭제 |
경고 채널을 영구적으로 제거합니다. |
| 경고 채널 업데이트 |
경고 채널을 업데이트합니다. |
| 경고 채널의 구독 업데이트 |
경고 채널의 구독을 업데이트합니다. 이 기능을 사용하여 경고 채널에 검사를 추가하면 해당 확인에 대한 오류 및 복구 경고가 전송됩니다. 참고: 구독 개체를 전달할 때 checkId 또는 groupId만 지정할 수 있으며 둘 다 지정할 수 없습니다. |
| 계정에 대한 모든 경고 나열 |
계정에 대한 모든 경고를 나열합니다. |
| 그룹 상태 배지 가져오기 |
그룹 상태 배지를 가져옵니다. |
| 그룹 설정이 적용된 특정 그룹에서 한 번의 확인 검색 |
그룹 설정이 적용된 특정 확인 그룹에서 한 가지 확인의 세부 정보를 표시합니다. |
| 그룹 설정이 적용된 특정 그룹의 모든 검사 검색 |
그룹 설정이 적용된 특정 확인 그룹의 모든 검사를 나열합니다. |
| 그룹 확인 트리거 가져오기 |
그룹 확인 트리거를 찾습니다. |
| 그룹 확인 트리거 삭제 |
확인 그룹 트리거를 삭제합니다. |
| 대시보드 만들기 |
새 대시보드를 만듭니다. 이미 가져온 사용자 지정 URL 또는 사용자 지정 도메인을 사용하여 대시보드를 만들려고 할 때 409를 반환합니다. |
| 대시보드 삭제 |
대시보드를 영구적으로 제거합니다. |
| 대시보드 업데이트 |
대시보드를 업데이트합니다. 이미 가져온 사용자 지정 URL 또는 사용자 지정 도메인을 사용하여 대시보드를 만들려고 할 때 409를 반환합니다. |
| 모든 개인 위치 나열 |
계정의 모든 개인 위치를 나열합니다. |
| 모든 검사 결과를 나열합니다. |
특정 검사에 대한 전체 원시 검사 결과를 나열합니다. 30일 동안 원시 결과를 유지합니다. 30일이 지나면 지워집니다. 그러나 롤업 결과를 무기한 유지합니다. 검사 유형 및 결과 형식을 필터링하여 목록의 범위를 좁힐 수 있습니다. 날짜 범위( |
| 모든 검사 나열 |
계정의 모든 현재 검사를 나열합니다. |
| 모든 경고 채널 나열 |
구성된 모든 경고 채널과 구독된 검사를 나열합니다. |
| 모든 대시보드 나열 |
계정의 모든 현재 대시보드를 나열합니다. |
| 모든 브라우저 검사 메트릭에 대해 사용자 지정 가능한 보고서를 생성합니다. |
지정된 기간 동안 특정 브라우저 검사에 대해 집계되거나 집계되지 않은 통계가 있는 보고서를 생성합니다. |
| 모든 유지 관리 기간 나열 |
계정의 모든 유지 관리 기간을 나열합니다. |
| 모든 코드 조각 나열 |
계정의 모든 현재 코드 조각을 나열합니다. |
| 모든 확인 그룹 나열 |
계정의 모든 현재 확인 그룹을 나열합니다. check 속성은 편리한 참조를 위해 UUID 검사의 배열입니다. 읽기 전용이며 그룹에 검사를 추가하는 데 사용할 수 없습니다. |
| 모든 확인 상태 나열 |
계정의 모든 검사에 대한 현재 상태 정보를 표시합니다. 새 검사 결과가 들어오면 검사 상태 레코드가 지속적으로 업데이트됩니다. |
| 모든 환경 변수 나열 |
계정의 모든 현재 환경 변수를 나열합니다. |
| 브라우저 검사 업데이트 |
브라우저 검사를 업데이트합니다. |
| 브라우저 확인 만들기 |
새 브라우저 검사를 만듭니다. 계획의 한도를 |
| 상태 세부 정보 확인 검색 |
특정 검사에 대한 현재 상태 정보를 표시합니다. |
| 상태 확인 배지 가져오기 |
상태 확인 배지를 가져옵니다. |
| 시간 창에서 프라이빗 위치 상태 메트릭 가져오기 |
시간 창에서 개인 위치 상태 메트릭을 가져옵니다. |
| 유지 관리 기간 검색 |
특정 유지 관리 기간의 세부 정보를 표시합니다. |
| 유지 관리 기간 만들기 |
새 유지 관리 기간을 만듭니다. |
| 유지 관리 기간 삭제 |
유지 관리 기간을 영구적으로 제거합니다. |
| 유지 관리 기간 업데이트 |
유지 관리 기간을 업데이트합니다. |
| 지원되는 모든 런타임을 나열합니다. |
지원되는 모든 런타임 및 API 검사에 대한 브라우저 검사 및 설정 및 해체 스크립트에 대해 포함된 NPM 패키지를 나열합니다. |
| 지원되는 모든 위치를 나열합니다. |
지원되는 모든 위치를 나열합니다. |
| 코드 조각 검색 |
특정 코드 조각의 세부 정보를 표시합니다. |
| 코드 조각 만들기 |
새 코드 조각을 만듭니다. |
| 코드 조각 삭제 |
코드 조각을 영구적으로 제거합니다. |
| 코드 조각 업데이트 |
코드 조각을 업데이트합니다. |
| 특정 검사에 대한 경고 나열 |
특정 검사에 대한 모든 경고를 나열합니다. |
| 특정 런타임에 대한 세부 정보를 표시합니다. |
포함된 모든 NPM 패키지의 세부 정보와 특정 런타임에 대한 해당 버전을 보여 줍니다. |
| 프라이빗 위치 만들기 |
새 개인 위치를 만듭니다. |
| 프라이빗 위치에 대한 기존 API 키 제거 |
프라이빗 위치에서 api 키를 영구적으로 제거합니다. |
| 프라이빗 위치에 대한 새 API 키 생성 |
프라이빗 위치에 api 키를 만듭니다. |
| 확인 검색 |
특정 API 또는 브라우저 검사의 세부 정보를 표시합니다. |
| 확인 그룹 검색 |
특정 확인 그룹의 세부 정보를 표시합니다. |
| 확인 그룹 만들기 |
새 확인 그룹을 만듭니다. 개별 검사의 groupId 속성을 설정하여 그룹에 검사를 추가할 수 있습니다. |
| 확인 그룹 삭제 |
확인 그룹을 영구적으로 제거합니다. 검사 그룹이 여전히 포함된 경우에는 삭제할 수 없습니다. |
| 확인 그룹 업데이트 |
확인 그룹을 업데이트합니다. |
| 확인 그룹 트리거 만들기 |
확인 그룹 트리거를 만듭니다. |
| 확인 만들기 [사용되지 않음] |
[사용되지 않음] 이 엔드포인트는 2022년 7월 4일 월요일에 제거됩니다. 대신 |
| 확인 삭제 |
API 또는 브라우저 검사 및 모든 관련 상태 및 결과 데이터를 영구적으로 제거합니다. |
| 확인 트리거 가져오기 |
확인 트리거를 찾습니다. |
| 확인 트리거 만들기 |
확인 트리거를 만듭니다. |
| 확인 트리거 삭제 |
확인 트리거를 삭제합니다. |
| 환경 변수 검색 |
특정 환경 변수의 세부 정보를 표시합니다. 선택 영역에 키 필드를 사용합니다. |
| 환경 변수 만들기 |
새 환경 변수를 만듭니다. |
| 환경 변수 삭제 |
환경 변수를 영구적으로 제거합니다. 키 필드를 삭제 식별자로 사용합니다. |
| 환경 변수 업데이트 |
환경 변수를 업데이트합니다. 키 필드를 업데이트할 식별자로 사용합니다. 값 및 잠긴 속성만 업데이트합니다. |
API 검사 만들기
새 API 검사를 만듭니다. 계획의 한도를 402 초과하면 반환됩니다. 를 사용하는 경우 다음을 globalAlertSettingalertSetting 수행할 수 있습니다.null
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
경고 자동 할당
|
autoAssignAlerts | boolean |
새 검사가 생성될 때 모든 기존 경고 채널에 구독자로 자동으로 추가되는지 여부를 결정합니다. |
|
|
이름
|
name | True | string |
확인의 이름입니다. |
|
활성화
|
activated | True | boolean |
검사가 실행 중인지 여부를 확인합니다. |
|
음소거
|
muted | boolean |
확인이 실패하거나 복구될 때 알림을 보낼지 여부를 결정합니다. |
|
|
두 번 확인
|
doubleCheck | boolean |
이 값을 true로 설정하면 실패한 지역과 임의로 선택한 다른 지역에서 검사가 실패할 때 다시 시도가 트리거됩니다. |
|
|
실패해야 합니다.
|
shouldFail | boolean |
검사 실패로 간주되는 경우의 동작을 반전할 수 있습니다. 404와 같은 오류 상태의 유효성을 검사할 수 있습니다. |
|
|
위치 목록 확인
|
locations | array of string |
이 검사를 실행할 하나 이상의 데이터 센터 위치 배열입니다. |
|
|
태그 목록 확인
|
tags | array of string |
검사를 구성하고 필터링하기 위한 태그입니다. |
|
|
에스컬레이션 유형
|
escalationType | string |
사용할 에스컬레이션 유형을 결정합니다. |
|
|
실패한 실행 임계값
|
failedRunThreshold | number |
실패한 연속 검사 실행 횟수 후 경고 알림을 보내야 합니다. |
|
|
분 실패 임계값
|
minutesFailingThreshold | number |
검사가 시작된 후 몇 분이 지나면 경고를 보내야 합니다. |
|
|
금액
|
amount | number |
초기 경고 알림 후에 보낼 미리 알림 수입니다. |
|
|
간격
|
interval | number |
미리 알림을 보내야 하는 간격입니다. |
|
|
활성화됨
|
enabled | boolean |
만료되는 SSL 인증서에 대해 경고 알림을 보내야 하는지 여부를 결정합니다. |
|
|
경고 임계값
|
alertThreshold | integer |
SSL 인증서에 대한 경고를 시작할 시점입니다. |
|
|
전역 경고 설정 사용
|
useGlobalAlertSettings | boolean |
true이면 이 검사에 정의된 경고 설정이 아니라 계정 수준 경고 설정이 사용됩니다. |
|
|
그룹 아이디
|
groupId | number |
이 검사의 일부인 확인 그룹의 식별자입니다. |
|
|
그룹 순서
|
groupOrder | number |
확인 그룹에서 이 확인의 위치입니다. 그룹이 API 또는 CI/CD에서 트리거될 때 실행되는 순서 검사를 결정합니다. |
|
|
런타임 ID
|
runtimeId | string |
런타임 버전(예: 이 검사를 실행하는 데 사용되는 런타임 종속성 집합 고정)입니다. |
|
|
경고 채널 ID
|
alertChannelId | True | number |
경고 채널 식별자입니다. |
|
활성화
|
activated | True | boolean |
활성화 여부입니다. |
|
method
|
method | True | string | |
|
URL
|
url | True | string |
URL 주소입니다. |
|
리디렉션 팔로우
|
followRedirects | boolean |
리디렉션을 따르는지 여부입니다. |
|
|
SSL 건너뛰기
|
skipSSL | boolean |
SSL을 건너뛸지 여부입니다. |
|
|
몸
|
body | string |
본문입니다. |
|
|
bodyType
|
bodyType | string | ||
|
Key
|
key | True | string |
열쇠. |
|
가치
|
value | True | string |
값입니다. |
|
잠김
|
locked | boolean |
잠겨 있는지 여부입니다. |
|
|
출처
|
source | string |
원본입니다. |
|
|
재산
|
property | string |
속성입니다. |
|
|
Comparison
|
comparison | string |
비교입니다. |
|
|
목표/타겟
|
target | string |
대상입니다. |
|
|
사용자 이름
|
username | True | string |
사용자 이름입니다. |
|
암호
|
password | True | string |
암호입니다. |
|
빈도
|
frequency | integer |
수표가 몇 분 안에 실행되는 빈도입니다. |
|
|
코드 조각 ID 분해
|
tearDownSnippetId | number |
API 검사의 중단 단계에서 사용할 코드 조각에 대한 식별자 참조입니다. |
|
|
코드 조각 ID 설정
|
setupSnippetId | number |
API 검사의 설정 단계에서 사용할 코드 조각에 대한 식별자 참조입니다. |
|
|
빈도 오프셋
|
frequencyOffset | integer |
1분 미만의 빈도 확인에 초를 설정하고 1분 이상 빈도에 대한 시간 범위에 검사를 분산하는 데 사용됩니다. 이는 다음과 같이 작동합니다. 빈도가 0인 검사는 frequencyOffset이 10, 20 또는 30일 수 있으므로 10초, 20초 또는 30초마다 실행됩니다. 빈도가 60보다 낮고 같은 검사는 수식 Math.floor(frequency * 10)를 기반으로 1에서 최대값 사이의 frequencyOffset을 가질 수 있습니다. 즉, 5분마다 실행되는 검사의 경우 max frequencyOffset은 50입니다. 빈도가 60보다 높은 검사는 Math.ceil(frequency/60) 수식을 기준으로 1에서 최대값 사이의 frequencyOffset을 가질 수 있습니다. 즉, 720분마다 실행되는 검사의 경우 최대 frequencyOffset은 12입니다. |
|
|
로컬 설치 스크립트
|
localSetupScript | string |
설치 단계에서 실행할 유효한 Node.js 코드 조각입니다. |
|
|
로컬 중단 스크립트
|
localTearDownScript | string |
해체 단계에서 실행할 유효한 Node.js 코드 조각입니다. |
|
|
응답 시간 저하
|
degradedResponseTime | number |
확인을 저하된 것으로 간주해야 하는 응답 시간(밀리초)입니다. |
|
|
최대 응답 시간
|
maxResponseTime | number |
검사 실패로 간주되어야 하는 응답 시간(밀리초)입니다. |
|
|
프라이빗 위치
|
privateLocations | array of string |
검사를 실행할 하나 이상의 개인 위치 배열입니다. |
반환
- 몸
- CheckAPI
API 검사 업데이트
API 검사를 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
아이디
|
id | True | string |
식별자입니다. |
|
경고 자동 할당
|
autoAssignAlerts | boolean |
새 검사가 생성될 때 모든 기존 경고 채널에 구독자로 자동으로 추가되는지 여부를 결정합니다. |
|
|
이름
|
name | string |
확인의 이름입니다. |
|
|
활성화
|
activated | boolean |
검사가 실행 중인지 여부를 확인합니다. |
|
|
음소거
|
muted | boolean |
확인이 실패하거나 복구될 때 알림을 보낼지 여부를 결정합니다. |
|
|
두 번 확인
|
doubleCheck | boolean |
이 값을 true로 설정하면 실패한 지역과 임의로 선택한 다른 지역에서 검사가 실패할 때 다시 시도가 트리거됩니다. |
|
|
실패해야 합니다.
|
shouldFail | boolean |
검사 실패로 간주되는 경우의 동작을 반전할 수 있습니다. 404와 같은 오류 상태의 유효성을 검사할 수 있습니다. |
|
|
위치 목록 확인
|
locations | array of string |
이 검사를 실행할 하나 이상의 데이터 센터 위치 배열입니다. |
|
|
태그 목록 확인
|
tags | array of string |
검사를 구성하고 필터링하기 위한 태그입니다. |
|
|
에스컬레이션 유형
|
escalationType | string |
사용할 에스컬레이션 유형을 결정합니다. |
|
|
실패한 실행 임계값
|
failedRunThreshold | number |
실패한 연속 검사 실행 횟수 후 경고 알림을 보내야 합니다. |
|
|
분 실패 임계값
|
minutesFailingThreshold | number |
검사가 시작된 후 몇 분이 지나면 경고를 보내야 합니다. |
|
|
금액
|
amount | number |
초기 경고 알림 후에 보낼 미리 알림 수입니다. |
|
|
간격
|
interval | number |
미리 알림을 보내야 하는 간격입니다. |
|
|
활성화됨
|
enabled | boolean |
만료되는 SSL 인증서에 대해 경고 알림을 보내야 하는지 여부를 결정합니다. |
|
|
경고 임계값
|
alertThreshold | integer |
SSL 인증서에 대한 경고를 시작할 시점입니다. |
|
|
전역 경고 설정 사용
|
useGlobalAlertSettings | boolean |
true이면 이 검사에 정의된 경고 설정이 아니라 계정 수준 경고 설정이 사용됩니다. |
|
|
그룹 아이디
|
groupId | number |
이 검사의 일부인 확인 그룹의 식별자입니다. |
|
|
그룹 순서
|
groupOrder | number |
확인 그룹에서 이 확인의 위치입니다. 그룹이 API 또는 CI/CD에서 트리거될 때 실행되는 순서 검사를 결정합니다. |
|
|
런타임 ID
|
runtimeId | string |
런타임 버전(예: 이 검사를 실행하는 데 사용되는 런타임 종속성 집합 고정)입니다. |
|
|
경고 채널 ID
|
alertChannelId | True | number |
경고 채널 식별자입니다. |
|
활성화
|
activated | True | boolean |
활성화 여부입니다. |
|
method
|
method | True | string | |
|
URL
|
url | True | string |
URL 주소입니다. |
|
리디렉션 따르기
|
followRedirects | boolean |
리디렉션을 따를지 여부입니다. |
|
|
SSL 건너뛰기
|
skipSSL | boolean |
SSL을 건너뛸지 여부입니다. |
|
|
몸
|
body | string |
본문입니다. |
|
|
체격 유형
|
bodyType | string |
본문 유형입니다. |
|
|
Key
|
key | True | string |
열쇠. |
|
가치
|
value | True | string |
값입니다. |
|
잠김
|
locked | boolean |
잠겨 있는지 여부입니다. |
|
|
출처
|
source | string |
원본입니다. |
|
|
재산
|
property | string |
속성입니다. |
|
|
Comparison
|
comparison | string |
비교입니다. |
|
|
목표/타겟
|
target | string |
대상입니다. |
|
|
사용자 이름
|
username | True | string |
사용자 이름입니다. |
|
암호
|
password | True | string |
암호입니다. |
|
빈도
|
frequency | integer |
수표가 몇 분 안에 실행되는 빈도입니다. |
|
|
코드 조각 ID 분해
|
tearDownSnippetId | number |
API 검사의 중단 단계에서 사용할 코드 조각에 대한 식별자 참조입니다. |
|
|
코드 조각 ID 설정
|
setupSnippetId | number |
API 검사의 설정 단계에서 사용할 코드 조각에 대한 식별자 참조입니다. |
|
|
빈도 오프셋
|
frequencyOffset | integer |
1분 미만의 빈도 확인에 초를 설정하고 1분 이상 빈도에 대한 시간 범위에 검사를 분산하는 데 사용됩니다. 이는 다음과 같이 작동합니다. 빈도가 0인 검사는 frequencyOffset이 10, 20 또는 30일 수 있으므로 10초, 20초 또는 30초마다 실행됩니다. 빈도가 60보다 낮고 같은 검사는 수식 Math.floor(frequency * 10)를 기반으로 1에서 최대값 사이의 frequencyOffset을 가질 수 있습니다. 즉, 5분마다 실행되는 검사의 경우 max frequencyOffset은 50입니다. 빈도가 60보다 높은 검사는 Math.ceil(frequency/60) 수식을 기준으로 1에서 최대값 사이의 frequencyOffset을 가질 수 있습니다. 즉, 720분마다 실행되는 검사의 경우 최대 frequencyOffset은 12입니다. |
|
|
로컬 설치 스크립트
|
localSetupScript | string |
설치 단계에서 실행할 유효한 Node.js 코드 조각입니다. |
|
|
로컬 중단 스크립트
|
localTearDownScript | string |
해체 단계에서 실행할 유효한 Node.js 코드 조각입니다. |
|
|
응답 시간 저하
|
degradedResponseTime | number |
확인을 저하된 것으로 간주해야 하는 응답 시간(밀리초)입니다. |
|
|
최대 응답 시간
|
maxResponseTime | number |
검사 실패로 간주되어야 하는 응답 시간(밀리초)입니다. |
|
|
프라이빗 위치
|
privateLocations | array of string |
검사를 실행할 하나 이상의 개인 위치 배열입니다. |
반환
- 몸
- CheckAPI
개인 위치 검색
특정 개인 위치의 세부 정보를 표시합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
아이디
|
id | True | string |
식별자입니다. |
반환
개인 위치 업데이트
개인 위치를 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
아이디
|
id | True | string |
식별자입니다. |
|
이름
|
name | True | string |
개인 위치에 할당된 이름입니다. |
|
Icon
|
icon | string |
아이콘입니다. |
반환
개인 위치 제거
프라이빗 위치를 영구적으로 제거합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
아이디
|
id | True | string |
식별자입니다. |
검사 결과 검색
특정 검사 결과의 세부 정보를 표시합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
ID 확인
|
checkId | True | string |
확인 식별자입니다. |
|
결과 ID 확인
|
checkResultId | True | string |
검사 결과 식별자입니다. |
반환
검사 및 검사 그룹에 대한 집계 통계를 사용하여 보고서를 생성합니다.
지정된 기간 동안 모든 검사 또는 필터링된 검사 집합에 대해 집계된 통계가 있는 보고서를 생성합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
부터
|
from | date |
unix 타임스탬프 형식의 보고 창의 사용자 지정 시작 시간입니다. 타임스탬프에서 사용자 지정을 설정하면 presetWindow의 사용이 재정의됩니다. |
|
|
에게
|
to | date |
보고 창의 사용자 지정 종료 시간(unix 타임스탬프 형식) 사용자 지정을 타임스탬프로 설정하면 presetWindow의 사용이 재정의됩니다. |
|
|
미리 설정된 창
|
presetWindow | string |
미리 설정된 보고 창은 일반적으로 사용되는 창에서 보고서를 빠르게 생성하는 데 사용됩니다. 타임스탬프에서 사용자 지정을 사용하여 재정의할 수 있습니다. |
|
|
태그로 필터링
|
filterByTags | array |
태그를 사용하여 보고서에 표시할 검사를 필터링합니다. |
|
|
비활성화
|
deactivated | boolean |
활성화된 상태별로 검사를 필터링합니다. |
반환
- 아이템
- ReportingList
검사 업데이트 [사용되지 않음]
[사용되지 않음] 이 엔드포인트는 2022년 7월 4일 월요일에 제거됩니다. 대신 PUT /checks/api/{id} 또는 PUT /checks/browser/{id}를 사용합니다. 새 API 또는 브라우저 검사를 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
아이디
|
id | True | string |
식별자입니다. |
|
경고 자동 할당
|
autoAssignAlerts | boolean |
새 검사가 생성될 때 모든 기존 경고 채널에 구독자로 자동으로 추가되는지 여부를 결정합니다. |
|
|
이름
|
name | string |
확인의 이름입니다. |
|
|
활성화
|
activated | boolean |
검사가 실행 중인지 여부를 확인합니다. |
|
|
음소거
|
muted | boolean |
확인이 실패하거나 복구될 때 알림을 보낼지 여부를 결정합니다. |
|
|
두 번 확인
|
doubleCheck | boolean |
이 값을 true로 설정하면 실패한 지역과 임의로 선택한 다른 지역에서 검사가 실패할 때 다시 시도가 트리거됩니다. |
|
|
실패해야 합니다.
|
shouldFail | boolean |
검사 실패로 간주되는 경우의 동작을 반전할 수 있습니다. 404와 같은 오류 상태의 유효성을 검사할 수 있습니다. |
|
|
위치 목록 확인
|
locations | array of string |
이 검사를 실행할 하나 이상의 데이터 센터 위치 배열입니다. |
|
|
태그 목록 확인
|
tags | array of string |
검사를 구성하고 필터링하기 위한 태그입니다. |
|
|
에스컬레이션 유형
|
escalationType | string |
사용할 에스컬레이션 유형을 결정합니다. |
|
|
실패한 실행 임계값
|
failedRunThreshold | number |
실패한 연속 검사 실행 횟수 후 경고 알림을 보내야 합니다. |
|
|
분 실패 임계값
|
minutesFailingThreshold | number |
검사가 시작된 후 몇 분이 지나면 경고를 보내야 합니다. |
|
|
금액
|
amount | number |
초기 경고 알림 후에 보낼 미리 알림 수입니다. |
|
|
간격
|
interval | number |
미리 알림을 보내야 하는 간격입니다. |
|
|
활성화됨
|
enabled | boolean |
만료되는 SSL 인증서에 대해 경고 알림을 보내야 하는지 여부를 결정합니다. |
|
|
경고 임계값
|
alertThreshold | integer |
SSL 인증서에 대한 경고를 시작할 시점입니다. |
|
|
전역 경고 설정 사용
|
useGlobalAlertSettings | boolean |
true이면 이 검사에 정의된 경고 설정이 아니라 계정 수준 경고 설정이 사용됩니다. |
|
|
그룹 아이디
|
groupId | number |
이 검사의 일부인 확인 그룹의 식별자입니다. |
|
|
그룹 순서
|
groupOrder | number |
확인 그룹에서 이 확인의 위치입니다. 그룹이 API 또는 CI/CD에서 트리거될 때 실행되는 순서 검사를 결정합니다. |
|
|
런타임 ID
|
runtimeId | string |
런타임 버전(예: 이 검사를 실행하는 데 사용되는 런타임 종속성 집합 고정)입니다. |
|
|
경고 채널 ID
|
alertChannelId | True | number |
경고 채널 식별자입니다. |
|
활성화
|
activated | True | boolean |
활성화 여부입니다. |
|
확인 유형
|
checkType | string |
확인의 형식입니다. |
|
|
빈도
|
frequency | integer |
수표가 몇 분 안에 실행되는 빈도입니다. |
|
|
빈도 오프셋
|
frequencyOffset | integer |
1분 미만의 검사 빈도에 초를 설정하고(API 검사에만 해당) 1분 이상 빈도에 대한 시간 범위에 대한 검사를 분산하는 데 사용됩니다. 이는 다음과 같이 작동합니다. 빈도가 0인 검사는 frequencyOffset이 10, 20 또는 30일 수 있으므로 10초, 20초 또는 30초마다 실행됩니다. 빈도가 60보다 낮고 같은 검사는 수식 Math.floor(frequency * 10)를 기반으로 1에서 최대값 사이의 frequencyOffset을 가질 수 있습니다. 즉, 5분마다 실행되는 검사의 경우 max frequencyOffset은 50입니다. 빈도가 60보다 높은 검사는 Math.ceil(frequency/60) 수식을 기준으로 1에서 최대값 사이의 frequencyOffset을 가질 수 있습니다. 즉, 720분마다 실행되는 검사의 경우 최대 frequencyOffset은 12입니다. |
|
|
요청 확인
|
request | True | object |
확인 요청입니다. |
|
스크립트
|
script | True | string |
스크립트입니다. |
|
Key
|
key | True | string |
환경 변수의 키입니다(이 값은 변경할 수 없음). |
|
가치
|
value | True | string |
환경 변수의 값입니다. |
|
잠김
|
locked | boolean |
UI에서만 암호와 같은 값을 숨기는 데 사용됩니다. |
|
|
코드 조각 ID 설정
|
setupSnippetId | number |
API 검사의 설정 단계에서 사용할 코드 조각에 대한 식별자 참조입니다. |
|
|
코드 조각 ID 분해
|
tearDownSnippetId | number |
API 검사의 중단 단계에서 사용할 코드 조각에 대한 식별자 참조입니다. |
|
|
로컬 설치 스크립트
|
localSetupScript | string |
설치 단계에서 실행할 유효한 Node.js 코드 조각입니다. |
|
|
로컬 중단 스크립트
|
localTearDownScript | string |
해체 단계에서 실행할 유효한 Node.js 코드 조각입니다. |
|
|
응답 시간 저하
|
degradedResponseTime | number |
확인을 저하된 것으로 간주해야 하는 응답 시간(밀리초)입니다. |
|
|
최대 응답 시간
|
maxResponseTime | number |
검사 실패로 간주되어야 하는 응답 시간(밀리초)입니다. |
|
|
프라이빗 위치
|
privateLocations | array of string |
검사를 실행할 하나 이상의 개인 위치 배열입니다. |
반환
- 몸
- Check
경고 채널 검색
특정 경고 채널의 세부 정보를 표시합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
아이디
|
id | True | integer |
식별자입니다. |
반환
경고 채널 만들기
새 경고 채널을 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
아이디
|
id | number |
식별자입니다. |
|
|
ID 확인
|
checkId | guid |
확인 식별자입니다. |
|
|
그룹 아이디
|
groupId | number |
그룹 식별자입니다. |
|
|
활성화
|
activated | True | boolean |
활성화 여부입니다. |
|
유형
|
type | True | string |
형식입니다. |
|
경고 채널 구성 만들기
|
config | True | object |
경고 채널은 구성을 만듭니다. |
|
복구 보내기
|
sendRecovery | boolean |
복구 보내기 여부입니다. |
|
|
송신 실패
|
sendFailure | boolean |
전송 실패 여부입니다. |
|
|
성능 저하된 보내기
|
sendDegraded | boolean |
전송 성능이 저하되었는지 여부입니다. |
|
|
SSL 만료
|
sslExpiry | boolean |
만료되는 SSL 인증서에 대한 경고를 보내야 하는지 여부를 결정합니다. |
|
|
SSL 만료 임계값
|
sslExpiryThreshold | integer |
SSL 인증서에 대한 경고를 시작할 시점입니다. |
반환
경고 채널 삭제
경고 채널을 영구적으로 제거합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
아이디
|
id | True | integer |
식별자입니다. |
경고 채널 업데이트
경고 채널을 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
아이디
|
id | True | integer |
식별자입니다. |
|
아이디
|
id | number |
식별자입니다. |
|
|
ID 확인
|
checkId | guid |
확인 식별자입니다. |
|
|
그룹 아이디
|
groupId | number |
그룹 식별자입니다. |
|
|
활성화
|
activated | True | boolean |
활성화 여부입니다. |
|
유형
|
type | True | string |
형식입니다. |
|
경고 채널 구성 만들기
|
config | True | object |
경고 채널은 구성을 만듭니다. |
|
복구 보내기
|
sendRecovery | boolean |
복구 보내기 여부입니다. |
|
|
송신 실패
|
sendFailure | boolean |
전송 실패 여부입니다. |
|
|
성능 저하된 보내기
|
sendDegraded | boolean |
전송 성능이 저하되었는지 여부입니다. |
|
|
SSL 만료
|
sslExpiry | boolean |
만료되는 SSL 인증서에 대한 경고를 보내야 하는지 여부를 결정합니다. |
|
|
SSL 만료 임계값
|
sslExpiryThreshold | integer |
SSL 인증서에 대한 경고를 시작할 시점입니다. |
반환
경고 채널의 구독 업데이트
경고 채널의 구독을 업데이트합니다. 이 기능을 사용하여 경고 채널에 검사를 추가하면 해당 확인에 대한 오류 및 복구 경고가 전송됩니다. 참고: 구독 개체를 전달할 때 checkId 또는 groupId만 지정할 수 있으며 둘 다 지정할 수 없습니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
아이디
|
id | True | integer |
식별자입니다. |
|
ID 확인
|
checkId | guid |
checkId 또는 groupId를 전달할 수 있지만 둘 다 전달할 수는 없습니다. |
|
|
그룹 아이디
|
groupId | number |
checkId 또는 groupId를 전달할 수 있지만 둘 다 전달할 수는 없습니다. |
|
|
활성화
|
activated | True | boolean |
활성화 여부입니다. |
반환
계정에 대한 모든 경고 나열
계정에 대한 모든 경고를 나열합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
한계
|
limit | integer |
결과 수를 제한합니다. |
|
|
Number
|
page | number |
페이지 번호입니다. |
|
|
부터
|
from | date |
이 UNIX 타임스탬프(>= 날짜)에서 문서를 선택합니다. 기본값은 지금 - 6시간입니다. |
|
|
에게
|
to | date |
이 UNIX 타임스탬프(< 날짜)까지 경고를 선택합니다. 기본값은 6시간 후입니다. |
반환
- 아이템
- CheckAlertList
그룹 상태 배지 가져오기
그룹 상태 배지를 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
그룹 아이디
|
groupId | True | integer |
그룹 식별자입니다. |
|
스타일
|
style | string |
스타일입니다. |
|
|
Theme
|
theme | string |
테마입니다. |
|
|
응답 시간
|
responseTime | boolean |
응답 시간입니다. |
반환
- response
- string
그룹 설정이 적용된 특정 그룹에서 한 번의 확인 검색
그룹 설정이 적용된 특정 확인 그룹에서 한 가지 확인의 세부 정보를 표시합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
그룹 아이디
|
groupId | True | integer |
그룹 식별자입니다. |
|
ID 확인
|
checkId | True | string |
확인 식별자입니다. |
반환
그룹 설정이 적용된 특정 그룹의 모든 검사 검색
그룹 설정이 적용된 특정 확인 그룹의 모든 검사를 나열합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
아이디
|
id | True | integer |
식별자입니다. |
|
한계
|
limit | integer |
결과 수를 제한합니다. |
|
|
Number
|
page | number |
페이지 번호입니다. |
반환
- 아이템
- Model8
그룹 확인 트리거 가져오기
그룹 확인 트리거를 찾습니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
그룹 아이디
|
groupId | True | integer |
그룹 식별자입니다. |
반환
그룹 확인 트리거 삭제
확인 그룹 트리거를 삭제합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
그룹 아이디
|
groupId | True | integer |
그룹 식별자입니다. |
대시보드 만들기
새 대시보드를 만듭니다. 이미 가져온 사용자 지정 URL 또는 사용자 지정 도메인을 사용하여 대시보드를 만들려고 할 때 409를 반환합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
사용자 지정 URL
|
customUrl | string |
checklyhq.com 아래의 하위 도메인 이름입니다. 모든 사용자 간에 고유해야 합니다. |
|
|
사용자 지정 도메인
|
customDomain | string |
사용자 지정 사용자 도메인(예: status.example.com) DNS 및 SSL 사용량 업데이트에 대한 문서를 참조하세요. |
|
|
로고
|
logo | string |
이미지 파일을 가리키는 URL입니다. |
|
|
파비콘 (사이트 아이콘)
|
favicon | string |
대시보드 favicon으로 사용되는 이미지 파일을 가리키는 URL입니다. |
|
|
Link
|
link | string |
대시보드 로고를 클릭할 때 리디렉션할 URL 링크입니다. |
|
|
Header
|
header | string |
대시보드의 맨 위에 표시되는 텍스트 조각입니다. |
|
|
Description
|
description | string |
대시보드의 머리글 또는 제목 아래에 표시되는 텍스트 조각입니다. |
|
|
너비
|
width | string |
전체 화면 또는 포커스를 가운데에 사용할지 여부를 결정합니다. |
|
|
재생 빈도
|
refreshRate | number |
몇 초 안에 대시보드를 새로 고치는 빈도입니다. |
|
|
페이지 매김
|
paginate | boolean |
페이지 매김이 켜지거나 꺼져 있는지 확인합니다. |
|
|
페이지 매김 비율
|
paginationRate | number |
페이지 매김을 트리거하는 빈도(초)입니다. |
|
|
페이지당 검사
|
checksPerPage | number |
페이지당 표시되는 검사 수입니다. |
|
|
사용 및 연산자
|
useTagsAndOperator | boolean |
태그 조회에 AND 연산자를 사용하는 경우 |
|
|
태그 숨기기
|
hideTags | boolean |
대시보드에서 태그를 표시하거나 숨깁니다. |
|
|
대시보드 태그 목록
|
tags | array of string |
대시보드에 표시할지를 검사하는 하나 이상의 태그 목록입니다. |
반환
대시보드 삭제
대시보드를 영구적으로 제거합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
아이디
|
dashboardId | True | string |
대시보드 식별자입니다. |
대시보드 업데이트
대시보드를 업데이트합니다. 이미 가져온 사용자 지정 URL 또는 사용자 지정 도메인을 사용하여 대시보드를 만들려고 할 때 409를 반환합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
아이디
|
dashboardId | True | string |
대시보드 식별자입니다. |
|
사용자 지정 URL
|
customUrl | string |
checklyhq.com 아래의 하위 도메인 이름입니다. 모든 사용자 간에 고유해야 합니다. |
|
|
사용자 지정 도메인
|
customDomain | string |
사용자 지정 사용자 도메인(예: status.example.com) DNS 및 SSL 사용량 업데이트에 대한 문서를 참조하세요. |
|
|
로고
|
logo | string |
이미지 파일을 가리키는 URL입니다. |
|
|
파비콘 (사이트 아이콘)
|
favicon | string |
대시보드 favicon으로 사용되는 이미지 파일을 가리키는 URL입니다. |
|
|
Link
|
link | string |
대시보드 로고를 클릭할 때 리디렉션할 URL 링크입니다. |
|
|
Header
|
header | string |
대시보드의 맨 위에 표시되는 텍스트 조각입니다. |
|
|
Description
|
description | string |
대시보드의 머리글 또는 제목 아래에 표시되는 텍스트 조각입니다. |
|
|
너비
|
width | string |
전체 화면 또는 포커스를 가운데에 사용할지 여부를 결정합니다. |
|
|
재생 빈도
|
refreshRate | number |
몇 초 안에 대시보드를 새로 고치는 빈도입니다. |
|
|
페이지 매김
|
paginate | boolean |
페이지 매김이 켜지거나 꺼져 있는지 확인합니다. |
|
|
페이지 매김 비율
|
paginationRate | number |
페이지 매김을 트리거하는 빈도(초)입니다. |
|
|
페이지당 검사
|
checksPerPage | number |
페이지당 표시되는 검사 수입니다. |
|
|
사용 및 연산자
|
useTagsAndOperator | boolean |
태그 조회에 AND 연산자를 사용하는 경우 |
|
|
태그 숨기기
|
hideTags | boolean |
대시보드에서 태그를 표시하거나 숨깁니다. |
|
|
대시보드 태그 목록
|
tags | array of string |
대시보드에 표시할지를 검사하는 하나 이상의 태그 목록입니다. |
반환
모든 개인 위치 나열
모든 검사 결과를 나열합니다.
특정 검사에 대한 전체 원시 검사 결과를 나열합니다. 30일 동안 원시 결과를 유지합니다. 30일이 지나면 지워집니다. 그러나 롤업 결과를 무기한 유지합니다. 검사 유형 및 결과 형식을 필터링하여 목록의 범위를 좁힐 수 있습니다. 날짜 범위( to UNIX 타임스탬프(초)를 지정하려면 해당 및 from 매개 변수를 사용합니다. 확인 유형에 따라 일부 필드는 null일 수 있습니다. 이 엔드포인트는 6시간 내에 데이터를 반환합니다. 매개 변수가 설정되면 최대 6시간 간격이어야 합니다. 아무도 설정되지 않은 경우, 우리는 지금과 매개 변수에서 6 시간 이전으로 매개 변수를 고려할 것입니다. 매개 변수만 설정되면 6시간 이전으로 설정됩니다. 반대로, 매개 변수만 설정된 경우 매개 변수는 6시간 후로 간주합니다. 속도 제한은 이 엔드포인트에 적용되며, 최대 5개 요청/10초를 보낼 수 있습니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
ID 확인
|
checkId | True | string |
확인 식별자입니다. |
|
한계
|
limit | integer |
결과 수를 제한합니다. |
|
|
Number
|
page | number |
페이지 번호입니다. |
|
|
부터
|
from | date |
이 UNIX 타임스탬프(>= 날짜)에서 문서를 선택합니다. 기본값은 지금 - 6시간입니다. |
|
|
에게
|
to | date |
이 UNIX 타임스탬프(< 날짜)까지 경고를 선택합니다. 기본값은 6시간 후입니다. |
|
|
위치
|
location | string |
데이터 센터 위치(예: eu-west-1)를 제공하여 위치별로 필터링 |
|
|
확인 유형
|
checkType | string |
확인의 형식입니다. |
|
|
실패
|
hasFailures | boolean |
확인 결과에 하나 이상의 오류가 있습니다. |
반환
- 아이템
- CheckResultList
모든 검사 나열
계정의 모든 현재 검사를 나열합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
한계
|
limit | integer |
결과 수를 제한합니다. |
|
|
Number
|
page | number |
페이지 번호입니다. |
|
|
API 검사 URL 필터
|
apiCheckUrlFilterPattern | string |
API 검사의 URL에 포함된 문자열(예: www.myapp.com같은 도메인)으로 결과를 필터링합니다. API 검사만 반환합니다. |
반환
- 아이템
- CheckList
모든 경고 채널 나열
구성된 모든 경고 채널과 구독된 검사를 나열합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
한계
|
limit | integer |
결과 수를 제한합니다. |
|
|
Number
|
page | number |
페이지 번호입니다. |
반환
- 아이템
- AlertChannelList
모든 대시보드 나열
계정의 모든 현재 대시보드를 나열합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
한계
|
limit | integer |
결과 수를 제한합니다. |
|
|
Number
|
page | number |
페이지 번호입니다. |
반환
- 아이템
- DashboardsList
모든 브라우저 검사 메트릭에 대해 사용자 지정 가능한 보고서를 생성합니다.
지정된 기간 동안 특정 브라우저 검사에 대해 집계되거나 집계되지 않은 통계가 있는 보고서를 생성합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
아이디
|
id | True | string |
식별자입니다. |
|
부터
|
from | date |
unix 타임스탬프 형식의 보고 창의 사용자 지정 시작 시간입니다. 타임스탬프에서 사용자 지정을 설정하면 presetWindow의 사용이 재정의됩니다. |
|
|
에게
|
to | date |
보고 창의 사용자 지정 종료 시간(unix 타임스탬프 형식) 사용자 지정을 타임스탬프로 설정하면 presetWindow의 사용이 재정의됩니다. |
|
|
미리 설정된 창
|
presetWindow | string |
미리 설정된 보고 창은 일반적으로 사용되는 창에서 보고서를 빠르게 생성하는 데 사용됩니다. 타임스탬프에서 사용자 지정을 사용하여 재정의할 수 있습니다. |
|
|
집계 간격
|
aggregationInterval | number |
메트릭을 집계하는 데 사용할 시간 간격(분)입니다. 예를 들어 5분은 300, 24시간은 1440입니다. |
|
|
그룹화 기준
|
groupBy | string |
계열 데이터를 그룹화하는 방법을 결정합니다. |
|
|
상태별로 필터링
|
filterByStatus | array |
상태를 사용하여 실패 또는 성공적인 검사 결과 데이터를 검사하도록 필터링합니다. |
|
|
Metrics
|
metrics | array |
브라우저 검사에 대한 메트릭 옵션입니다. |
반환
특성입니다.
- Attributes
- object
모든 유지 관리 기간 나열
계정의 모든 유지 관리 기간을 나열합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
한계
|
limit | integer |
결과 수를 제한합니다. |
|
|
Number
|
page | number |
페이지 번호입니다. |
반환
유지 관리 기간 목록입니다.
모든 코드 조각 나열
계정의 모든 현재 코드 조각을 나열합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
한계
|
limit | integer |
결과 수를 제한합니다. |
|
|
Number
|
page | number |
페이지 번호입니다. |
반환
- 아이템
- SnippetList
모든 확인 그룹 나열
계정의 모든 현재 확인 그룹을 나열합니다. check 속성은 편리한 참조를 위해 UUID 검사의 배열입니다. 읽기 전용이며 그룹에 검사를 추가하는 데 사용할 수 없습니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
한계
|
limit | integer |
결과 수를 제한합니다. |
|
|
Number
|
page | number |
페이지 번호입니다. |
반환
- 아이템
- CheckGroupList
모든 확인 상태 나열
모든 환경 변수 나열
계정의 모든 현재 환경 변수를 나열합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
한계
|
limit | integer |
결과 수를 제한합니다. |
|
|
Number
|
page | number |
페이지 번호입니다. |
반환
브라우저 검사 업데이트
브라우저 검사를 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
아이디
|
id | True | string |
식별자입니다. |
|
경고 자동 할당
|
autoAssignAlerts | boolean |
새 검사가 생성될 때 모든 기존 경고 채널에 구독자로 자동으로 추가되는지 여부를 결정합니다. |
|
|
이름
|
name | string |
확인의 이름입니다. |
|
|
활성화
|
activated | boolean |
검사가 실행 중인지 여부를 확인합니다. |
|
|
음소거
|
muted | boolean |
확인이 실패하거나 복구될 때 알림을 보낼지 여부를 결정합니다. |
|
|
두 번 확인
|
doubleCheck | boolean |
이 값을 true로 설정하면 실패한 지역과 임의로 선택한 다른 지역에서 검사가 실패할 때 다시 시도가 트리거됩니다. |
|
|
실패해야 합니다.
|
shouldFail | boolean |
검사 실패로 간주되는 경우의 동작을 반전할 수 있습니다. 404와 같은 오류 상태의 유효성을 검사할 수 있습니다. |
|
|
위치 목록 확인
|
locations | array of string |
이 검사를 실행할 하나 이상의 데이터 센터 위치 배열입니다. |
|
|
태그 목록 확인
|
tags | array of string |
검사를 구성하고 필터링하기 위한 태그입니다. |
|
|
에스컬레이션 유형
|
escalationType | string |
사용할 에스컬레이션 유형을 결정합니다. |
|
|
실패한 실행 임계값
|
failedRunThreshold | number |
실패한 연속 검사 실행 횟수 후 경고 알림을 보내야 합니다. |
|
|
분 실패 임계값
|
minutesFailingThreshold | number |
검사가 시작된 후 몇 분이 지나면 경고를 보내야 합니다. |
|
|
금액
|
amount | number |
초기 경고 알림 후에 보낼 미리 알림 수입니다. |
|
|
간격
|
interval | number |
미리 알림을 보내야 하는 간격입니다. |
|
|
활성화됨
|
enabled | boolean |
만료되는 SSL 인증서에 대해 경고 알림을 보내야 하는지 여부를 결정합니다. |
|
|
경고 임계값
|
alertThreshold | integer |
SSL 인증서에 대한 경고를 시작할 시점입니다. |
|
|
전역 경고 설정 사용
|
useGlobalAlertSettings | boolean |
true이면 이 검사에 정의된 경고 설정이 아니라 계정 수준 경고 설정이 사용됩니다. |
|
|
그룹 아이디
|
groupId | number |
이 검사의 일부인 확인 그룹의 식별자입니다. |
|
|
그룹 순서
|
groupOrder | number |
확인 그룹에서 이 확인의 위치입니다. 그룹이 API 또는 CI/CD에서 트리거될 때 실행되는 순서 검사를 결정합니다. |
|
|
런타임 ID
|
runtimeId | string |
런타임 버전(예: 이 검사를 실행하는 데 사용되는 런타임 종속성 집합 고정)입니다. |
|
|
경고 채널 ID
|
alertChannelId | True | number |
경고 채널 식별자입니다. |
|
활성화
|
activated | True | boolean |
활성화 여부입니다. |
|
Key
|
key | True | string |
환경 변수의 키입니다(이 값은 변경할 수 없음). |
|
가치
|
value | True | string |
환경 변수의 값입니다. |
|
잠김
|
locked | boolean |
UI에서만 암호와 같은 값을 숨기는 데 사용됩니다. |
|
|
빈도
|
frequency | integer |
수표가 몇 분 안에 실행되는 빈도입니다. |
|
|
스크립트
|
script | string |
Puppeteer 또는 Playwright 프레임워크와의 브라우저 상호 작용을 설명하는 유효한 Node.js javascript 코드입니다. |
|
|
프라이빗 위치
|
privateLocations | array of string |
검사를 실행할 하나 이상의 개인 위치 배열입니다. |
반환
브라우저 확인 만들기
새 브라우저 검사를 만듭니다. 계획의 한도를 402 초과하면 반환됩니다. 를 사용하는 경우 다음을 globalAlertSettingalertSetting 수행할 수 있습니다.null
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
경고 자동 할당
|
autoAssignAlerts | boolean |
새 검사가 생성될 때 모든 기존 경고 채널에 구독자로 자동으로 추가되는지 여부를 결정합니다. |
|
|
이름
|
name | True | string |
확인의 이름입니다. |
|
활성화
|
activated | True | boolean |
검사가 실행 중인지 여부를 확인합니다. |
|
음소거
|
muted | boolean |
확인이 실패하거나 복구될 때 알림을 보낼지 여부를 결정합니다. |
|
|
두 번 확인
|
doubleCheck | boolean |
이 값을 true로 설정하면 실패한 지역과 임의로 선택한 다른 지역에서 검사가 실패할 때 다시 시도가 트리거됩니다. |
|
|
실패해야 합니다.
|
shouldFail | boolean |
검사 실패로 간주되는 경우의 동작을 반전할 수 있습니다. 404와 같은 오류 상태의 유효성을 검사할 수 있습니다. |
|
|
위치 목록 확인
|
locations | array of string |
이 검사를 실행할 하나 이상의 데이터 센터 위치 배열입니다. |
|
|
태그 목록 확인
|
tags | array of string |
검사를 구성하고 필터링하기 위한 태그입니다. |
|
|
에스컬레이션 유형
|
escalationType | string |
사용할 에스컬레이션 유형을 결정합니다. |
|
|
실패한 실행 임계값
|
failedRunThreshold | number |
실패한 연속 검사 실행 횟수 후 경고 알림을 보내야 합니다. |
|
|
분 실패 임계값
|
minutesFailingThreshold | number |
검사가 시작된 후 몇 분이 지나면 경고를 보내야 합니다. |
|
|
금액
|
amount | number |
초기 경고 알림 후에 보낼 미리 알림 수입니다. |
|
|
간격
|
interval | number |
미리 알림을 보내야 하는 간격입니다. |
|
|
활성화됨
|
enabled | boolean |
만료되는 SSL 인증서에 대해 경고 알림을 보내야 하는지 여부를 결정합니다. |
|
|
경고 임계값
|
alertThreshold | integer |
SSL 인증서에 대한 경고를 시작할 시점입니다. |
|
|
전역 경고 설정 사용
|
useGlobalAlertSettings | boolean |
true이면 이 검사에 정의된 경고 설정이 아니라 계정 수준 경고 설정이 사용됩니다. |
|
|
그룹 아이디
|
groupId | number |
이 검사의 일부인 확인 그룹의 식별자입니다. |
|
|
그룹 순서
|
groupOrder | number |
확인 그룹에서 이 확인의 위치입니다. 그룹이 API 또는 CI/CD에서 트리거될 때 실행되는 순서 검사를 결정합니다. |
|
|
런타임 ID
|
runtimeId | string |
런타임 버전(예: 이 검사를 실행하는 데 사용되는 런타임 종속성 집합 고정)입니다. |
|
|
경고 채널 ID
|
alertChannelId | True | number |
경고 채널 식별자입니다. |
|
활성화
|
activated | True | boolean |
활성화 여부입니다. |
|
Key
|
key | True | string |
환경 변수의 키입니다(이 값은 변경할 수 없음). |
|
가치
|
value | True | string |
환경 변수의 값입니다. |
|
잠김
|
locked | boolean |
UI에서만 암호와 같은 값을 숨기는 데 사용됩니다. |
|
|
빈도
|
frequency | integer |
수표가 몇 분 안에 실행되는 빈도입니다. |
|
|
스크립트
|
script | True | string |
Puppeteer 또는 Playwright 프레임워크와의 브라우저 상호 작용을 설명하는 유효한 Node.js javascript 코드입니다. |
|
프라이빗 위치
|
privateLocations | array of string |
검사를 실행할 하나 이상의 개인 위치 배열입니다. |
반환
상태 세부 정보 확인 검색
특정 검사에 대한 현재 상태 정보를 표시합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
ID 확인
|
checkId | True | string |
확인 식별자입니다. |
반환
상태 확인 배지 가져오기
상태 확인 배지를 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
ID 확인
|
checkId | True | string |
확인 식별자입니다. |
|
스타일
|
style | string |
스타일입니다. |
|
|
Theme
|
theme | string |
테마입니다. |
|
|
응답 시간
|
responseTime | boolean |
응답 시간입니다. |
반환
- response
- string
시간 창에서 프라이빗 위치 상태 메트릭 가져오기
시간 창에서 개인 위치 상태 메트릭을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
아이디
|
id | True | string |
식별자입니다. |
|
부터
|
from | True | date |
이 UNIX 타임스탬프로 시작하는 메트릭을 선택합니다. 15일 미만이어야 합니다. |
|
에게
|
to | True | date |
이 UNIX 타임스탬프까지 메트릭을 선택합니다. |
반환
유지 관리 기간 검색
특정 유지 관리 기간의 세부 정보를 표시합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
아이디
|
id | True | integer |
식별자입니다. |
반환
유지 관리 기간 만들기
새 유지 관리 기간을 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
이름
|
name | True | string |
유지 관리 기간 이름입니다. |
|
유지 관리 기간 태그 목록
|
tags | array of string |
검사 및 그룹 유지 관리 기간의 이름이 적용됩니다. |
|
|
시작 날짜
|
startsAt | True | date |
유지 관리 기간의 시작 날짜입니다. |
|
종료 시
|
endsAt | True | date |
유지 관리 기간의 종료 날짜입니다. |
|
반복 간격
|
repeatInterval | number |
처음 발생한 유지 관리 기간의 반복 간격입니다. |
|
|
반복 단위
|
repeatUnit | True | string |
유지 관리 기간에 대한 반복 전략입니다. |
|
반복 종료 시
|
repeatEndsAt | date |
유지 관리 기간이 반복을 중지해야 하는 종료 날짜입니다. |
반환
유지 관리 기간 삭제
유지 관리 기간을 영구적으로 제거합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
아이디
|
id | True | integer |
식별자입니다. |
유지 관리 기간 업데이트
유지 관리 기간을 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
아이디
|
id | True | integer |
식별자입니다. |
|
이름
|
name | True | string |
유지 관리 기간 이름입니다. |
|
유지 관리 기간 태그 목록
|
tags | array of string |
검사 및 그룹 유지 관리 기간의 이름이 적용됩니다. |
|
|
시작 날짜
|
startsAt | True | date |
유지 관리 기간의 시작 날짜입니다. |
|
종료 시
|
endsAt | True | date |
유지 관리 기간의 종료 날짜입니다. |
|
반복 간격
|
repeatInterval | number |
처음 발생한 유지 관리 기간의 반복 간격입니다. |
|
|
반복 단위
|
repeatUnit | True | string |
유지 관리 기간에 대한 반복 전략입니다. |
|
반복 종료 시
|
repeatEndsAt | date |
유지 관리 기간이 반복을 중지해야 하는 종료 날짜입니다. |
반환
지원되는 모든 런타임을 나열합니다.
지원되는 모든 위치를 나열합니다.
코드 조각 검색
코드 조각 만들기
새 코드 조각을 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
이름
|
name | True | string |
코드 조각 이름입니다. |
|
스크립트
|
script | True | string |
API 검사 수명 주기와 상호 작용하는 Node.js 코드 또는 브라우저 검사의 일부로 작동합니다. |
반환
- 몸
- Snippet
코드 조각 삭제
코드 조각을 영구적으로 제거합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
아이디
|
id | True | integer |
식별자입니다. |
코드 조각 업데이트
코드 조각을 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
아이디
|
id | True | integer |
식별자입니다. |
|
이름
|
name | True | string |
코드 조각 이름입니다. |
|
스크립트
|
script | True | string |
API 검사 수명 주기와 상호 작용하는 Node.js 코드 또는 브라우저 검사의 일부로 작동합니다. |
반환
- 몸
- Snippet
특정 검사에 대한 경고 나열
특정 검사에 대한 모든 경고를 나열합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
ID 확인
|
checkId | True | string |
확인 식별자입니다. |
|
한계
|
limit | integer |
결과 수를 제한합니다. |
|
|
Number
|
page | number |
페이지 번호입니다. |
|
|
부터
|
from | date |
이 UNIX 타임스탬프(>= 날짜)에서 문서를 선택합니다. 기본값은 지금 - 6시간입니다. |
|
|
에게
|
to | date |
이 UNIX 타임스탬프(< 날짜)까지 경고를 선택합니다. 기본값은 6시간 후입니다. |
반환
- 아이템
- CheckAlertList
특정 런타임에 대한 세부 정보를 표시합니다.
포함된 모든 NPM 패키지의 세부 정보와 특정 런타임에 대한 해당 버전을 보여 줍니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
아이디
|
id | True | string |
식별자입니다. |
반환
- 몸
- Runtime
프라이빗 위치 만들기
새 개인 위치를 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
이름
|
name | True | string |
개인 위치에 할당된 이름입니다. |
|
슬러그 이름
|
slugName | True | string |
유효한 슬러그 이름입니다. |
|
Icon
|
icon | string |
아이콘입니다. |
반환
프라이빗 위치에 대한 기존 API 키 제거
프라이빗 위치에서 api 키를 영구적으로 제거합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
아이디
|
id | True | string |
식별자입니다. |
|
키 ID
|
keyId | True | string |
키 식별자입니다. |
프라이빗 위치에 대한 새 API 키 생성
프라이빗 위치에 api 키를 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
아이디
|
id | True | string |
식별자입니다. |
반환
확인 검색
특정 API 또는 브라우저 검사의 세부 정보를 표시합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
아이디
|
id | True | string |
식별자입니다. |
반환
- 몸
- Check
확인 그룹 검색
확인 그룹 만들기
새 확인 그룹을 만듭니다. 개별 검사의 groupId 속성을 설정하여 그룹에 검사를 추가할 수 있습니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
경고 자동 할당
|
autoAssignAlerts | boolean |
새 검사가 생성될 때 모든 기존 경고 채널에 구독자로 자동으로 추가되는지 여부를 결정합니다. |
|
|
이름
|
name | True | string |
확인 그룹의 이름입니다. |
|
활성화
|
activated | boolean |
그룹의 검사가 실행 중인지 여부를 확인합니다. |
|
|
음소거
|
muted | boolean |
이 그룹의 체크 인이 실패하거나 복구될 때 알림이 전송될지 여부를 결정합니다. |
|
|
그룹 태그 목록 확인
|
tags | array of string |
검사를 구성하고 필터링하기 위한 태그입니다. |
|
|
그룹 위치 목록 확인
|
locations | array of string |
검사를 실행할 하나 이상의 데이터 센터 위치 배열입니다. |
|
|
Concurrency
|
concurrency | number |
CI/CD 또는 API를 통해 검사 그룹을 트리거할 때 동시에 호출되는 검사 수를 결정합니다. |
|
|
URL
|
url | string |
모든 그룹 검사에서 {{GROUP_BASE_URL}} 변수를 사용하여 참조할 수 있는 이 그룹의 기본 URL입니다. |
|
|
Key
|
key | True | string |
열쇠. |
|
가치
|
value | True | string |
값입니다. |
|
잠김
|
locked | boolean |
잠겨 있는지 여부입니다. |
|
|
출처
|
source | string |
원본입니다. |
|
|
재산
|
property | string |
속성입니다. |
|
|
Comparison
|
comparison | string |
비교입니다. |
|
|
목표/타겟
|
target | string |
대상입니다. |
|
|
사용자 이름
|
username | True | string |
사용자 이름입니다. |
|
암호
|
password | True | string |
암호입니다. |
|
그룹 만들기 브라우저 확인 기본값 확인
|
browserCheckDefaults | object |
확인 그룹 만들기 브라우저 확인 기본값입니다. |
|
|
런타임 ID
|
runtimeId | string |
런타임 버전(예: 이 그룹에서 검사를 실행하는 데 사용되는 런타임 종속성 집합 고정)입니다. |
|
|
Key
|
key | True | string |
환경 변수의 키입니다(이 값은 변경할 수 없음). |
|
가치
|
value | True | string |
환경 변수의 값입니다. |
|
잠김
|
locked | boolean |
UI에서만 암호와 같은 값을 숨기는 데 사용됩니다. |
|
|
두 번 확인
|
doubleCheck | boolean |
이 값을 true로 설정하면 실패한 지역과 임의로 선택한 다른 지역에서 검사가 실패할 때 다시 시도가 트리거됩니다. |
|
|
전역 경고 설정 사용
|
useGlobalAlertSettings | boolean |
true이면 이 확인 그룹에 정의된 경고 설정이 아니라 계정 수준 경고 설정이 사용됩니다. |
|
|
에스컬레이션 유형
|
escalationType | string |
사용할 에스컬레이션 유형을 결정합니다. |
|
|
실패한 실행 임계값
|
failedRunThreshold | number |
실패한 연속 검사 실행 횟수 후 경고 알림을 보내야 합니다. |
|
|
분 실패 임계값
|
minutesFailingThreshold | number |
검사가 시작된 후 몇 분이 지나면 경고를 보내야 합니다. |
|
|
금액
|
amount | number |
초기 경고 알림 후에 보낼 미리 알림 수입니다. |
|
|
간격
|
interval | number |
미리 알림을 보내야 하는 간격입니다. |
|
|
활성화됨
|
enabled | boolean |
만료되는 SSL 인증서에 대해 경고 알림을 보내야 하는지 여부를 결정합니다. |
|
|
경고 임계값
|
alertThreshold | integer |
SSL 인증서에 대한 경고를 시작할 시점입니다. |
|
|
경고 채널 ID
|
alertChannelId | True | number |
경고 채널 식별자입니다. |
|
활성화
|
activated | True | boolean |
활성화 여부입니다. |
|
코드 조각 ID 설정
|
setupSnippetId | number |
이 그룹의 API 검사 설정 단계에서 사용할 코드 조각에 대한 식별자 참조입니다. |
|
|
코드 조각 ID 분해
|
tearDownSnippetId | number |
이 그룹의 API 검사 중단 단계에서 사용할 코드 조각에 대한 식별자 참조입니다. |
|
|
로컬 설치 스크립트
|
localSetupScript | string |
이 그룹의 API 검사 설정 단계에서 실행할 유효한 Node.js 코드 조각입니다. |
|
|
로컬 중단 스크립트
|
localTearDownScript | string |
이 그룹에서 API 검사의 중단 단계에서 실행할 유효한 Node.js 코드 조각입니다. |
|
|
프라이빗 위치 확인
|
privateLocations | array of string |
검사를 실행할 하나 이상의 프라이빗 위치 배열입니다. |
반환
확인 그룹 삭제
확인 그룹을 영구적으로 제거합니다. 검사 그룹이 여전히 포함된 경우에는 삭제할 수 없습니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
아이디
|
id | True | integer |
식별자입니다. |
확인 그룹 업데이트
확인 그룹을 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
아이디
|
id | True | integer |
식별자입니다. |
|
경고 자동 할당
|
autoAssignAlerts | boolean |
새 검사가 생성될 때 모든 기존 경고 채널에 구독자로 자동으로 추가되는지 여부를 결정합니다. |
|
|
이름
|
name | string |
확인 그룹의 이름입니다. |
|
|
활성화
|
activated | boolean |
그룹의 검사가 실행 중인지 여부를 확인합니다. |
|
|
음소거
|
muted | boolean |
이 그룹의 체크 인이 실패하거나 복구될 때 알림이 전송될지 여부를 결정합니다. |
|
|
그룹 태그 목록 확인
|
tags | array of string |
검사를 구성하고 필터링하기 위한 태그입니다. |
|
|
그룹 위치 목록 확인
|
locations | array of string |
검사를 실행할 하나 이상의 데이터 센터 위치 배열입니다. |
|
|
Concurrency
|
concurrency | number |
CI/CD 또는 API를 통해 검사 그룹을 트리거할 때 동시에 호출되는 검사 수를 결정합니다. |
|
|
URL
|
url | string |
모든 그룹 검사에서 {{GROUP_BASE_URL}} 변수를 사용하여 참조할 수 있는 이 그룹의 기본 URL입니다. |
|
|
Key
|
key | True | string |
열쇠. |
|
가치
|
value | True | string |
값입니다. |
|
잠김
|
locked | boolean |
잠겨 있는지 여부입니다. |
|
|
출처
|
source | string |
원본입니다. |
|
|
재산
|
property | string |
속성입니다. |
|
|
Comparison
|
comparison | string |
비교입니다. |
|
|
목표/타겟
|
target | string |
대상입니다. |
|
|
사용자 이름
|
username | True | string |
사용자 이름입니다. |
|
암호
|
password | True | string |
암호입니다. |
|
그룹 만들기 브라우저 확인 기본값 확인
|
browserCheckDefaults | object |
확인 그룹 만들기 브라우저 확인 기본값입니다. |
|
|
런타임 ID
|
runtimeId | string |
런타임 버전(예: 이 그룹에서 검사를 실행하는 데 사용되는 런타임 종속성 집합 고정)입니다. |
|
|
Key
|
key | True | string |
환경 변수의 키입니다(이 값은 변경할 수 없음). |
|
가치
|
value | True | string |
환경 변수의 값입니다. |
|
잠김
|
locked | boolean |
UI에서만 암호와 같은 값을 숨기는 데 사용됩니다. |
|
|
두 번 확인
|
doubleCheck | boolean |
이 값을 true로 설정하면 실패한 지역과 임의로 선택한 다른 지역에서 검사가 실패할 때 다시 시도가 트리거됩니다. |
|
|
전역 경고 설정 사용
|
useGlobalAlertSettings | boolean |
true이면 이 확인 그룹에 정의된 경고 설정이 아니라 계정 수준 경고 설정이 사용됩니다. |
|
|
에스컬레이션 유형
|
escalationType | string |
사용할 에스컬레이션 유형을 결정합니다. |
|
|
실패한 실행 임계값
|
failedRunThreshold | number |
실패한 연속 검사 실행 횟수 후 경고 알림을 보내야 합니다. |
|
|
분 실패 임계값
|
minutesFailingThreshold | number |
검사가 시작된 후 몇 분이 지나면 경고를 보내야 합니다. |
|
|
금액
|
amount | number |
초기 경고 알림 후에 보낼 미리 알림 수입니다. |
|
|
간격
|
interval | number |
미리 알림을 보내야 하는 간격입니다. |
|
|
활성화됨
|
enabled | boolean |
만료되는 SSL 인증서에 대해 경고 알림을 보내야 하는지 여부를 결정합니다. |
|
|
경고 임계값
|
alertThreshold | integer |
SSL 인증서에 대한 경고를 시작할 시점입니다. |
|
|
경고 채널 ID
|
alertChannelId | True | number |
경고 채널 식별자입니다. |
|
활성화
|
activated | True | boolean |
활성화 여부입니다. |
|
코드 조각 ID 설정
|
setupSnippetId | number |
이 그룹의 API 검사 설정 단계에서 사용할 코드 조각에 대한 식별자 참조입니다. |
|
|
코드 조각 ID 분해
|
tearDownSnippetId | number |
이 그룹의 API 검사 중단 단계에서 사용할 코드 조각에 대한 식별자 참조입니다. |
|
|
로컬 설치 스크립트
|
localSetupScript | string |
이 그룹의 API 검사 설정 단계에서 실행할 유효한 Node.js 코드 조각입니다. |
|
|
로컬 중단 스크립트
|
localTearDownScript | string |
이 그룹에서 API 검사의 중단 단계에서 실행할 유효한 Node.js 코드 조각입니다. |
|
|
프라이빗 위치 확인
|
privateLocations | array of string |
검사를 실행할 하나 이상의 프라이빗 위치 배열입니다. |
반환
확인 그룹 트리거 만들기
확인 그룹 트리거를 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
그룹 아이디
|
groupId | True | integer |
그룹 식별자입니다. |
반환
확인 만들기 [사용되지 않음]
[사용되지 않음] 이 엔드포인트는 2022년 7월 4일 월요일에 제거됩니다. 대신 POST /checks/api 또는 POST /checks/browser를 사용합니다. 새 API 또는 브라우저 검사를 만듭니다. 계획의 한도를 402 초과하면 반환됩니다. 를 사용하는 경우 다음을 globalAlertSettingsalertSettings 수행할 수 있습니다.null
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
경고 자동 할당
|
autoAssignAlerts | boolean |
새 검사가 생성될 때 모든 기존 경고 채널에 구독자로 자동으로 추가되는지 여부를 결정합니다. |
|
|
이름
|
name | True | string |
확인의 이름입니다. |
|
활성화
|
activated | True | boolean |
검사가 실행 중인지 여부를 확인합니다. |
|
음소거
|
muted | boolean |
확인이 실패하거나 복구될 때 알림을 보낼지 여부를 결정합니다. |
|
|
두 번 확인
|
doubleCheck | boolean |
이 값을 true로 설정하면 실패한 지역과 임의로 선택한 다른 지역에서 검사가 실패할 때 다시 시도가 트리거됩니다. |
|
|
실패해야 합니다.
|
shouldFail | boolean |
검사 실패로 간주되는 경우의 동작을 반전할 수 있습니다. 404와 같은 오류 상태의 유효성을 검사할 수 있습니다. |
|
|
위치 목록 확인
|
locations | array of string |
이 검사를 실행할 하나 이상의 데이터 센터 위치 배열입니다. |
|
|
태그 목록 확인
|
tags | array of string |
검사를 구성하고 필터링하기 위한 태그입니다. |
|
|
에스컬레이션 유형
|
escalationType | string |
사용할 에스컬레이션 유형을 결정합니다. |
|
|
실패한 실행 임계값
|
failedRunThreshold | number |
실패한 연속 검사 실행 횟수 후 경고 알림을 보내야 합니다. |
|
|
분 실패 임계값
|
minutesFailingThreshold | number |
검사가 시작된 후 몇 분이 지나면 경고를 보내야 합니다. |
|
|
금액
|
amount | number |
초기 경고 알림 후에 보낼 미리 알림 수입니다. |
|
|
간격
|
interval | number |
미리 알림을 보내야 하는 간격입니다. |
|
|
활성화됨
|
enabled | boolean |
만료되는 SSL 인증서에 대해 경고 알림을 보내야 하는지 여부를 결정합니다. |
|
|
경고 임계값
|
alertThreshold | integer |
SSL 인증서에 대한 경고를 시작할 시점입니다. |
|
|
전역 경고 설정 사용
|
useGlobalAlertSettings | boolean |
true이면 이 검사에 정의된 경고 설정이 아니라 계정 수준 경고 설정이 사용됩니다. |
|
|
그룹 아이디
|
groupId | number |
이 검사의 일부인 확인 그룹의 식별자입니다. |
|
|
그룹 순서
|
groupOrder | number |
확인 그룹에서 이 확인의 위치입니다. 그룹이 API 또는 CI/CD에서 트리거될 때 실행되는 순서 검사를 결정합니다. |
|
|
런타임 ID
|
runtimeId | string |
런타임 버전(예: 이 검사를 실행하는 데 사용되는 런타임 종속성 집합 고정)입니다. |
|
|
경고 채널 ID
|
alertChannelId | True | number |
경고 채널 식별자입니다. |
|
활성화
|
activated | True | boolean |
활성화 여부입니다. |
|
확인 유형
|
checkType | True | string |
확인의 형식입니다. |
|
빈도
|
frequency | integer |
수표가 몇 분 안에 실행되는 빈도입니다. |
|
|
빈도 오프셋
|
frequencyOffset | integer |
1분 미만의 검사 빈도에 초를 설정하고(API 검사에만 해당) 1분 이상 빈도에 대한 시간 범위에 대한 검사를 분산하는 데 사용됩니다. 이는 다음과 같이 작동합니다. 빈도가 0인 검사는 frequencyOffset이 10, 20 또는 30일 수 있으므로 10초, 20초 또는 30초마다 실행됩니다. 빈도가 60보다 낮고 같은 검사는 수식 Math.floor(frequency * 10)를 기반으로 1에서 최대값 사이의 frequencyOffset을 가질 수 있습니다. 즉, 5분마다 실행되는 검사의 경우 max frequencyOffset은 50입니다. 빈도가 60보다 높은 검사는 Math.ceil(frequency/60) 수식을 기준으로 1에서 최대값 사이의 frequencyOffset을 가질 수 있습니다. 즉, 720분마다 실행되는 검사의 경우 최대 frequencyOffset은 12입니다. |
|
|
요청 확인
|
request | object |
확인 요청입니다. |
|
|
스크립트
|
script | True | string |
스크립트입니다. |
|
Key
|
key | True | string |
환경 변수의 키입니다(이 값은 변경할 수 없음). |
|
가치
|
value | True | string |
환경 변수의 값입니다. |
|
잠김
|
locked | boolean |
UI에서만 암호와 같은 값을 숨기는 데 사용됩니다. |
|
|
코드 조각 ID 설정
|
setupSnippetId | number |
API 검사의 설정 단계에서 사용할 코드 조각에 대한 식별자 참조입니다. |
|
|
코드 조각 ID 분해
|
tearDownSnippetId | number |
API 검사의 중단 단계에서 사용할 코드 조각에 대한 식별자 참조입니다. |
|
|
로컬 설치 스크립트
|
localSetupScript | string |
설치 단계에서 실행할 유효한 Node.js 코드 조각입니다. |
|
|
로컬 중단 스크립트
|
localTearDownScript | string |
해체 단계에서 실행할 유효한 Node.js 코드 조각입니다. |
|
|
응답 시간 저하
|
degradedResponseTime | number |
확인을 저하된 것으로 간주해야 하는 응답 시간(밀리초)입니다. |
|
|
최대 응답 시간
|
maxResponseTime | number |
검사 실패로 간주되어야 하는 응답 시간(밀리초)입니다. |
|
|
프라이빗 위치
|
privateLocations | array of string |
검사를 실행할 하나 이상의 개인 위치 배열입니다. |
반환
- 몸
- Check
확인 삭제
API 또는 브라우저 검사 및 모든 관련 상태 및 결과 데이터를 영구적으로 제거합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
아이디
|
id | True | string |
식별자입니다. |
확인 트리거 가져오기
확인 트리거 만들기
확인 트리거 삭제
확인 트리거를 삭제합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
ID 확인
|
checkId | True | string |
확인 식별자입니다. |
환경 변수 검색
특정 환경 변수의 세부 정보를 표시합니다. 선택 영역에 키 필드를 사용합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Key
|
key | True | string |
열쇠. |
반환
환경 변수 만들기
새 환경 변수를 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Key
|
key | True | string |
환경 변수의 키입니다(이 값은 변경할 수 없음). |
|
가치
|
value | True | string |
환경 변수의 값입니다. |
|
잠김
|
locked | boolean |
UI에서만 암호와 같은 값을 숨기는 데 사용됩니다. |
반환
환경 변수 삭제
환경 변수를 영구적으로 제거합니다. 키 필드를 삭제 식별자로 사용합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Key
|
key | True | string |
열쇠. |
환경 변수 업데이트
환경 변수를 업데이트합니다. 키 필드를 업데이트할 식별자로 사용합니다. 값 및 잠긴 속성만 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Key
|
key | True | string |
열쇠. |
|
Key
|
key | string |
환경 변수의 키입니다(이 값은 변경할 수 없음). |
|
|
가치
|
value | True | string |
환경 변수의 값입니다. |
|
잠김
|
locked | boolean |
UI에서만 암호와 같은 값을 숨기는 데 사용됩니다. |
반환
정의
AlertChannelConfig
경고 채널의 구성입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
경고 채널 구성
|
object |
경고 채널의 구성입니다. |
AlertChanelSubscription
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | number |
식별자입니다. |
|
ID 확인
|
checkId | guid |
확인 식별자입니다. |
|
그룹 아이디
|
groupId | number |
그룹 식별자입니다. |
|
활성화
|
activated | boolean |
활성화 여부입니다. |
AlertChanelSubscriptionList
모든 검사는 이 채널을 구독합니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
AlertChanelSubscription |
AlertChannel
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | number |
식별자입니다. |
|
유형
|
type | string |
경고 채널의 유형(예: 이메일 또는 SLACK)입니다. |
|
경고 채널 구성
|
config | AlertChannelConfig |
경고 채널의 구성입니다. |
|
경고 채널 구독 목록
|
subscriptions | AlertChanelSubscriptionList |
모든 검사는 이 채널을 구독합니다. |
|
복구 보내기
|
sendRecovery | boolean |
복구 보내기 여부입니다. |
|
송신 실패
|
sendFailure | boolean |
전송 실패 여부입니다. |
|
성능 저하된 보내기
|
sendDegraded | boolean |
전송 성능이 저하되었는지 여부입니다. |
|
SSL 만료
|
sslExpiry | boolean |
만료되는 SSL 인증서에 대한 경고를 보내야 하는지 여부를 결정합니다. |
|
SSL 만료 임계값
|
sslExpiryThreshold | integer |
SSL 인증서에 대한 경고를 시작할 시점입니다. |
|
만든 위치에서
|
created_at | date-time |
만들 때입니다. |
|
업데이트 날짜
|
updated_at | date-time |
업데이트 시. |
AlertChannelList
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
AlertChannel |
CheckAlert
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
이 경고의 고유 식별자입니다. |
|
이름
|
name | string |
확인의 이름입니다. |
|
ID 확인
|
checkId | string |
이 경고가 속하는지 확인하는 식별자입니다. |
|
경고 유형
|
alertType | string |
경고의 유형입니다. |
|
확인 유형
|
checkType | string |
확인의 형식입니다. |
|
실행 위치
|
runLocation | string |
이 검사 경고가 트리거된 데이터 센터 위치입니다. |
|
응답 시간
|
responseTime | number |
이 검사의 관련 부분을 실행하는 데 걸린 시간을 설명합니다. Checkly 백 엔드에서 이 검사를 실행하는 데 필요한 설치 타이머 시스템 시간은 이 작업의 일부가 아닙니다. |
|
오류
|
error | string |
경고를 트리거하는 실패한 검사의 일부인 특정 오류 메시지입니다. |
|
상태 코드
|
statusCode | string |
응답의 상태 코드입니다. API 검사에만 적용됩니다. |
|
만든 위치에서
|
created_at | date |
이 검사 경고가 생성된 날짜와 시간입니다. |
|
시작 날짜
|
startedAt | date |
이 검사 경고가 시작된 날짜와 시간입니다. |
CheckAlertList
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
CheckAlert |
CheckGroupTagList
검사를 구성하고 필터링하기 위한 태그입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
string |
CheckGroupLocationList
검사를 실행할 하나 이상의 데이터 센터 위치 배열입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
string |
KeyValue
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
Key
|
key | string |
열쇠. |
|
가치
|
value | string |
값입니다. |
|
잠김
|
locked | boolean |
잠겨 있는지 여부입니다. |
HeaderList
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
KeyValue |
QueryParameterList
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
KeyValue |
주장
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
출처
|
source | string |
원본입니다. |
|
재산
|
property | string |
속성입니다. |
|
Comparison
|
comparison | string |
비교입니다. |
|
목표/타겟
|
target | string |
대상입니다. |
AssertionList
속성 필드에서 사용할 수 있는 정규식 및 JSON 경로 설명자와 같은 특정 값에 대한 어설션에 대한 기본 검사 설명서를 확인합니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
Assertion |
BasicAuth
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
사용자 이름
|
username | string |
사용자 이름입니다. |
|
암호
|
password | string |
암호입니다. |
CheckGroupAPICheckDefaults
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
URL
|
url | string |
모든 그룹 검사에서 {{GROUP_BASE_URL}} 변수를 사용하여 참조할 수 있는 이 그룹의 기본 URL입니다. |
|
headers
|
headers | HeaderList | |
|
쿼리 매개 변수
|
queryParameters | QueryParameterList | |
|
어설션 목록
|
assertions | AssertionList |
속성 필드에서 사용할 수 있는 정규식 및 JSON 경로 설명자와 같은 특정 값에 대한 어설션에 대한 기본 검사 설명서를 확인합니다. |
|
basicAuth
|
basicAuth | BasicAuth |
CheckGroupBrowserCheckDefaults
확인 그룹 브라우저 확인 기본값입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
그룹 브라우저 기본값 확인
|
object |
확인 그룹 브라우저 확인 기본값입니다. |
EnvironmentVariable
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
Key
|
key | string |
환경 변수의 키입니다(이 값은 변경할 수 없음). |
|
가치
|
value | string |
환경 변수의 값입니다. |
|
잠김
|
locked | boolean |
UI에서만 암호와 같은 값을 숨기는 데 사용됩니다. |
EnvironmentVariableList
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
EnvironmentVariable |
AlertSettingsRunBasedEscalation
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
실패한 실행 임계값
|
failedRunThreshold | number |
실패한 연속 검사 실행 횟수 후 경고 알림을 보내야 합니다. |
AlertSettingsTimeBasedEscalation
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
분 실패 임계값
|
minutesFailingThreshold | number |
검사가 시작된 후 몇 분이 지나면 경고를 보내야 합니다. |
AlertSettingsReminders
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
금액
|
amount | number |
초기 경고 알림 후에 보낼 미리 알림 수입니다. |
|
간격
|
interval | number |
미리 알림을 보내야 하는 간격입니다. |
AlertSettingsSSLCertificates
[사용되지 않음] sslCertificates 는 더 이상 사용되지 않으며 더 이상 사용되지 않습니다. 무시하세요. 이후 버전에서 제거됩니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
활성화됨
|
enabled | boolean |
만료되는 SSL 인증서에 대해 경고 알림을 보내야 하는지 여부를 결정합니다. |
|
경고 임계값
|
alertThreshold | integer |
SSL 인증서에 대한 경고를 시작할 시점입니다. |
CheckGroupAlertSettings
경고 설정.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
에스컬레이션 유형
|
escalationType | string |
사용할 에스컬레이션 유형을 결정합니다. |
|
runBasedEscalation
|
runBasedEscalation | AlertSettingsRunBasedEscalation | |
|
timeBasedEscalation
|
timeBasedEscalation | AlertSettingsTimeBasedEscalation | |
|
미리 알림
|
reminders | AlertSettingsReminders | |
|
경고 설정 SSL 인증서
|
sslCertificates | AlertSettingsSSLCertificates |
[사용되지 않음] |
Model1
경고 채널 구독.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
경고 채널 ID
|
alertChannelId | number |
경고 채널 식별자입니다. |
|
활성화
|
activated | boolean |
활성화 여부입니다. |
AlertChannelSubscriptionCreateList
경고 채널 구독 목록입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
경고 채널 구독
|
Model1 |
경고 채널 구독. |
privateLocations
검사를 실행할 하나 이상의 개인 위치 배열입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
string |
CheckGroup
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | number |
식별자입니다. |
|
이름
|
name | string |
확인 그룹의 이름입니다. |
|
활성화
|
activated | boolean |
그룹의 검사가 실행 중인지 여부를 확인합니다. |
|
음소거
|
muted | boolean |
이 그룹의 체크 인이 실패하거나 복구될 때 알림이 전송될지 여부를 결정합니다. |
|
그룹 태그 목록 확인
|
tags | CheckGroupTagList |
검사를 구성하고 필터링하기 위한 태그입니다. |
|
그룹 위치 목록 확인
|
locations | CheckGroupLocationList |
검사를 실행할 하나 이상의 데이터 센터 위치 배열입니다. |
|
Concurrency
|
concurrency | number |
CI/CD 또는 API를 통해 검사 그룹을 트리거할 때 동시에 호출되는 검사 수를 결정합니다. |
|
apiCheckDefaults
|
apiCheckDefaults | CheckGroupAPICheckDefaults | |
|
그룹 브라우저 기본값 확인
|
browserCheckDefaults | CheckGroupBrowserCheckDefaults |
확인 그룹 브라우저 확인 기본값입니다. |
|
environmentVariables
|
environmentVariables | EnvironmentVariableList | |
|
두 번 확인
|
doubleCheck | boolean |
이 값을 true로 설정하면 실패한 지역과 임의로 선택한 다른 지역에서 검사가 실패할 때 다시 시도가 트리거됩니다. |
|
전역 경고 설정 사용
|
useGlobalAlertSettings | boolean |
true이면 이 확인 그룹에 정의된 경고 설정이 아니라 계정 수준 경고 설정이 사용됩니다. |
|
그룹 경고 설정 확인
|
alertSettings | CheckGroupAlertSettings |
경고 설정. |
|
경고 채널 구독 만들기 목록
|
alertChannelSubscriptions | AlertChannelSubscriptionCreateList |
경고 채널 구독 목록입니다. |
|
코드 조각 ID 설정
|
setupSnippetId | number |
이 그룹의 API 검사 설정 단계에서 사용할 코드 조각에 대한 식별자 참조입니다. |
|
코드 조각 ID 분해
|
tearDownSnippetId | number |
이 그룹의 API 검사 중단 단계에서 사용할 코드 조각에 대한 식별자 참조입니다. |
|
로컬 설치 스크립트
|
localSetupScript | string |
이 그룹의 API 검사 설정 단계에서 실행할 유효한 Node.js 코드 조각입니다. |
|
로컬 중단 스크립트
|
localTearDownScript | string |
이 그룹에서 API 검사의 중단 단계에서 실행할 유효한 Node.js 코드 조각입니다. |
|
런타임 ID
|
runtimeId | string |
런타임 버전(예: 이 그룹에서 검사를 실행하는 데 사용되는 런타임 종속성 집합 고정)입니다. |
|
프라이빗 위치
|
privateLocations | privateLocations |
검사를 실행할 하나 이상의 개인 위치 배열입니다. |
|
만든 위치에서
|
created_at | date |
만들 때입니다. |
|
업데이트 날짜
|
updated_at | date-time |
업데이트 시. |
CheckGroupList
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
CheckGroup |
CheckLocationList
이 검사를 실행할 하나 이상의 데이터 센터 위치 배열입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
string |
CheckTagList
검사를 구성하고 필터링하기 위한 태그입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
string |
CheckAlertSettings
경고 설정.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
에스컬레이션 유형
|
escalationType | string |
사용할 에스컬레이션 유형을 결정합니다. |
|
runBasedEscalation
|
runBasedEscalation | AlertSettingsRunBasedEscalation | |
|
timeBasedEscalation
|
timeBasedEscalation | AlertSettingsTimeBasedEscalation | |
|
미리 알림
|
reminders | AlertSettingsReminders | |
|
경고 설정 SSL 인증서
|
sslCertificates | AlertSettingsSSLCertificates |
[사용되지 않음] |
CheckAlertChannelSubscription
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
경고 채널 ID
|
alertChannelId | number |
경고 채널 식별자입니다. |
|
활성화
|
activated | boolean |
활성화 여부입니다. |
CheckAlertChannelSubscriptionList
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
CheckAlertChannelSubscription |
CheckRequest
확인 요청입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
요청 확인
|
object |
확인 요청입니다. |
CheckEnvironmentVariableList
확인 실행 중에 환경 변수를 설정하기 위한 키/값 쌍입니다. 브라우저 검사와만 관련이 있습니다. 가능하면 전역 환경 변수를 사용합니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
EnvironmentVariable |
CheckAlertEmail
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
Address
|
address | string |
주소입니다. |
CheckAlertEmailList
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
CheckAlertEmail |
Model4
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
KeyValue |
Model5
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
KeyValue |
CheckAlertWebhook
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
이름
|
name | string |
이름입니다. |
|
URL
|
url | string |
URL 주소입니다. |
|
메서드
|
method | string |
메서드입니다. |
|
headers
|
headers | Model4 | |
|
쿼리 매개 변수
|
queryParameters | Model5 |
CheckAlertWebhookList
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
CheckAlertWebhook |
CheckAlertSlack
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
URL
|
url | string |
URL 주소입니다. |
CheckAlertSlackList
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
CheckAlertSlack |
CheckAlertSMS
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
Number
|
number | string |
숫자입니다. |
|
이름
|
name | string |
이름입니다. |
CheckAlertSMSList
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
CheckAlertSMS |
CheckAlertChannels
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
메일 주소
|
CheckAlertEmailList | ||
|
웹후크
|
webhook | CheckAlertWebhookList | |
|
느슨하게
|
slack | CheckAlertSlackList | |
|
sms
|
sms | CheckAlertSMSList |
CheckGroupCheck
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
식별자입니다. |
|
이름
|
name | string |
확인의 이름입니다. |
|
활성화
|
activated | boolean |
검사가 실행 중인지 여부를 확인합니다. |
|
음소거
|
muted | boolean |
확인이 실패하거나 복구될 때 알림을 보낼지 여부를 결정합니다. |
|
두 번 확인
|
doubleCheck | boolean |
이 값을 true로 설정하면 실패한 지역과 임의로 선택한 다른 지역에서 검사가 실패할 때 다시 시도가 트리거됩니다. |
|
실패해야 합니다.
|
shouldFail | boolean |
검사 실패로 간주되는 경우의 동작을 반전할 수 있습니다. 404와 같은 오류 상태의 유효성을 검사할 수 있습니다. |
|
위치 목록 확인
|
locations | CheckLocationList |
이 검사를 실행할 하나 이상의 데이터 센터 위치 배열입니다. |
|
태그 목록 확인
|
tags | CheckTagList |
검사를 구성하고 필터링하기 위한 태그입니다. |
|
경고 설정 확인
|
alertSettings | CheckAlertSettings |
경고 설정. |
|
전역 경고 설정 사용
|
useGlobalAlertSettings | boolean |
true이면 이 검사에 정의된 경고 설정이 아니라 계정 수준 경고 설정이 사용됩니다. |
|
그룹 아이디
|
groupId | number |
이 검사의 일부인 확인 그룹의 식별자입니다. |
|
그룹 순서
|
groupOrder | number |
확인 그룹에서 이 확인의 위치입니다. 그룹이 API 또는 CI/CD에서 트리거될 때 실행되는 순서 검사를 결정합니다. |
|
런타임 ID
|
runtimeId | string |
런타임 버전(예: 이 검사를 실행하는 데 사용되는 런타임 종속성 집합 고정)입니다. |
|
alertChannelSubscriptions
|
alertChannelSubscriptions | CheckAlertChannelSubscriptionList | |
|
확인 유형
|
checkType | string |
확인의 형식입니다. |
|
빈도
|
frequency | integer |
수표가 몇 분 안에 실행되는 빈도입니다. |
|
빈도 오프셋
|
frequencyOffset | integer |
빈도 오프셋입니다. |
|
요청 확인
|
request | CheckRequest |
확인 요청입니다. |
|
스크립트
|
script | string |
스크립트입니다. |
|
환경 변수 목록 확인
|
environmentVariables | CheckEnvironmentVariableList |
확인 실행 중에 환경 변수를 설정하기 위한 키/값 쌍입니다. 브라우저 검사와만 관련이 있습니다. 가능하면 전역 환경 변수를 사용합니다. |
|
코드 조각 ID 설정
|
setupSnippetId | number |
API 검사의 설정 단계에서 사용할 코드 조각에 대한 식별자 참조입니다. |
|
코드 조각 ID 분해
|
tearDownSnippetId | number |
API 검사의 중단 단계에서 사용할 코드 조각에 대한 식별자 참조입니다. |
|
로컬 설치 스크립트
|
localSetupScript | string |
설치 단계에서 실행할 유효한 Node.js 코드 조각입니다. |
|
로컬 중단 스크립트
|
localTearDownScript | string |
해체 단계에서 실행할 유효한 Node.js 코드 조각입니다. |
|
응답 시간 저하
|
degradedResponseTime | number |
확인을 저하된 것으로 간주해야 하는 응답 시간(밀리초)입니다. |
|
최대 응답 시간
|
maxResponseTime | number |
검사 실패로 간주되어야 하는 응답 시간(밀리초)입니다. |
|
alertChannels
|
alertChannels | CheckAlertChannels | |
|
프라이빗 위치
|
privateLocations | privateLocations |
검사를 실행할 하나 이상의 개인 위치 배열입니다. |
|
만든 위치에서
|
created_at | date |
만들 때입니다. |
|
업데이트 날짜
|
updated_at | date-time |
업데이트 시. |
Model8
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
CheckGroupCheck |
어설션을
API 검사 어설션 목록입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
string |
headers
헤더입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
Headers
|
object |
헤더입니다. |
params
매개 변수입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
Params
|
object |
매개 변수입니다. |
request
API에 대한 요청입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
method
|
method | string | |
|
url
|
url | string | |
|
데이터
|
data | string | |
|
Headers
|
headers | headers |
헤더입니다. |
|
Params
|
params | params |
매개 변수입니다. |
타이밍
타이밍입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
타이밍
|
object |
타이밍입니다. |
timingPhases
타이밍 단계입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
타이밍 단계
|
object |
타이밍 단계입니다. |
response
API 응답입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
상태
|
status | number |
상태입니다. |
|
상태 텍스트
|
statusText | string |
상태 텍스트입니다. |
|
몸
|
body | string |
본문입니다. |
|
Headers
|
headers | headers |
헤더입니다. |
|
타이밍
|
timings | timings |
타이밍입니다. |
|
타이밍 단계
|
timingPhases | timingPhases |
타이밍 단계입니다. |
jobLog
작업 로그입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
작업 로그
|
object |
작업 로그입니다. |
jobAssets
확인 실행에서 생성된 자산입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
string |
CheckResultAPI
API 검사에 대한 응답 데이터입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
Assertions
|
assertions | assertions |
API 검사 어설션 목록입니다. |
|
요청
|
request | request |
API에 대한 요청입니다. |
|
응답
|
response | response |
API 응답입니다. |
|
요청 오류
|
requestError | string |
요청에 오류가 발생했는지를 설명합니다. |
|
작업 로그
|
jobLog | jobLog |
작업 로그입니다. |
|
작업 자산
|
jobAssets | jobAssets |
확인 실행에서 생성된 자산입니다. |
오류
확인 실행의 오류 목록입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
string |
Model9
실행 로그 결과를 확인합니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
string |
traceSummary
추적 요약입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
추적 요약
|
object |
추적 요약입니다. |
pages
확인 실행에 사용되는 페이지 목록입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
string |
CheckResultBrowser
브라우저 검사에 대한 응답 데이터입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
유형
|
type | string |
검사에서 사용하는 프레임워크의 유형입니다. |
|
Errors
|
errors | errors |
확인 실행의 오류 목록입니다. |
|
종료 시간
|
endTime | number |
검사 실행의 종료 시간입니다. |
|
시작 시간
|
startTime | number |
확인 실행의 시작 시간입니다. |
|
런타임 버전
|
runtimeVersion | string |
활성 런타임 버전입니다. |
|
실행 로그 확인
|
jobLog | Model9 |
실행 로그 결과를 확인합니다. |
|
작업 자산
|
jobAssets | jobAssets |
확인 실행에서 생성된 자산입니다. |
|
추적 요약
|
traceSummary | traceSummary |
추적 요약입니다. |
|
페이지
|
pages | pages |
확인 실행에 사용되는 페이지 목록입니다. |
CheckResult
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
이 결과의 고유 식별자입니다. |
|
이름
|
name | string |
확인의 이름입니다. |
|
ID 확인
|
checkId | string |
확인의 식별자입니다. |
|
실패
|
hasFailures | boolean |
이 검사 실행 중에 오류가 발생했는지 설명합니다. 이는 API 또는 브라우저 확인 동작을 평가하는 데 중점을 두어야 합니다. 실패한 어설션, 시간 제한 또는 실패한 스크립트는 모두 이 값이 true로 확인됩니다. |
|
오류 있음
|
hasErrors | boolean |
Checkly의 백 엔드에서 내부 오류가 발생했는지 설명합니다. 이는 거의 모든 경우에 false여야 합니다. |
|
성능 저하됨
|
isDegraded | boolean |
검사의 degradedResponseTime 필드에 의해 설정된 성능 저하 제한을 초과하면 검사가 저하됩니다. API 검사에만 적용됩니다. |
|
최대 응답 시간 초과
|
overMaxResponseTime | boolean |
응답 시간이 검사의 maxResponseTime 필드에 의해 설정된 제한을 초과하면 true로 설정합니다. API 검사에만 적용됩니다. |
|
실행 위치
|
runLocation | string |
이 검사 결과가 시작된 데이터 센터 위치입니다. |
|
시작 날짜
|
startedAt | date-time |
시간에 시작된 것입니다. |
|
중지됨
|
stoppedAt | date-time |
중지된 시간입니다. |
|
만든 위치에서
|
created_at | date-time |
만들 때입니다. |
|
응답 시간
|
responseTime | number |
이 검사의 관련 부분을 실행하는 데 걸린 시간을 설명합니다. Checkly 백 엔드에서 이 검사를 실행하는 데 필요한 설치 타이머 시스템 시간은 이 작업의 일부가 아닙니다. |
|
결과 API 확인
|
apiCheckResult | CheckResultAPI |
API 검사에 대한 응답 데이터입니다. |
|
브라우저 검사 결과
|
browserCheckResult | CheckResultBrowser |
브라우저 검사에 대한 응답 데이터입니다. |
|
실행 ID 확인
|
checkRunId | number |
이 검사 결과를 만든 특정 검사 실행의 식별자입니다. |
|
시도
|
attempts | number |
이 검사를 얼마나 자주 다시 시도했는지. 이중 검사를 사용하도록 설정하면 0보다 커집니다. |
CheckResultList
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
CheckResult |
CheckStatus
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
이름
|
name | string |
확인의 이름입니다. |
|
ID 확인
|
checkId | string |
이 상태가 속하는지 확인하는 식별자입니다. |
|
실패
|
hasFailures | boolean |
이 검사가 현재 실패하는지 설명합니다. API 검사에 대한 어설션이 있으면 이 값이 true입니다. 어떤 이유로든 브라우저 검사가 실패하는 경우 이는 사실입니다. |
|
오류 있음
|
hasErrors | boolean |
정상 작업 이외의 일부 오류로 인해 이 검사가 실패하는지 설명합니다. 이는 매우 드물며 Checkly 백 엔드에 오류가 있는 경우에만 발생합니다. |
|
성능 저하됨
|
isDegraded | boolean |
검사의 degradedResponseTime 필드에 의해 설정된 성능 저하 제한을 초과하면 검사가 저하됩니다. API 검사에만 적용됩니다. |
|
가장 긴 실행
|
longestRun | number |
이 검사에 대해 기록된 응답 시간 중 가장 긴 시간입니다. |
|
최단 실행
|
shortestRun | number |
이 검사에 대해 기록된 가장 짧은 응답 시간입니다. |
|
마지막 실행 위치
|
lastRunLocation | string |
이 확인이 마지막으로 실행된 위치입니다. |
|
마지막 실행 ID 확인
|
lastCheckRunId | string |
각 검사 실행에 대한 고유 증분 식별자입니다. |
|
SSL 일 수 남은 날짜
|
sslDaysRemaining | number |
현재 SSL 인증서가 만료될 때까지 남은 일 수입니다. |
|
만든 위치에서
|
created_at | date |
만들 때입니다. |
|
업데이트 날짜
|
updated_at | date-time |
업데이트 시. |
CheckStatusList
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
CheckStatus |
확인
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
식별자입니다. |
|
이름
|
name | string |
확인의 이름입니다. |
|
활성화
|
activated | boolean |
검사가 실행 중인지 여부를 확인합니다. |
|
음소거
|
muted | boolean |
확인이 실패하거나 복구될 때 알림을 보낼지 여부를 결정합니다. |
|
두 번 확인
|
doubleCheck | boolean |
이 값을 true로 설정하면 실패한 지역과 임의로 선택한 다른 지역에서 검사가 실패할 때 다시 시도가 트리거됩니다. |
|
실패해야 합니다.
|
shouldFail | boolean |
검사 실패로 간주되는 경우의 동작을 반전할 수 있습니다. 404와 같은 오류 상태의 유효성을 검사할 수 있습니다. |
|
위치 목록 확인
|
locations | CheckLocationList |
이 검사를 실행할 하나 이상의 데이터 센터 위치 배열입니다. |
|
태그 목록 확인
|
tags | CheckTagList |
검사를 구성하고 필터링하기 위한 태그입니다. |
|
경고 설정 확인
|
alertSettings | CheckAlertSettings |
경고 설정. |
|
전역 경고 설정 사용
|
useGlobalAlertSettings | boolean |
true이면 이 검사에 정의된 경고 설정이 아니라 계정 수준 경고 설정이 사용됩니다. |
|
그룹 아이디
|
groupId | number |
이 검사의 일부인 확인 그룹의 식별자입니다. |
|
그룹 순서
|
groupOrder | number |
확인 그룹에서 이 확인의 위치입니다. 그룹이 API 또는 CI/CD에서 트리거될 때 실행되는 순서 검사를 결정합니다. |
|
런타임 ID
|
runtimeId | string |
런타임 버전(예: 이 검사를 실행하는 데 사용되는 런타임 종속성 집합 고정)입니다. |
|
alertChannelSubscriptions
|
alertChannelSubscriptions | CheckAlertChannelSubscriptionList | |
|
확인 유형
|
checkType | string |
확인의 형식입니다. |
|
빈도
|
frequency | integer |
수표가 몇 분 안에 실행되는 빈도입니다. |
|
빈도 오프셋
|
frequencyOffset | integer |
빈도 오프셋입니다. |
|
요청 확인
|
request | CheckRequest |
확인 요청입니다. |
|
스크립트
|
script | string |
스크립트입니다. |
|
환경 변수 목록 확인
|
environmentVariables | CheckEnvironmentVariableList |
확인 실행 중에 환경 변수를 설정하기 위한 키/값 쌍입니다. 브라우저 검사와만 관련이 있습니다. 가능하면 전역 환경 변수를 사용합니다. |
|
코드 조각 ID 설정
|
setupSnippetId | number |
API 검사의 설정 단계에서 사용할 코드 조각에 대한 식별자 참조입니다. |
|
코드 조각 ID 분해
|
tearDownSnippetId | number |
API 검사의 중단 단계에서 사용할 코드 조각에 대한 식별자 참조입니다. |
|
로컬 설치 스크립트
|
localSetupScript | string |
설치 단계에서 실행할 유효한 Node.js 코드 조각입니다. |
|
로컬 중단 스크립트
|
localTearDownScript | string |
해체 단계에서 실행할 유효한 Node.js 코드 조각입니다. |
|
응답 시간 저하
|
degradedResponseTime | number |
확인을 저하된 것으로 간주해야 하는 응답 시간(밀리초)입니다. |
|
최대 응답 시간
|
maxResponseTime | number |
검사 실패로 간주되어야 하는 응답 시간(밀리초)입니다. |
|
alertChannels
|
alertChannels | CheckAlertChannels | |
|
프라이빗 위치
|
privateLocations | privateLocations |
검사를 실행할 하나 이상의 개인 위치 배열입니다. |
|
만든 위치에서
|
created_at | date |
만들 때입니다. |
|
업데이트 날짜
|
updated_at | date-time |
업데이트 시. |
검사 목록
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
Check |
Model14
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
KeyValue |
Model15
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
KeyValue |
Model16
검사를 실행할 요청을 결정합니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
method
|
method | string | |
|
URL
|
url | string |
URL 주소입니다. |
|
리디렉션 따르기
|
followRedirects | boolean |
리디렉션을 따를지 여부입니다. |
|
SSL 건너뛰기
|
skipSSL | boolean |
SSL을 건너뛸지 여부입니다. |
|
몸
|
body | string |
본문입니다. |
|
체격 유형
|
bodyType | string |
본문 유형입니다. |
|
headers
|
headers | Model14 | |
|
쿼리 매개 변수
|
queryParameters | Model15 | |
|
어설션 목록
|
assertions | AssertionList |
속성 필드에서 사용할 수 있는 정규식 및 JSON 경로 설명자와 같은 특정 값에 대한 어설션에 대한 기본 검사 설명서를 확인합니다. |
|
basicAuth
|
basicAuth | BasicAuth |
CheckAPI
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
식별자입니다. |
|
이름
|
name | string |
확인의 이름입니다. |
|
활성화
|
activated | boolean |
검사가 실행 중인지 여부를 확인합니다. |
|
음소거
|
muted | boolean |
확인이 실패하거나 복구될 때 알림을 보낼지 여부를 결정합니다. |
|
두 번 확인
|
doubleCheck | boolean |
이 값을 true로 설정하면 실패한 지역과 임의로 선택한 다른 지역에서 검사가 실패할 때 다시 시도가 트리거됩니다. |
|
실패해야 합니다.
|
shouldFail | boolean |
검사 실패로 간주되는 경우의 동작을 반전할 수 있습니다. 404와 같은 오류 상태의 유효성을 검사할 수 있습니다. |
|
위치 목록 확인
|
locations | CheckLocationList |
이 검사를 실행할 하나 이상의 데이터 센터 위치 배열입니다. |
|
태그 목록 확인
|
tags | CheckTagList |
검사를 구성하고 필터링하기 위한 태그입니다. |
|
경고 설정 확인
|
alertSettings | CheckAlertSettings |
경고 설정. |
|
전역 경고 설정 사용
|
useGlobalAlertSettings | boolean |
true이면 이 검사에 정의된 경고 설정이 아니라 계정 수준 경고 설정이 사용됩니다. |
|
그룹 아이디
|
groupId | number |
이 검사의 일부인 확인 그룹의 식별자입니다. |
|
그룹 순서
|
groupOrder | number |
확인 그룹에서 이 확인의 위치입니다. 그룹이 API 또는 CI/CD에서 트리거될 때 실행되는 순서 검사를 결정합니다. |
|
런타임 ID
|
runtimeId | string |
런타임 버전(예: 이 검사를 실행하는 데 사용되는 런타임 종속성 집합 고정)입니다. |
|
alertChannelSubscriptions
|
alertChannelSubscriptions | CheckAlertChannelSubscriptionList | |
|
요청 확인
|
request | Model16 |
검사를 실행할 요청을 결정합니다. |
|
빈도
|
frequency | integer |
수표가 몇 분 안에 실행되는 빈도입니다. |
|
빈도 오프셋
|
frequencyOffset | integer |
1분 미만의 검사 빈도에 초를 설정하고(API 검사에만 해당) 1분 이상 빈도에 대한 시간 범위에 대한 검사를 분산하는 데 사용됩니다. 이는 다음과 같이 작동합니다. 빈도가 0인 검사는 frequencyOffset이 10, 20 또는 30일 수 있으므로 10초, 20초 또는 30초마다 실행됩니다. 빈도가 60보다 낮고 같은 검사는 수식 Math.floor(frequency * 10)를 기반으로 1에서 최대값 사이의 frequencyOffset을 가질 수 있습니다. 즉, 5분마다 실행되는 검사의 경우 max frequencyOffset은 50입니다. 빈도가 60보다 높은 검사는 Math.ceil(frequency/60) 수식을 기준으로 1에서 최대값 사이의 frequencyOffset을 가질 수 있습니다. 즉, 720분마다 실행되는 검사의 경우 최대 frequencyOffset은 12입니다. |
|
코드 조각 ID 분해
|
tearDownSnippetId | number |
API 검사의 중단 단계에서 사용할 코드 조각에 대한 식별자 참조입니다. |
|
코드 조각 ID 설정
|
setupSnippetId | number |
API 검사의 설정 단계에서 사용할 코드 조각에 대한 식별자 참조입니다. |
|
로컬 설치 스크립트
|
localSetupScript | string |
설치 단계에서 실행할 유효한 Node.js 코드 조각입니다. |
|
로컬 중단 스크립트
|
localTearDownScript | string |
해체 단계에서 실행할 유효한 Node.js 코드 조각입니다. |
|
응답 시간 저하
|
degradedResponseTime | number |
확인을 저하된 것으로 간주해야 하는 응답 시간(밀리초)입니다. |
|
최대 응답 시간
|
maxResponseTime | number |
검사 실패로 간주되어야 하는 응답 시간(밀리초)입니다. |
|
프라이빗 위치
|
privateLocations | privateLocations |
검사를 실행할 하나 이상의 개인 위치 배열입니다. |
|
확인 유형
|
checkType | string |
확인 유형입니다. |
|
alertChannels
|
alertChannels | CheckAlertChannels | |
|
만든 위치에서
|
created_at | date |
만들 때입니다. |
|
업데이트 날짜
|
updated_at | date-time |
업데이트 시. |
CheckBrowser
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
식별자입니다. |
|
이름
|
name | string |
확인의 이름입니다. |
|
활성화
|
activated | boolean |
검사가 실행 중인지 여부를 확인합니다. |
|
음소거
|
muted | boolean |
확인이 실패하거나 복구될 때 알림을 보낼지 여부를 결정합니다. |
|
두 번 확인
|
doubleCheck | boolean |
이 값을 true로 설정하면 실패한 지역과 임의로 선택한 다른 지역에서 검사가 실패할 때 다시 시도가 트리거됩니다. |
|
실패해야 합니다.
|
shouldFail | boolean |
검사 실패로 간주되는 경우의 동작을 반전할 수 있습니다. 404와 같은 오류 상태의 유효성을 검사할 수 있습니다. |
|
위치 목록 확인
|
locations | CheckLocationList |
이 검사를 실행할 하나 이상의 데이터 센터 위치 배열입니다. |
|
태그 목록 확인
|
tags | CheckTagList |
검사를 구성하고 필터링하기 위한 태그입니다. |
|
경고 설정 확인
|
alertSettings | CheckAlertSettings |
경고 설정. |
|
전역 경고 설정 사용
|
useGlobalAlertSettings | boolean |
true이면 이 검사에 정의된 경고 설정이 아니라 계정 수준 경고 설정이 사용됩니다. |
|
그룹 아이디
|
groupId | number |
이 검사의 일부인 확인 그룹의 식별자입니다. |
|
그룹 순서
|
groupOrder | number |
확인 그룹에서 이 확인의 위치입니다. 그룹이 API 또는 CI/CD에서 트리거될 때 실행되는 순서 검사를 결정합니다. |
|
런타임 ID
|
runtimeId | string |
런타임 버전(예: 이 검사를 실행하는 데 사용되는 런타임 종속성 집합 고정)입니다. |
|
alertChannelSubscriptions
|
alertChannelSubscriptions | CheckAlertChannelSubscriptionList | |
|
확인 유형
|
checkType | string |
확인 유형입니다. |
|
빈도
|
frequency | integer |
수표가 몇 분 안에 실행되는 빈도입니다. |
|
스크립트
|
script | string |
Puppeteer 또는 Playwright 프레임워크와의 브라우저 상호 작용을 설명하는 유효한 Node.js javascript 코드입니다. |
|
프라이빗 위치
|
privateLocations | privateLocations |
검사를 실행할 하나 이상의 개인 위치 배열입니다. |
|
alertChannels
|
alertChannels | CheckAlertChannels | |
|
만든 위치에서
|
created_at | date |
만들 때입니다. |
|
업데이트 날짜
|
updated_at | date-time |
업데이트 시. |
DashboardTagList
대시보드에 표시할지를 검사하는 하나 이상의 태그 목록입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
string |
Dashboard
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
사용자 지정 도메인
|
customDomain | string |
사용자 지정 사용자 도메인(예: status.example.com) DNS 및 SSL 사용량 업데이트에 대한 문서를 참조하세요. |
|
사용자 지정 URL
|
customUrl | string |
checklyhq.com 아래의 하위 도메인 이름입니다. 모든 사용자 간에 고유해야 합니다. |
|
로고
|
logo | string |
이미지 파일을 가리키는 URL입니다. |
|
파비콘 (사이트 아이콘)
|
favicon | string |
대시보드 favicon으로 사용되는 이미지 파일을 가리키는 URL입니다. |
|
Link
|
link | string |
대시보드 로고를 클릭할 때 리디렉션할 URL 링크입니다. |
|
Header
|
header | string |
대시보드의 맨 위에 표시되는 텍스트 조각입니다. |
|
Description
|
description | string |
대시보드의 머리글 또는 제목 아래에 표시되는 텍스트 조각입니다. |
|
너비
|
width | string |
전체 화면 또는 포커스를 가운데에 사용할지 여부를 결정합니다. |
|
재생 빈도
|
refreshRate | number |
몇 초 안에 대시보드를 새로 고치는 빈도입니다. |
|
페이지 매김
|
paginate | boolean |
페이지 매김이 켜지거나 꺼져 있는지 확인합니다. |
|
페이지 매김 비율
|
paginationRate | number |
페이지 매김을 트리거하는 빈도(초)입니다. |
|
페이지당 검사
|
checksPerPage | number |
페이지당 표시되는 검사 수입니다. |
|
사용 및 연산자
|
useTagsAndOperator | boolean |
태그 조회에 AND 연산자를 사용하는 경우 |
|
태그 숨기기
|
hideTags | boolean |
대시보드에서 태그를 표시하거나 숨깁니다. |
|
대시보드 태그 목록
|
tags | DashboardTagList |
대시보드에 표시할지를 검사하는 하나 이상의 태그 목록입니다. |
|
대시보드 ID
|
dashboardId | string |
대시보드 식별자입니다. |
DashboardsList
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
Dashboard |
위치
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
지역
|
region | string |
이 위치의 고유 식별자입니다. |
|
이름
|
name | string |
이 위치의 이름입니다. |
LocationList
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
Location |
MaintenanceWindowTagList
검사 및 그룹 유지 관리 기간의 이름이 적용됩니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
string |
유지 관리 창
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | number |
유지 관리 기간의 식별자입니다. |
|
이름
|
name | string |
유지 관리 기간 이름입니다. |
|
유지 관리 기간 태그 목록
|
tags | MaintenanceWindowTagList |
검사 및 그룹 유지 관리 기간의 이름이 적용됩니다. |
|
시작 날짜
|
startsAt | date |
유지 관리 기간의 시작 날짜입니다. |
|
종료 시
|
endsAt | date |
유지 관리 기간의 종료 날짜입니다. |
|
반복 간격
|
repeatInterval | number |
처음 발생한 유지 관리 기간의 반복 간격입니다. |
|
반복 단위
|
repeatUnit | string |
유지 관리 기간에 대한 반복 전략입니다. |
|
반복 종료 시
|
repeatEndsAt | date |
유지 관리 기간이 반복을 중지해야 하는 종료 날짜입니다. |
|
만든 위치에서
|
created_at | date |
유지 관리 기간의 생성 날짜입니다. |
|
업데이트 날짜
|
updated_at | date |
유지 관리 기간이 업데이트된 마지막 날짜입니다. |
MaintenanceWindowList
유지 관리 기간 목록입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
MaintenanceWindow |
CheckAssignment
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | guid |
식별자입니다. |
|
ID 확인
|
checkId | guid |
확인의 식별자입니다. |
|
개인 위치 ID
|
privateLocationId | guid |
할당된 개인 위치의 식별자입니다. |
checkAssignments
이 개인 위치가 할당되었는지 확인합니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
CheckAssignment |
GroupAssignment
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | guid |
식별자입니다. |
|
그룹 아이디
|
groupId | number |
그룹의 식별자입니다. |
|
개인 위치 ID
|
privateLocationId | guid |
할당된 개인 위치의 식별자입니다. |
groupAssignments
이 개인 위치에 할당된 그룹입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
GroupAssignment |
privateLocationKeys
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | guid |
식별자입니다. |
|
원시 키
|
rawKey | string |
원시 키입니다. |
|
마스킹된 키
|
maskedKey | string |
마스킹된 키 값입니다. |
|
만든 위치에서
|
created_at | date |
만들 때입니다. |
|
업데이트 날짜
|
updated_at | date |
업데이트 시. |
열쇠
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
privateLocationKeys |
privatelocationschema
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | guid |
식별자입니다. |
|
이름
|
name | string |
개인 위치에 할당된 이름입니다. |
|
슬러그 이름
|
slugName | string |
유효한 슬러그 이름입니다. |
|
Icon
|
icon | string |
개인 위치 아이콘입니다. |
|
만든 위치에서
|
created_at | date |
만들 때입니다. |
|
업데이트 날짜
|
updated_at | date |
업데이트 시. |
|
할당 확인
|
checkAssignments | checkAssignments |
이 개인 위치가 할당되었는지 확인합니다. |
|
그룹 할당
|
groupAssignments | groupAssignments |
이 개인 위치에 할당된 그룹입니다. |
|
열쇠
|
keys | keys | |
|
마지막으로 본 것
|
lastSeen | date |
마지막으로 본 날짜입니다. |
|
에이전트 수
|
agentCount | number |
에이전트 수입니다. |
privateLocationsListSchema
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
privatelocationschema |
commonPrivateLocationSchemaResponse
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | guid |
식별자입니다. |
|
이름
|
name | string |
개인 위치에 할당된 이름입니다. |
|
슬러그 이름
|
slugName | string |
유효한 슬러그 이름입니다. |
|
Icon
|
icon | string |
개인 위치 아이콘입니다. |
|
만든 위치에서
|
created_at | date |
만들 때입니다. |
|
업데이트 날짜
|
updated_at | date |
업데이트 시. |
|
할당 확인
|
checkAssignments | checkAssignments |
이 개인 위치가 할당되었는지 확인합니다. |
|
그룹 할당
|
groupAssignments | groupAssignments |
이 개인 위치에 할당된 그룹입니다. |
|
열쇠
|
keys | keys |
타임 스탬프
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
시간표시
|
date-time |
타임스탬프입니다. |
queueSize
큐 크기입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
number |
oldestScheduledCheckRun
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
number |
privateLocationsMetricsHistoryResponseSchema
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
타임 스탬프
|
timestamps | timestamps | |
|
큐 크기
|
queueSize | queueSize |
큐 크기입니다. |
|
oldestScheduledCheckRun
|
oldestScheduledCheckRun | oldestScheduledCheckRun |
ReportingTagList
태그를 확인합니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
string |
ReportingAggregate
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
성공 비율
|
successRatio | number |
선택한 날짜 범위에 대한 검사의 성공 비율입니다. 백분율은 10진수 형식입니다. |
|
Average
|
avg | number |
선택한 날짜 범위에 대한 검사의 평균 응답 시간(밀리초)입니다. |
|
P95
|
p95 | number |
선택한 날짜 범위에 대한 검사의 P95 응답 시간(밀리초)입니다. |
|
P99
|
p99 | number |
선택한 날짜 범위에 대한 검사의 P99 응답 시간(밀리초)입니다. |
보고
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
이름
|
name | string |
이름을 확인합니다. |
|
ID 확인
|
checkId | string |
ID를 확인합니다. |
|
확인 유형
|
checkType | string |
형식을 확인합니다. |
|
비활성화
|
deactivated | boolean |
비활성화된 항목을 확인합니다. |
|
보고 태그 목록
|
tags | ReportingTagList |
태그를 확인합니다. |
|
aggregate
|
aggregate | ReportingAggregate |
ReportingList
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
Reporting |
실행 시간
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
이름
|
name | string |
이 런타임의 고유한 이름입니다. |
|
단계
|
stage | string |
런타임의 현재 수명 단계입니다. |
|
런타임 수명 종료
|
runtimeEndOfLife | string |
플랫폼에서 런타임을 제거할 날짜입니다. |
|
Default
|
default | boolean |
Checkly에서 제공하는 현재 기본 런타임인지 여부를 나타냅니다. |
|
Description
|
description | string |
이 런타임의 주요 업데이트에 대한 짧고 사람이 읽을 수 있는 설명입니다. |
|
String
|
dependencies.string | string |
문자열입니다. |
RuntimeList
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
Runtime |
단편
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | number |
식별자입니다. |
|
이름
|
name | string |
코드 조각 이름입니다. |
|
스크립트
|
script | string |
API 검사 수명 주기와 상호 작용하는 Node.js 코드 또는 브라우저 검사의 일부로 작동합니다. |
|
만든 위치에서
|
created_at | date-time |
만들 때입니다. |
|
업데이트 날짜
|
updated_at | date-time |
업데이트 시. |
SnippetList
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
Snippet |
CheckGroupTrigger
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | number |
식별자입니다. |
|
토큰
|
token | string |
토큰입니다. |
|
만든 위치에서
|
created_at | date |
만들 때입니다. |
|
호출 시
|
called_at | date |
호출 시. |
|
업데이트 날짜
|
updated_at | date |
업데이트 시. |
|
그룹 아이디
|
groupId | number |
그룹 식별자입니다. |
CheckTrigger
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | number |
식별자입니다. |
|
토큰
|
token | string |
토큰입니다. |
|
만든 위치에서
|
created_at | date |
만들 때입니다. |
|
호출 시
|
called_at | date |
호출 시. |
|
업데이트 날짜
|
updated_at | date |
업데이트 시. |
|
ID 확인
|
checkId | string |
확인 식별자입니다. |
객체
'object' 형식입니다.
문자열
기본 데이터 형식 'string'입니다.