목록¶
GET /api/v1/alert_policy/list
개요¶
현재 워크스페이스에서 삭제되지 않은 알림 정책, 바인딩 수 및 현재 ID의 작업 권한을 페이지 단위로 나열합니다.
호출 전 및 사용 단계¶
기본값은 pageIndex=1, pageSize=20이며, 업데이트 시간 내림차순으로 정렬하고 업데이트되지 않은 레코드는 생성 시간으로 비교합니다. 활성 및 비활성 정책을 포함합니다. content.data 및 최상위 pageInfo를 읽습니다. 알림 대상 필터는 영문 쉼표로 연결된 UUID 문자열을 사용하며, 여러 대상 중 하나라도 일치하면 선택됩니다. 현재는 구성 텍스트를 기준으로 매칭하므로 정확한 구조적 연관 또는 대상 유효성을 독립적으로 증명할 수 없으므로 상세 정보를 확인해야 합니다. 반환되는 silentTimeout은 호환 표시 정규화를 수행합니다. 0이 아닌 정수가 300 미만이면 300으로, 정수가 아닌 기존 값은 900으로 표시합니다. 현재 버전의 최상위 ruleTimezone은 저장 및 표시되지만, 실행 시 캐시에서 기존 alertOpt.ruleTimezone을 읽으며 기본값은 Asia/Shanghai입니다. 기타 시간대는 저장 성공만으로 적용되었다고 판단할 수 없으며, 연동 측은 실제 실행 시간대로 검증해야 합니다. 추가로 선언되지 않은 필드로 공개 파라미터를 우회하지 마십시오.
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Query 요청 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| notifyObjectUUIDs | commaArray | 선택적 알림 대상 필터로, 여러 개는 하나라도 일치하면 됩니다. 실제 UUID 문자열을 전달하고 정규식 또는 JSON 배열은 전달하지 마십시오. 특수 정규식 문자는 내부 오류를 일으킬 수 있습니다. null 허용: False 예시: notify_example가져오기 또는 입력 방법: 알림 대상 목록에서 하나 이상의 UUID를 복사하고, 여러 항목은 영문 쉼표로 연결합니다(예: notify_a,notify_b). |
|
| pageIndex | integer | 페이지 번호, 기본값 1, 최소 1. null 허용: False $minValue: 1 예시: 1가져오기 또는 입력 방법: 첫 페이지는 1이며 이후 페이지마다 증가시킵니다. |
|
| pageSize | integer | 페이지당 수량, 기본값 20. null 허용: False $maxValue: 100 $minValue: 1 예시: 20가져오기 또는 입력 방법: 필요에 따라 1~100 사이의 정수를 입력합니다. |
|
| search | string | 선택적 이름 부분 검색입니다. null 허용: True 예시: 生产가져오기 또는 입력 방법: 알림 정책 이름에 포함된 텍스트를 입력합니다. 생략하거나 공백이면 이름으로 필터링하지 않습니다. |
파라미터 추가 설명¶
알림 작업의 전체 필드 구성은 알림 정책 생성 v2를 참조하십시오. 이 API에는 checkerUUIDs, accountUUIDs 또는 refFilter와 같은 내부 필터 필드가 선언되어 있지 않습니다.
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/alert_policy/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode pageIndex=1 \
--data-urlencode pageSize=20
응답¶
HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.data | array<object> |
현재 페이지 정책, 결과가 없으면 []입니다. |
| content.data[].id | integer 또는 null | 정책 레코드 번호, 생성 응답에서는 아직 할당되지 않았을 수 있습니다. 작업에는 uuid를 사용합니다. |
| content.data[].uuid | string | altpl_ 알림 정책 UUID. |
| content.data[].workspaceUUID | string | 소속 워크스페이스 UUID. |
| content.data[].name | string | 정책 이름. |
| content.data[].desc | string | 정책 설명. |
| content.data[].ruleTimezone | string | 저장된 엔터티 시간대; 실행 시 읽기 차이는 사용법을 참조하며, 시간대가 적용되었음을 증명하지 않습니다. |
| content.data[].score | integer | 정책 점수 필드, 생성 시 기본값 0이며 이 공개 요청에서는 해당 필드를 제공하지 않습니다. |
| content.data[].openPermissionSet | boolean | 사용자 정의 작업 권한 스위치. |
| content.data[].permissionSet | array<string> |
작업 가능한 역할/구성원/팀 식별자. |
| content.data[].permissionSet[] | string | 단일 주체 식별자. |
| 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[].alertOpt | object | 저장된 구성: 알림 알림 구성 객체; 생성 시 생략하면 빈 구성으로 저장될 수 있고, 수정 시 전달하면 전체 교체됩니다. 객체 제공 시 aggInterval은 필수 검증 필드입니다. |
| content.data[].alertOpt.alertType | string | 저장된 구성: status는 등급 기준, member는 구성원 기준, 생략 시 기본값 status입니다. 두 모드의 targets 계층 구조가 다르므로 혼용할 수 없습니다. |
| content.data[].alertOpt.silentTimeout | integer | 저장된 구성: 통합 반복 알림 간격, 생략 시 실행 기본값은 900초; 0은 이번 라운드에서 주기적으로 반복하지 않음을 의미합니다. 0이 아니고 300 미만이면 실행 시 300초로 처리합니다. null을 전달하지 마십시오. |
| content.data[].alertOpt.silentTimeoutByStatusEnable | boolean | 저장된 구성: 생성 기본값 false이면 silentTimeout을 사용하고, true이면 silentTimeoutByStatus에 따라 상태별 간격으로 분리합니다. |
| content.data[].alertOpt.silentTimeoutByStatus | array<object> |
저장된 구성: 등급별 반복 간격 배열; 활성화 시 제어해야 하는 등급을 포함해야 합니다. 이 등급별 구성은 통합 silentTimeout의 300초 정규화를 거치지 않습니다. |
| content.data[].alertOpt.silentTimeoutByStatus[] | object | 저장된 구성: 등급별 간격 객체. |
| content.data[].alertOpt.silentTimeoutByStatus[].status | string | 저장된 구성: 비보안에서 사용 가능한 값은 fatal/critical/error/warning/nodata/info/ALL이고, 보안에서는 security_critical/security_high/security_medium/security_low/security_info/security_ALL을 사용합니다. 여러 값은 영문 쉼표로 연결하고 공백을 넣지 않습니다. |
| content.data[].alertOpt.silentTimeoutByStatus[].silentTimeout | integer | 저장된 구성: 각 그룹의 필수 반복 간격, 단위 초. 잘못된 등급은 내부 오류를 일으킬 수 있으므로 전송 전에 검증하십시오. |
| content.data[].alertOpt.aggInterval | integer | 저장된 구성: alertOpt 제공 시 필수, 0~1800초. 0은 집계하지 않으며, byAI를 선택하더라도 유효한 AI 집계가 활성화되었음을 의미하지 않습니다. |
| content.data[].alertOpt.aggFields | array<string> |
저장된 구성: 필드 목록. 사전 정의된 사용 가능 값은 df_monitor_checker_id, df_dimension_tags, df_label, CLUSTER; byCustom 모드에서는 업무 사용자 정의 필드가 될 수 있으며, v2 집계 모드의 aggType은 별도로 참조하십시오. |
| content.data[].alertOpt.aggFields[] | string | 저장된 구성: 단일 집계 필드. byCustom은 실제 이벤트 필드를 기준으로 선택하며 표시 이름만으로 필드를 추측하지 마십시오. |
| content.data[].alertOpt.aggLabels | array<string> |
저장된 구성: 태그 기준 집계의 태그 값 배열; df_label 선택 시 비어 있지 않은 배열을 제공해야 합니다. |
| content.data[].alertOpt.aggLabels[] | string | 저장된 구성: 단일 태그 값. |
| content.data[].alertOpt.aggClusterFields | array<string> |
저장된 구성: 지능형 집계 텍스트 필드; CLUSTER 포함 시 df_title 또는 df_message를 하나 이상 선택해야 합니다. |
| content.data[].alertOpt.aggClusterFields[] | string | 저장된 구성: 단일 텍스트 필드. |
| content.data[].alertOpt.alertTarget | array<object> |
저장된 구성: 알림 규칙 배열. status 모드는 targets에 등급 작업을 배치하고, member 모드는 alertInfo에서 구성원 및 알림 방식을 구성합니다. |
| content.data[].alertOpt.alertTarget[] | object | 저장된 구성: 규칙 객체. 폴백이 필요하면 시간 구성이 없는 규칙을 명시적으로 추가하며, 시스템이 자동으로 보완한다고 가정하지 마십시오. |
| content.data[].alertOpt.alertTarget[].name | string | 저장된 구성: 선택적 규칙 이름, 최대 256자. |
| content.data[].alertOpt.alertTarget[].crontab | string | 저장된 구성: 주기 시작 시간 표현식, crontabDuration과 쌍으로 사용해야 합니다. 사용자 정의 날짜 방식과 둘 중 하나를 선택합니다. |
| content.data[].alertOpt.alertTarget[].crontabDuration | integer | 저장된 구성: 주기 윈도 지속 시간(초). crontab 제공 시 반드시 함께 제공해야 하며, 반복 시간대를 구성하지 않으면 둘 다 생략합니다. |
| content.data[].alertOpt.alertTarget[].customDateUUIDs | array<string> |
저장된 구성: 사용자 정의 날짜 집합 참조, 최대 366개; customStartTime, customDuration과 함께 제공하며 crontabDuration으로 대체하지 않습니다. |
| content.data[].alertOpt.alertTarget[].customDateUUIDs[] | string | 저장된 구성: 단일 날짜 구성 UUID. |
| content.data[].alertOpt.alertTarget[].customStartTime | string | 저장된 구성: 사용자 정의 날짜 당일 시작 시각, customDateUUIDs/customDuration과 함께 사용합니다. |
| content.data[].alertOpt.alertTarget[].customDuration | integer | 저장된 구성: 사용자 정의 날짜 윈도 지속 시간(초), 날짜 집합 및 시작 시각과 반드시 함께 제공해야 합니다. |
| content.data[].alertOpt.alertTarget[].targets | array<object> |
저장된 구성: 등급 모드 작업 배열. |
| content.data[].alertOpt.alertTarget[].targets[] | object | 저장된 구성: 단일 등급 작업. |
| content.data[].alertOpt.alertTarget[].targets[].status | string | 저장된 구성: 필수 등급 선택: fatal, critical, error, warning, nodata, info, 전체는 대문자 ALL; 여러 개는 영문 쉼표로 연결하고 공백을 넣지 않습니다. security 소스는 critical, high, medium, low, info 또는 ALL을 사용합니다. |
| content.data[].alertOpt.alertTarget[].targets[].df_source | string | 저장된 구성: 선택 사항, 공개 대상 구조는 security만 지원합니다. 생략 시 실행 계층에서 보안 소스를 제외합니다. |
| content.data[].alertOpt.alertTarget[].targets[].to | array<string> |
저장된 구성: 필수 수신 대상 배열, 구성원, 팀, 알림 대상 또는 이메일을 사용할 수 있습니다. 에이전트 계정은 유효한 기본 Webhook을 사용할 수 있습니다. |
| content.data[].alertOpt.alertTarget[].targets[].to[] | string | 저장된 구성: member 모드에서는 email/sms/notify_를 주로 사용하고, status 모드에서는 acnt_/agent_/group_/notify_ 또는 이메일을 사용합니다. SMS 등 채널의 사용 가능 여부는 사이트 및 대상 구성에 따릅니다. |
| content.data[].alertOpt.alertTarget[].targets[].tags | object | 저장된 구성: status 모드에서는 필드 값을 기준으로 이벤트를 필터링하고, member 모드에서는 상위 alertInfo.filterString을 사용해야 하며 여기의 tags는 구성원 선택 조건으로 사용되지 않습니다. |
| content.data[].alertOpt.alertTarget[].targets[].tags.字段 | array<object> |
저장된 구성: 단일 필드의 매칭 값 배열. |
| content.data[].alertOpt.alertTarget[].targets[].tags.字段[] | string | 저장된 구성: 단일 매칭 값. |
| content.data[].alertOpt.alertTarget[].targets[].filterString | string | 저장된 구성: status 모드에서 비어 있지 않으면 tags보다 우선하며 에스컬레이션 작업에 사용됩니다. member 모드에서는 상위 alertInfo.filterString을 사용하며, 해당 대상 내 필드는 유효한 필터 진입점으로 사용되지 않습니다. |
| content.data[].alertOpt.alertTarget[].targets[].upgradeTargets | array<object> |
저장된 구성: 선택적 에스컬레이션 작업; 이벤트가 해당 등급에 duration 동안 지속되면 실행되며, []이면 에스컬레이션을 구성하지 않습니다. |
| content.data[].alertOpt.alertTarget[].targets[].upgradeTargets[] | object | 저장된 구성: 단일 에스컬레이션 작업. |
| content.data[].alertOpt.alertTarget[].targets[].upgradeTargets[].to | array<string> |
저장된 구성: member 모드에서는 에스컬레이션 수신 구성원/팀, status 모드에서는 에스컬레이션 알림 대상이며 구성원/팀/알림 대상/이메일을 사용할 수 있습니다. |
| content.data[].alertOpt.alertTarget[].targets[].upgradeTargets[].to[] | string | 저장된 구성: 단일 에스컬레이션 수신 식별자. |
| content.data[].alertOpt.alertTarget[].targets[].upgradeTargets[].duration | integer | 저장된 구성: 필수 지속 시간, 단위 초; 각 에스컬레이션은 이벤트가 상태를 지속한 시간을 기준으로 구성되며 여러 duration을 자동으로 누적하지 않습니다. |
| content.data[].alertOpt.alertTarget[].targets[].upgradeTargets[].toWay | array<string> |
저장된 구성: member 에스컬레이션 알림 방식 배열; status 모드에서는 이 필드를 사용하지 않습니다. |
| content.data[].alertOpt.alertTarget[].targets[].upgradeTargets[].toWay[] | string | 저장된 구성: 단일 에스컬레이션 알림 방식. |
| content.data[].alertOpt.alertTarget[].alertInfo | array<object> |
저장된 구성: member 모드에서만 사용하는 구성원 그룹 배열, status 모드에서는 사용하지 않습니다. |
| content.data[].alertOpt.alertTarget[].alertInfo[] | object | 저장된 구성: 구성원 그룹 객체. |
| content.data[].alertOpt.alertTarget[].alertInfo[].name | string | 저장된 구성: 선택적 구성원 그룹 이름, 최대 256자. |
| content.data[].alertOpt.alertTarget[].alertInfo[].memberInfo | array<string> |
저장된 구성: member 모드 일반 알림의 수신 구성원/팀 배열, 에이전트 계정을 포함할 수 있습니다. targets.to 알림 방식과 조합합니다. |
| content.data[].alertOpt.alertTarget[].alertInfo[].memberInfo[] | string | 저장된 구성: 단일 구성원 또는 팀 식별자. |
| content.data[].alertOpt.alertTarget[].alertInfo[].filterString | string | 저장된 구성: 구성원 그룹 수준 이벤트 필터, 일반 및 에스컬레이션 작업 모두 이 조건을 사용합니다. |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets | array<object> |
저장된 구성: member 모드의 알림 방식/등급 작업 배열. |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets[] | object | 저장된 구성: 단일 등급 작업. |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets[].status | string | 저장된 구성: 필수 등급 선택: fatal, critical, error, warning, nodata, info, 전체는 대문자 ALL; 여러 개는 영문 쉼표로 연결하고 공백을 넣지 않습니다. security 소스는 critical, high, medium, low, info 또는 ALL을 사용합니다. |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets[].df_source | string | 저장된 구성: 선택 사항, 공개 대상 구조는 security만 지원합니다. 생략 시 실행 계층에서 보안 소스를 제외합니다. |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets[].to | array<string> |
저장된 구성: member 모드에서는 email, sms 또는 notify_ 알림 대상을 주로 사용하며 알림 방식을 나타냅니다. 실행 계층은 직접 계정/팀 등의 대상도 호환하지만, memberInfo와 알림 방식 조합을 우선 사용하는 것이 좋습니다. |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets[].to[] | string | 저장된 구성: member 모드에서는 email/sms/notify_를 주로 사용하고, status 모드에서는 acnt_/agent_/group_/notify_ 또는 이메일을 사용합니다. SMS 등 채널의 사용 가능 여부는 사이트 및 대상 구성에 따릅니다. |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets[].tags | object | 저장된 구성: status 모드에서는 필드 값을 기준으로 이벤트를 필터링하고, member 모드에서는 상위 alertInfo.filterString을 사용해야 하며 여기의 tags는 구성원 선택 조건으로 사용되지 않습니다. |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets[].tags.字段 | array<object> |
저장된 구성: 단일 필드의 매칭 값 배열. |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets[].tags.字段[] | string | 저장된 구성: 단일 매칭 값. |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets[].filterString | string | 저장된 구성: status 모드에서 비어 있지 않으면 tags보다 우선하며 에스컬레이션 작업에 사용됩니다. member 모드에서는 상위 alertInfo.filterString을 사용하며, 해당 대상 내 필드는 유효한 필터 진입점으로 사용되지 않습니다. |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets[].upgradeTargets | array<object> |
저장된 구성: 선택적 에스컬레이션 작업; 이벤트가 해당 등급에 duration 동안 지속되면 실행되며, []이면 에스컬레이션을 구성하지 않습니다. |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets[].upgradeTargets[] | object | 저장된 구성: 단일 에스컬레이션 작업. |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets[].upgradeTargets[].to | array<string> |
저장된 구성: member 모드에서는 에스컬레이션 수신 구성원/팀, status 모드에서는 에스컬레이션 알림 대상이며 구성원/팀/알림 대상/이메일을 사용할 수 있습니다. |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets[].upgradeTargets[].to[] | string | 저장된 구성: 단일 에스컬레이션 수신 식별자. |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets[].upgradeTargets[].duration | integer | 저장된 구성: 필수 지속 시간, 단위 초; 각 에스컬레이션은 이벤트가 상태를 지속한 시간을 기준으로 구성되며 여러 duration을 자동으로 누적하지 않습니다. |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets[].upgradeTargets[].toWay | array<string> |
저장된 구성: member 에스컬레이션 알림 방식 배열; status 모드에서는 이 필드를 사용하지 않습니다. |
| content.data[].alertOpt.alertTarget[].alertInfo[].targets[].upgradeTargets[].toWay[] | string | 저장된 구성: 단일 에스컬레이션 알림 방식. |
| content.data[].alertOpt.aggType | string | 저장된 구성: v2 선택 모드: byFields 규칙 집계, byCluster 지능형 집계, byAI는 AI 집계, byCustom 사용자 정의 필드 규칙 집계. 생략하거나 null이면 기존 aggFields 로직을 따르며, 집계는 여전히 aggInterval>0이어야 합니다. |
| content.data[].alertOpt.ignoreOK | boolean | 저장된 구성: v2 선택 사항, 정상 등급 알림 무시, 기본값 false. |
| content.data[].alertOpt.aggSendFirst | boolean | 저장된 구성: v2 선택 사항, 집계 시 첫 번째 항목을 즉시 전송할지 여부, 기본값 false; aggInterval=0이면 유효한 집계가 구성되지 않습니다. |
| content.data[].creatorInfo | object | ID 표시 정보, 일치 항목이 없으면 {}, 다음 필드는 ID에 따라 선택 사항입니다. |
| content.data[].creatorInfo.uuid | string | 계정 UUID, 생략 가능. |
| content.data[].creatorInfo.status | integer | 계정 레코드 상태. |
| content.data[].creatorInfo.wsAccountStatus | integer | 워크스페이스 계정 상태. |
| content.data[].creatorInfo.username | string | 로그인 이름. |
| content.data[].creatorInfo.name | string | 표시 이름. |
| content.data[].creatorInfo.iconUrl | string | 아바타 URL, 생략 가능. |
| content.data[].creatorInfo.email | string | 이메일 또는 시스템 ID 표시 값. |
| content.data[].creatorInfo.mobile | string | 휴대전화 번호, 비어 있을 수 있습니다. |
| content.data[].creatorInfo.countryCode | string | 국가/지역 코드, 생략 가능. |
| content.data[].creatorInfo.acntWsNickname | string | 워크스페이스 닉네임, 생략 가능. |
| content.data[].updatorInfo | object | ID 표시 정보, 일치 항목이 없으면 {}, 다음 필드는 ID에 따라 선택 사항입니다. |
| content.data[].updatorInfo.uuid | string | 계정 UUID, 생략 가능. |
| content.data[].updatorInfo.status | integer | 계정 레코드 상태. |
| content.data[].updatorInfo.wsAccountStatus | integer | 워크스페이스 계정 상태. |
| content.data[].updatorInfo.username | string | 로그인 이름. |
| content.data[].updatorInfo.name | string | 표시 이름. |
| content.data[].updatorInfo.iconUrl | string | 아바타 URL, 생략 가능. |
| content.data[].updatorInfo.email | string | 이메일 또는 시스템 ID 표시 값. |
| content.data[].updatorInfo.mobile | string | 휴대전화 번호, 비어 있을 수 있습니다. |
| content.data[].updatorInfo.countryCode | string | 국가/지역 코드, 생략 가능. |
| content.data[].updatorInfo.acntWsNickname | string | 워크스페이스 닉네임, 생략 가능. |
| content.data[].permissionSetInfo | object | permissionSet이 존재할 때 제공되며, 주체 식별자를 키로 하는 표시 정보 매핑입니다. 일치하는 주체가 없으면 {}일 수 있습니다. |
| content.data[].permissionSetInfo.标识 | object | 계정은 계정 프로필, 역할/팀은 주로 name과 status입니다. |
| content.data[].permissionSetInfo.标识.uuid | string | 계정 UUID, 생략 가능. |
| content.data[].permissionSetInfo.标识.status | integer | 계정 레코드 상태. |
| content.data[].permissionSetInfo.标识.wsAccountStatus | integer | 워크스페이스 계정 상태. |
| content.data[].permissionSetInfo.标识.username | string | 로그인 이름. |
| content.data[].permissionSetInfo.标识.name | string | 표시 이름. |
| content.data[].permissionSetInfo.标识.iconUrl | string | 아바타 URL, 생략 가능. |
| content.data[].permissionSetInfo.标识.email | string | 이메일 또는 시스템 ID 표시 값. |
| content.data[].permissionSetInfo.标识.mobile | string | 휴대전화 번호, 비어 있을 수 있습니다. |
| content.data[].permissionSetInfo.标识.countryCode | string | 국가/지역 코드, 생략 가능. |
| content.data[].permissionSetInfo.标识.acntWsNickname | string | 워크스페이스 닉네임, 생략 가능. |
| content.data[].allow_operation | boolean 또는 null | 사용자 정의 작업 권한 판단; null은 미활성화를 의미하며 여전히 API 권한으로 판정해야 합니다. true/false는 현재 ID의 사용자 정의 판단입니다. |
| content.data[].ruleCount | integer | 현재 집계된 바인딩 모니터/SLO/보안 규칙 총수. |
| content.data[].refCountInfo | object | 연관 유형별로 그룹화한 수량, 유형이 없으면 생략될 수 있습니다. |
| content.data[].refCountInfo.trigger | integer | 해당 유형의 연관 수량. |
| content.data[].refCountInfo.self_built_trigger | integer | 해당 유형의 연관 수량. |
| content.data[].refCountInfo.smartMonitor | integer | 해당 유형의 연관 수량. |
| content.data[].refCountInfo.aiMonitor | integer | 해당 유형의 연관 수량. |
| content.data[].refCountInfo.slo | integer | 해당 유형의 연관 수량. |
| content.data[].refCountInfo.cspm | integer | 해당 유형의 연관 수량. |
| content.data[].refCountInfo.siem | integer | 해당 유형의 연관 수량. |
| content.data[].refCountInfo.aba | integer | 해당 유형의 연관 수량. |
| content.data[].refCheckerInfo | object | 유형별로 그룹화한 연관 모니터/SLO, 필드는 상세의 플랫 배열과 다릅니다. |
| content.data[].refCheckerInfo.类型 | array<object> |
trigger/self_built_trigger/smartMonitor/aiMonitor/slo 등 유형 아래의 배열. |
| content.data[].refCheckerInfo.类型[].uuid | string | 모니터/SLO UUID. |
| content.data[].refCheckerInfo.类型[].name | string | 모니터/SLO 이름. |
| content.data[].refCheckerInfo.类型[].type | string | trigger/self_built_trigger/smartMonitor/aiMonitor/slo 등 유형. |
| content.data[].refCheckerInfo.类型[].status | integer | 레코드 활성화/비활성화 상태. |
| content.data[].refCheckerInfo.类型[].jsonScript | object | 모니터가 존재할 때의 유형 요약, SLO는 생략될 수 있습니다. |
| content.data[].refCheckerInfo.类型[].jsonScript.type | string 또는 null | 모니터 감지 유형 요약. |
| content.data[].refSecurityRuleInfo | object | 보안 규칙 유형별로 그룹화한 연관 정보. |
| content.data[].refSecurityRuleInfo.类型 | array<object> |
cspm/siem/aba 등 유형 배열. |
| content.data[].refSecurityRuleInfo.类型[].uuid | string | 보안 규칙 UUID. |
| content.data[].refSecurityRuleInfo.类型[].name | string | 보안 규칙 이름. |
| content.data[].refSecurityRuleInfo.类型[].type | string | 보안 규칙 유형, 예: cspm/siem/aba. |
| content.data[].refSecurityRuleInfo.类型[].status | integer | 규칙 상태, 원본 관계에 삭제된 규칙이 포함될 수 있습니다. |
| content.declaration | object 또는 null | 워크스페이스 공용 선언. |
| pageInfo | object | 최상위 페이지네이션. |
| pageInfo.pageIndex | integer | 페이지 번호. |
| pageInfo.pageSize | integer | 페이지 크기. |
| pageInfo.count | integer | 현재 페이지의 실제 수량. |
| pageInfo.totalCount | integer | 일치 총수. |
{
"code": 200,
"content": {
"data": [
{
"id": 42,
"uuid": "altpl_example",
"workspaceUUID": "wksp_example",
"name": "生产服务告警",
"desc": "生产服务异常通知与升级。",
"alertOpt": {
"alertType": "status",
"aggInterval": 0,
"silentTimeout": 900,
"alertTarget": [
{
"name": "默认通知",
"targets": [
{
"status": "critical",
"to": [
"notify_example"
]
}
]
}
]
},
"ruleTimezone": "Asia/Shanghai",
"score": 0,
"openPermissionSet": false,
"permissionSet": [],
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785430800,
"updateAt": -1,
"deleteAt": -1,
"ruleCount": 0,
"refCountInfo": {},
"refCheckerInfo": {},
"refSecurityRuleInfo": {},
"creatorInfo": {},
"updatorInfo": {},
"allow_operation": null
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE",
"pageInfo": {
"pageIndex": 1,
"pageSize": 20,
"count": 1,
"totalCount": 1
}
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방식 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 요청 필드 누락 또는 필드 값이 선언된 검증 조건 위반 | 파라미터 파싱 실패 | 파라미터 위치, 필드 이름, 유형 및 값을 확인하십시오. |
| 500 | ft.InternalServerError | 정책, 바인딩 통계, 권한 또는 계정 프로필 조회 실패 | 내부 오류 | 잠시 후 다시 시도하십시오. 계속 실패하면 traceId를 제공하십시오. |