템플릿 - 사용자 정의 시스템 템플릿 가져오기¶
POST /api/v1/sys_template/custom/import
개요¶
사이트 수준 사용자 정의 시스템 템플릿을 가져오거나 전체 덮어쓴 뒤 입력별 진단을 반환합니다.
호출 전 및 사용 단계¶
これは 사이트 수준 템플릿 라이브러리이며, 특정 워크스페이스에 이미 생성된 대시보드/모니터/Pipeline 인스턴스가 아닙니다. 라이브러리 템플릿을 삭제하거나 덮어쓰는 것은 이미 인스턴스화된 리소스를 삭제/업그레이드하는 것과 같지 않습니다. 이 모듈은 데이터 쿼리를 실행하거나 실행 중인 수집 설정을 게시하지 않습니다. w 권한 서명이 필요합니다. 먼저 템플릿 목록에서 type/language/isCustomSysTemp=true 기준으로 동일한 이름의 템플릿을 확인하고 템플릿 상세 콘텐츠를 백업합니다. 아래 유형 규칙에 따라 jsonContents를 구성합니다. isCover=false는 최초 가져오기에 사용하며, true는 일치하는 사용자 정의 대상을 덮어쓸 수 있습니다. Pipeline이 아닌 이름은 일반적으로 유형+정확한 언어 기준으로 중복 제거하며, 고정 탐색기는 fileName 기준, Pipeline은 category+name 기준이고 공통 언어를 포함합니다. dashboard는 identifier도 검사합니다. HTTP200의 content 각 항목의 err_fields 및 모든 충돌 불리언 필드를 반드시 확인해야 하며, 차단 항목이 하나라도 있으면 이 가져오기 분기의 전체 배치가 커밋되지 않습니다. success=true를 적용됨으로 간주해서는 안 됩니다. []라고 해서 반드시 데이터가 가져와진 것은 아니며(예: pipeline 래퍼에 pipelines가 없음), 목록/상세에서 실제 레코드를 확인한 후에만 완료로 간주합니다. 반환에는 UUID가 없으므로 이후 목록을 다시 조회해 위치를 찾아야 합니다. 덮어쓰기는 전체 meta/Pipeline에서 지원하는 콘텐츠와 source 등의 컬럼을 업데이트하며, 누락된 설정을 병합해 유지하지 않습니다. Pipeline 덮어쓰기 시 testData가 현재 여전히 이전 값일 수 있으므로 GET으로 디코딩해 검증해야 합니다. 일부 GET 필드는 Pipeline 가져오기에서 명시적으로 무시되며, RUM 애플리케이션 바인딩은 비워집니다. 이 호출은 템플릿 라이브러리만 변경하며, 기존 공간 리소스에 자동으로 적용하지 않습니다. 일반 예외 500 또는 호출 시간 초과 후에는 먼저 현재 상태를 읽어야 하며, 덮어쓰기를 재실행하면 업데이트 시간을 다시 변경할 수 있습니다.
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| X-Df-SVersion | string | 원본 경로와 요청 본문 서명 버전입니다. 생략한 뒤 이 페이지의 알고리즘을 계속 사용할 수 없습니다. 예시: v20240417가져오기 또는 입력 방법: 이 페이지 예시는 이 고정 버전을 사용하며 예시 서명 알고리즘과 함께 제공됩니다. |
|
| X-Df-Access-Key | string | Y | 읽기 API는 r 또는 w 자격 증명을 사용할 수 있고, 쓰기 API는 w 자격 증명이 필요합니다. 예시: <external-access-key>가져오기 또는 입력 방법: 사이트 관리자가 External API AK를 할당하며, 워크스페이스 OpenAPI Key를 사용할 수 없습니다. |
| X-Df-Nonce | string | Y | 임시 일련번호입니다. 실패 후 재전송 시에도 새 값을 생성하고 서명을 다시 계산합니다. 예시: 97d275ee9f774315a7885ba7347acbd9가져오기 또는 입력 방법: 각 요청마다 uuid.uuid4().hex를 다시 생성합니다. |
| X-Df-Signature | string | Y | 대문자 메서드, nonce, 원본 전체 경로, timestamp 및 원본 UTF-8 요청 본문을 공백으로 연결한 후 HMAC-SHA256을 수행하고 hex 다이제스트를 사용합니다. 예시: <hmac-sha256-hex>가져오기 또는 입력 방법: External API 서명 인증에 따라 함께 제공된 SK로 계산하며, 전체 실행 가능한 템플릿은 아래를 참조하십시오. |
| X-Df-Timestamp | string | Y | 사이트에 구성된 서명 유효 시간 범위 내에 있어야 하며, 예시 시간을 재사용할 수 없습니다. 예시: 1785427200가져오기 또는 입력 방법: 전송 시 str(int(time.time()))를 사용해 현재 Unix 초 문자열을 생성합니다. |
Body 요청 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| jsonContents[*] | json | 단일 내보내기 템플릿 콘텐츠입니다. 동적 필드는 항목별 전체 schema 검증을 받지 않으며, null/비객체는 500이 발생할 수 있습니다. 예시: {"title": "业务指标", "identifier": "business-dashboard", "main": {"groups": [], "charts": [], "vars": []}}가져오기 또는 입력 방법: 동일 카테고리의 유효한 템플릿 상세 객체를 복사합니다. |
|
| jsonContents[*].title | string | dashboard/security/customer-explorer 등 공통 분기는 이 필드에서 템플릿 이름을 가져오며, trim 후 비어 있지 않아야 합니다. monitor는 이 필드로 검사 라이브러리 이름을 결정하지 않습니다. 예시: 业务指标가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].summary | string | 공통 meta 내 요약은 그대로 저장됩니다. monitor는 최상위 summary로 재구성합니다. 예시: 业务指标说明가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].identifier | string | dashboard 전용 식별자입니다. 기존 시스템 템플릿 및 이번 배치의 다른 템플릿과 충돌하지 않아야 합니다. 동일한 이름과 동일한 식별자가 같은 사용자 정의 레코드를 가리키는 경우 덮어쓰기가 허용되지만, 다른 이름이 점유한 식별자는 덮어쓸 수 없습니다. 예시: business-dashboard가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].isHidden | boolean | 공통/탐색기 분기는 true 또는 숫자 1만 숨김으로 인식하고 나머지는 표시합니다. monitor는 false로 고정됩니다. 예시: false가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].iconSet | json | 템플릿 아이콘 JSON은 유효한 상세 정보에 따라 완전히 보존됩니다. monitor는 url을 빈 문자열로 재구성합니다. 예시: {"url": ""}가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].main | json 또는 array | type에 따라 달라집니다: dashboard 객체, monitor {checkers} 객체, 탐색기 패널 배열이며, 공통 security 등은 원본 구조를 유지합니다. 여기서 템플릿을 저장하는 것은 모든 비즈니스 구조가 실행 가능한 검증을 통과했음을 의미하지 않습니다. 예시: {"groups": [], "charts": [], "vars": []}가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].main.groups | array | dashboard 그룹 구성은 완전히 저장되며, 실제 적용 시에는 식별자 가져오기 파라미터를 참조하십시오. 예시: []가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].main.charts | array | dashboard 차트 배열은 완전히 저장됩니다. 이 템플릿 라이브러리 가져오기는 공간 대시보드 차트 구조/쿼리 사전 검사를 호출하지 않으며, 이후 인스턴스화가 실패할 수 있습니다. 예시: []가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].main.vars | array | dashboard 변수 배열은 유효한 내보내기 기준으로 완전히 저장됩니다. 실제 적용 시 변수 레코드를 다시 생성합니다. 예시: []가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].checkers | array | monitor 호환 최상위 검사기 배열로, main.checkers와 둘 중 하나를 선택합니다. 이 키가 존재하면 우선하며, 콘텐츠가 유효하지 않더라도 대체하지 않습니다. 예시: [{"jsonScript": {"title": "CPU异常", "type": "simpleCheck"}}]가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].checkers[*] | json | 전체 모니터 정의입니다. 가져오기 시 jsonScript.title/type 핵심 필드를 검사하며, 기타 구성은 여전히 유효하게 내보내져야 합니다. 예시: {"jsonScript": {"title": "CPU异常", "type": "simpleCheck"}}가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].checkers[*].jsonScript | json | 검사기의 실제 구성 객체입니다. 예시: {"title": "CPU异常", "type": "simpleCheck"}가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].checkers[*].jsonScript.title | string | monitor 실제 하위 검사기 제목이며 비어 있으면 안 됩니다. 예시: CPU异常가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].checkers[*].jsonScript.type | string | 현재 RULE_CHECK_CFG 집합에 있어야 합니다. 적용되었거나 내보내기 가능한 모니터에서 가져오며, 입력하지 않으면 중국어로 표시됩니다. 예시: simpleCheck가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].main.checkers | array | monitor 표준 내보내기 위치입니다. 최상위 checkers가 없을 때만 읽습니다. 여러 jsonContents 검사기는 최상위 title로 정의된 하나의 템플릿으로 병합되며, 각 monitorName은 해당 title로 덮어씌워집니다. 예시: [{"jsonScript": {"title": "CPU异常", "type": "simpleCheck"}}]가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].main.checkers[*] | json | 전체 검사기 객체이며 의미는 최상위 checkers 항목과 같습니다. 예시: {"jsonScript": {"title": "CPU异常", "type": "simpleCheck"}}가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].main.checkers[*].jsonScript | json | 검사기 구성입니다. 예시: {"title": "CPU异常", "type": "simpleCheck"}가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].main.checkers[*].jsonScript.title | string | 비어 있지 않은 검사기 표시 제목입니다. 예시: CPU异常가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].main.checkers[*].jsonScript.type | string | 지원되는 모니터 내부 유형 문자열입니다. 예시: simpleCheck가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].main[] | json | 탐색기 패널 항목입니다. object-explorer는 첫 번째 항목의 class/source를 보고, resource-catalog도 첫 번째 항목을 봅니다. 고정 전용 탐색기는 첫 번째 템플릿의 각 패널을 순회합니다. 예시: {"class": "object", "source": {"key": "kubernetes_nodes", "name": "Nodes"}}가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].main[].class | string | object-explorer는 반드시 object여야 하고, resource-catalog-explorer는 반드시 custom_object여야 합니다. 기타 고정 유형은 원래의 유효한 패널 카테고리를 유지합니다. 예시: object가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].main[].source | string 또는 object 또는 array | 소스 키 문자열, {key,name} 객체 또는 첫 항목이 해당 객체인 배열일 수 있습니다. 실제 비즈니스 소스 키를 사용합니다. 고정 유형 가져오기는 {key,name}으로 정규화되며, object의 첫 항목은 시스템 사전 정의 구성으로 대체됩니다. 예시: {"key": "kubernetes_nodes", "name": "Nodes"}가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].main[].source.key | string | 소스 키입니다. object-explorer는 아래 표의 사전 정의 키만 사용할 수 있고, resource-catalog는 실제 사용자 정의 객체 소스 키를 사용합니다. 예시: kubernetes_nodes가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].main[].source.name | string | 표시 별칭입니다. object-explorer의 첫 항목은 고정 구성으로 재설정되고, 기타 유형은 내보낸 별칭을 유지합니다. 예시: Nodes가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].main[].table | JSON 값 | 탐색기 테이블 구성입니다. 콘솔의 유효한 상세 정보대로 완전히 복사합니다. 현재 저장만 하며 열 정의를 자동으로 보완하지 않습니다. 예시: {}가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].main[].filters | JSON 값 | 탐색기 필터 편집 구성입니다. 원본 내보내기 구조를 유지합니다. 예시: {}가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].main[].searchFilterKeys | array | 탐색기 검색 필드 목록입니다. 원본 내보내기 구조를 유지합니다. 이 API는 각 편집기 설정을 완전히 검증하지 않습니다. 예시: []가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].pipelines | array | pipeline 전용 래퍼입니다. 각 외부 객체는 여러 Pipeline을 포함할 수 있습니다. 누락/[]는 가져오기 없이 빈 진단을 생성할 수 있으므로 최소 한 개를 직접 확인해야 합니다. 예시: [{"category": "logging", "name": "example_pipeline", "source": [], "content": "YWRkX2tleSgiZXhhbXBsZSIsICJ2YWx1ZSIp", "testData": "eyJzYW1wbGUiOnsibWVzc2FnZSI6ImV4YW1wbGUifX0=", "extend": {}}]가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].pipelines[*] | json | 단일 Pipeline 템플릿 정의이며 content/testData를 함께 보완해야 합니다. 예시: {"category": "logging", "name": "example_pipeline"}가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].pipelines[*].category | string | 실제 필수 비어 있지 않은 카테고리입니다(예: logging/rum). 유효한 템플릿 카테고리를 따릅니다. 이 계층에는 전체 열거형 검증이 없습니다. 예시: logging가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].pipelines[*].name | string | 실제 템플릿 이름이며 비어 있지 않을 것을 권장합니다. 영문자/숫자/중국어/밑줄/하이픈만 허용되며, 다른 문자는 필드 진단을 생성합니다. 현재 name 누락 검사가 완전하지 않아 데이터베이스에서 500이 발생할 수 있습니다. 예시: example_pipeline가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].pipelines[*].content | string | 실제 필수 비어 있지 않은 Base64 UTF-8 스크립트입니다. 먼저 실제 Pipeline 문법으로 검증한 후 인코딩합니다. 디코딩만 검증하며 이 API에서 실행/컴파일하지 않습니다. 예시: YWRkX2tleSgiZXhhbXBsZSIsICJ2YWx1ZSIp가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].pipelines[*].testData | string | 실제 필수 비어 있지 않은 Base64 UTF-8 텍스트입니다. 디코딩 후 반드시 JSON 객체 또는 배열이어야 합니다. 배열은 test data 1 등의 이름 지정 매핑으로 변환됩니다. 빈 문자열/비JSON 또는 스칼라는 필드 진단을 트리거합니다. 신규 추가 시 저장됩니다. 덮어쓰기 분기는 현재 새 값을 비영속 test_data 속성에 기록하고 testData 컬럼에는 기록하지 않으므로 이전 테스트 데이터가 남을 수 있습니다. 가져오기 진단 성공만으로 테스트 데이터가 교체되었다고 단정할 수 없습니다. 예시: eyJzYW1wbGUiOnsibWVzc2FnZSI6ImV4YW1wbGUifX0=가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].pipelines[*].source | array | 선택적 source 연결 전체 배열이며 중복을 제거합니다. 덮어쓰기 시 대상 목록 기준으로 재설정하고 불필요한 기존 source 관계는 삭제합니다. 생략/null/[]는 source를 비우며 기존 연결을 유지하지 않습니다. 예시: ["example-source"]가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].pipelines[*].source[*] | string | 단일 실제 Pipeline source 값입니다. 수집 설정/기존 템플릿에서 가져오며 템플릿 UUID를 입력하지 않습니다. 예시: example-source가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].pipelines[*].extend | json | 선택적 추가 객체이며 기본값은 {}입니다. category=rum이면 extend.appID를 강제로 []로 설정하며 기존 애플리케이션 바인딩을 유지하지 않습니다. 예시: {}가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].pipelines[*].extend.appID | array | RUM 전용 애플리케이션 바인딩은 이 가져오기에서 강제로 비워지며, 이를 사용해 공간 애플리케이션 바인딩을 복사하지 않습니다. 예시: []가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].pipelines[*].type | string | GET에서 이 필드를 반환할 수 있지만 현재 가져오기에서는 무시합니다. 신규 템플릿의 실행 유형은 기본적으로 비어 있으며, 덮어쓰기 시 원래 type을 유지하고 이를 근거로 local/central을 변경하지 않습니다. 예시: local가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].pipelines[*].asDefault | boolean | GET에서 반환할 수 있지만 가져오기에서는 무시합니다. 신규 추가 시 기본값은 0이며, 덮어쓰기 시 이전 값을 유지합니다. 예시: false가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].pipelines[*].enableByLogBackup | boolean | GET에서 반환할 수 있지만 가져오기에서는 무시합니다. 신규 추가 시 기본값은 0이며, 덮어쓰기 시 이전 값을 유지합니다. 예시: false가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].pipelines[*].isDisable | boolean | GET에서 반환할 수 있지만 가져오기에서는 무시하며, 이 가져오기로 상태를 전환할 수 없습니다. 예시: false가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].pipelines[*].dataType | string | GET에서 반환할 수 있지만 가져오기에서는 무시합니다. 신규 추가 시 기본값은 line_protocol이며, 덮어쓰기 시 이전 값을 유지합니다. 예시: line_protocol가져오기 또는 입력 방법: 템플릿 상세에서 동일한 유형의 원본 객체를 복사하고 해당 분기 설명에 따라 입력합니다. |
|
| jsonContents[*].dashboardType | string | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 공간 가져오기에서 누락 시 CUSTOM으로 재설정하며 기존 type을 유지하지 않습니다. CUSTOM을 유지할 것을 권장합니다. main.type은 이 필드가 아닙니다. 예시: CUSTOM가져오기 또는 입력 방법: 유효한 내보내기 템플릿 유형을 유지합니다. |
|
| jsonContents[*].dashboardExtend | json | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 공간 가져오기는 extend를 전체 덮어쓰며, 생략 시 기본값은 {}입니다. 증분 병합으로 오해해서는 안 됩니다. 동적 키는 내보내기 형식대로 유지합니다. 예시: {}가져오기 또는 입력 방법: 내보낸 템플릿의 전체 대시보드 확장 설정을 복사합니다. |
|
| jsonContents[*].dashboardMapping | array | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 공간 가져오기는 mapping을 전체 덮어쓰며, 생략 시 기본값은 []입니다. 각 동적 JSON은 유효한 내보내기 형식대로 유지합니다. 이 경로는 비즈니스 구조를 보완하지 않습니다. 예시: []가져오기 또는 입력 방법: 내보낸 뷰 변수 필드 매핑 배열을 복사합니다. |
|
| jsonContents[*].dashboardMapping[*] | json | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 단일 전체 매핑 객체입니다. 이전의 빈 테이블 헤더를 보고 매핑 키를 추측해서 만들지 마십시오. 예시: {}가져오기 또는 입력 방법: 대상 템플릿의 단일 실제 매핑 구성을 복사합니다. |
|
| jsonContents[*].iconSet.url | string | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 선택적 아이콘 URL이며 표시 여부는 클라이언트 구성에 따릅니다. 다른 브랜드의 고정 리소스 도메인을 사용하지 마십시오. 예시: https://example.com/icon.png가져오기 또는 입력 방법: 자신의 접근 가능한 아이콘 리소스에서 주소를 가져오거나 원래 값을 유지합니다. |
|
| jsonContents[*].iconSet.icon | string | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 선택적 작은 아이콘 구성 값이며 실제 구조는 원본 내보내기를 기준으로 합니다. 예시: chart가져오기 또는 입력 방법: 콘솔에서 내보낸 아이콘 식별자/구성을 유지합니다. |
|
| jsonContents[*].dashboardBindSet | array | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 비어 있지 않은 참 값일 때만 교체합니다. 생략/[]는 기존 바인딩을 유지하며 비우는 것이 아닙니다. 예시: []가져오기 또는 입력 방법: 대상의 유효한 내보내기 템플릿에서 전체 바인딩 설정을 유지합니다. |
|
| jsonContents[*].dashboardBindSet[*] | json | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 원본 바인딩 구성의 동적 구조대로 저장하며, 이 진입점은 리소스 소유권을 완전히 검증하지 않습니다. 예시: {}가져오기 또는 입력 방법: 유효한 내보내기의 바인딩 객체 하나를 복사합니다. |
|
| jsonContents[*].tags | array | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. node 공간 대시보드는 이름 기준으로 태그 연결을 재설정하며, 비어 있지 않은 tags를 우선 사용합니다. 생략/[]는 tagInfo를 시도하고 둘 다 없으면 비웁니다. 동일한 이름의 비scene/all 태그는 가져오기 컨텍스트에서 건너뛰지만 기존 연결을 지울 수 있으며, 배열 응답은 skippedTags 요약을 제공하지 않습니다. userViewer의 실제 inner 분기는 이러한 시나리오 태그 업데이트를 거치지 않습니다. 예시: ["production"]가져오기 또는 입력 방법: 대상 공간에 이미 있는 scene/all 태그 이름 또는 필요한 비즈니스 태그에서 선택합니다. 먼저 범위를 확인하십시오. |
|
| jsonContents[*].tags[*] | string | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 단일 태그 이름이며 최대 128자입니다. 새 이름으로 대상 공간에 scene 태그를 생성할 수 있습니다. 예시: production가져오기 또는 입력 방법: 해당 태그 name을 복사하며 tag_UUID를 사용하지 않습니다. |
|
| jsonContents[*].tagInfo | array | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. tags에 비어 있지 않은 값이 없을 때만 각 항목의 name으로 태그를 선택하며 의미는 tags와 같습니다. 추가가 아니며 tagInfo.uuid로 공간 간 태그를 지정할 수 없습니다. 예시: [{"name": "production"}]가져오기 또는 입력 방법: 호환 내보내기 형식에 이미 tagInfo가 있으면 유지합니다. |
|
| jsonContents[*].tagInfo[*] | json | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. name만 읽으며 나머지 클라이언트 표시 필드는 연결을 결정하지 않습니다. 예시: {"name": "production"}가져오기 또는 입력 방법: 유효한 내보내기 태그 정보에서 복사합니다. |
|
| jsonContents[*].tagInfo[*].name | string | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 단일 태그 이름입니다. 예시: production가져오기 또는 입력 방법: 대상의 기존/신규 비즈니스 태그 이름에서 가져옵니다. |
|
| jsonContents[*].main.groups[*] | string 또는 object | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 문자열은 그룹 이름입니다. 객체는 name/extend를 읽으며 name이 비어 있는 객체는 무시합니다. 그룹 이름은 최대 256자입니다. 예시: {"name": "业务指标", "extend": {}}가져오기 또는 입력 방법: 내보낸 그룹 구조에서 복사합니다. |
|
| jsonContents[*].main.groups[*].name | string | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 객체 형식의 그룹 이름이며 비어 있으면 안 됩니다. 차트는 동일한 이름의 group으로 그룹화됩니다. 예시: 业务指标가져오기 또는 입력 방법: 그룹 이름을 직접 정의하거나 기존 내보내기 이름을 복사합니다. |
|
| jsonContents[*].main.groups[*].extend | json | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 선택적 그룹 확장 객체이며 생략 시 {}입니다. 예시: {}가져오기 또는 입력 방법: 그룹 접기 등의 내보내기 설정을 유지합니다. |
|
| jsonContents[*].main.charts[*] | json | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 차트 객체입니다. type이 문자열인지, queries가 배열인지, 각 query가 객체인지 검증합니다. 모든 클라이언트 확장 키가 서버에서 완전히 검증되는 것은 아닙니다. 예시: {"name": "CPU空闲", "type": "line", "queries": [{"qtype": "dql", "query": {"q": "M::cpu:(usage_idle)"}}], "pos": {"x": 0, "y": 0, "w": 12, "h": 6}}가져오기 또는 입력 방법: 콘솔에서 검증된 차트 내보내기 객체를 복사하고 실제 쿼리 문을 수정합니다. |
|
| jsonContents[*].main.charts[*].name | string | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 누락 또는 빈 값은 빈 제목이며 최대 256자입니다. 예시: CPU空闲가져오기 또는 입력 방법: 차트 표시 이름을 입력합니다. |
|
| jsonContents[*].main.charts[*].type | string | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 기본값은 line이고 저장 시 소문자로 변환되며, 현재 sequence만 있는 것은 아닙니다. 지원 유형은 콘솔 내보내기를 기준으로 합니다. 예시: line가져오기 또는 입력 방법: 유효한 내보내기 차트 유형을 유지합니다(예: line 또는 combine). |
|
| jsonContents[*].main.charts[*].uuid | string | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 제공하더라도 버리고 새 차트 ID를 재생성합니다. 이전 차트 연결을 유지하는 데 사용할 수 없습니다. 예시: chrt_example가져오기 또는 입력 방법: 이전 내보내기에서 포함될 수 있으며 일반 호출에서는 입력할 필요가 없습니다. |
|
| jsonContents[*].main.charts[*].group | json | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 문자열 그룹 이름, {name:그룹 이름} 또는 null일 수 있습니다. 대응하는 그룹이 없으면 default로 분류됩니다. 객체는 name으로 해석합니다. 예시: {"name": "业务指标"}가져오기 또는 입력 방법: 이번 main.groups의 이름과 정확히 일치해야 합니다. |
|
| jsonContents[*].main.charts[*].group.name | string | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 그룹 이름입니다. null이면 그룹화하지 않음을 나타냅니다. 예시: 业务指标가져오기 또는 입력 방법: 이번 main.groups의 name을 참조합니다. |
|
| jsonContents[*].main.charts[*].pos | json | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 레이아웃 객체이며 생략 시 {}입니다. 클라이언트 레이아웃 단위로 해석하고 서버는 그대로 저장하며, 이전 설명의 string을 강제 숫자 계약으로 간주하지 않습니다. 예시: {"x": 0, "y": 0, "w": 12, "h": 6}가져오기 또는 입력 방법: 내보낸 레이아웃에서 복사합니다. |
|
| jsonContents[*].main.charts[*].pos.x | number | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 가로 위치이며 클라이언트 그리드 단위입니다. 예시: 0가져오기 또는 입력 방법: 내보낸 그리드 가로 좌표를 복사합니다. |
|
| jsonContents[*].main.charts[*].pos.y | number | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 세로 위치입니다. 예시: 0가져오기 또는 입력 방법: 내보낸 그리드 세로 좌표를 복사합니다. |
|
| jsonContents[*].main.charts[*].pos.w | number | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 너비입니다. 예시: 12가져오기 또는 입력 방법: 내보낸 그리드 너비를 복사합니다. |
|
| jsonContents[*].main.charts[*].pos.h | number | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 높이입니다. 예시: 6가져오기 또는 입력 방법: 내보낸 그리드 높이를 복사합니다. |
|
| jsonContents[*].main.charts[*].pos.i | string | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 선택적 클라이언트 레이아웃 표시입니다. 새 차트의 실제 UUID로 사용되지 않습니다. 예시: chart-position가져오기 또는 입력 방법: 원본 내보내기 표시가 있으면 유지합니다. |
|
| jsonContents[*].main.charts[*].extend | json | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 전체 차트 확장 객체이며 생략 시 {}입니다. 중첩 키는 차트 유형에 따라 동적이며 현재 원본 JSON대로 저장하고 필요한 클라이언트 설정을 자동으로 보완하지 않습니다. 예시: {}가져오기 또는 입력 방법: 유효한 내보내기의 settings/style 등 차트 확장 구성을 완전히 유지합니다. |
|
| jsonContents[*].main.charts[*].queries | array | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 일반 차트는 쿼리 객체 배열입니다. combine의 외부는 하위 차트 객체이며 각 하위 차트는 자체 queries 배열을 포함합니다. 문자열/단일 객체로 배열을 대체할 수 없습니다. 예시: [{"qtype": "dql", "query": {"q": "M::cpu:(usage_idle)"}}]가져오기 또는 입력 방법: 검증된 차트 내보내기 쿼리 구조에서 복사합니다. |
|
| jsonContents[*].main.charts[*].queries[*] | json | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 일반 쿼리 객체는 qtype/query를 읽고 추가 표시 키는 유지합니다. combine 하위 차트 uuid는 첫 번째 main 및 기타 고유 내부 ID로 정규화되며, 중첩 queries는 재귀적으로 검증됩니다. 예시: {"qtype": "dql", "query": {"q": "M::cpu:(usage_idle)"}}가져오기 또는 입력 방법: 일반적으로 내보낸 쿼리 객체를 사용하고, combine은 내보낸 전체 하위 차트 객체를 사용합니다. |
|
| jsonContents[*].main.charts[*].queries[*].qtype | string | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 일반 쿼리 유형이며, 이 가져오기 호출에서 쿼리를 실행하거나 비즈니스 데이터 존재를 검증하지 않습니다. 예시: dql가져오기 또는 입력 방법: 실제 쿼리 문법 유형을 사용합니다(예: dql/promql). |
|
| jsonContents[*].main.charts[*].queries[*].query | json | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 일반 쿼리 파라미터 동적 객체입니다. query 키가 있으면 반드시 객체여야 하며, 시간/변수/데이터 소스 필드는 유효한 내보내기대로 유지합니다. 이 진입점은 저장만 하며 이를 통해 데이터 쿼리를 동기적으로 실행하지 않습니다. 예시: {"q": "M::cpu:(usage_idle)"}가져오기 또는 입력 방법: 유효한 내보내기 쿼리 객체를 복사하며, 실제 필드는 동기화 쿼리 파라미터를 참조하십시오. |
|
| jsonContents[*].main.charts[*].queries[*].query.q | string | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 일반 쿼리 문이며 템플릿 변수를 포함할 수 있습니다. 공간 간 템플릿은 실제 데이터셋/필드/변수 사용 가능 여부를 확인해야 합니다. 예시: M::cpu:(usage_idle)가져오기 또는 입력 방법: 대상 공간의 쿼리 도구에서 검증한 후 DQL/PromQL을 복사합니다. |
|
| jsonContents[*].main.charts[*].queries[*].query.outerDatasourceInfo | json | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 관리형 참조는 configMd5 기준으로 대상 공간에서 uuid를 다시 바인딩합니다. 일치하는 항목을 찾지 못하면 이전 공간 uuid를 제거하지만 요약은 유지하며 데이터 소스를 생성하지 않습니다. funcServerId 등 함수 참조는 대상 공간 구성을 확인해야 하며, 이 경로는 전체 리소스 마이그레이션이 아닙니다. 예시: {"configMd5": "<exported-config-digest>"}가져오기 또는 입력 방법: 관리형 외부 데이터 소스 참조는 내보낸 configMd5를 유지해야 하며, 사전에 각 대상 공간에 동일한 내용의 데이터 소스를 구성해야 합니다. |
|
| jsonContents[*].main.charts[*].queries[*].query.outerDatasourceInfo.configMd5 | string | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 대상 데이터 소스 구성 일치 요약입니다. 예시: <exported-config-digest>가져오기 또는 입력 방법: 유효한 내보내기 값을 직접 사용하며 비즈니스 요약을 수동으로 생성하지 않습니다. |
|
| jsonContents[*].main.charts[*].queries[*].queries | array | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 조합 하위 차트 계층에서만 사용하며 내부 구조는 일반 queries와 같고 재귀할 수 있습니다. 일반 query 객체로 간주하지 마십시오. 예시: []가져오기 또는 입력 방법: combine 차트는 유효하게 내보낸 하위 차트 쿼리 배열을 유지합니다. |
|
| jsonContents[*].main.vars[*] | json | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 변수 객체입니다. name/code/type은 strip되고 type은 대문자로 변환됩니다. 변수 유형별 definition/extend 동적 구조는 콘솔의 유효한 내보내기를 유지해야 하며, 서버는 여기서 프런트엔드 의미를 전면적으로 검증하지 않습니다. 예시: {"name": "主机", "code": "host", "type": "QUERY", "definition": {}}가져오기 또는 입력 방법: 대상에서 사용 가능한 템플릿의 변수 객체를 내보내며 이름을 보고 definition 형식을 추측하지 않습니다. |
|
| jsonContents[*].main.vars[*].name | string | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 표시 이름이며 기본값은 비어 있고 앞뒤 공백을 제거합니다. 예시: 主机가져오기 또는 입력 방법: 유효한 내보내기 변수 객체에서 복사하고 이 템플릿의 쿼리 참조와 대조합니다. |
|
| jsonContents[*].main.vars[*].code | string | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 변수 코드이며 기본값은 비어 있고 앞뒤 공백을 제거합니다. 쿼리의 변수 참조와 일치해야 합니다. 예시: host가져오기 또는 입력 방법: 유효한 내보내기 변수 객체에서 복사하고 이 템플릿의 쿼리 참조와 대조합니다. |
|
| jsonContents[*].main.vars[*].type | string | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 변수 유형이며 기본값은 비어 있고 이후 대문자로 변환됩니다. 콘솔의 유효한 내보내기 유형을 사용합니다. 예시: QUERY가져오기 또는 입력 방법: 유효한 내보내기 변수 객체에서 복사하고 이 템플릿의 쿼리 참조와 대조합니다. |
|
| jsonContents[*].main.vars[*].definition | json | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 변수 유형에 따라 내보낸 정의를 완전히 복사하며 기본값은 {}입니다. 예시: {}가져오기 또는 입력 방법: 유효한 내보내기 변수 객체에서 복사하고 이 템플릿의 쿼리 참조와 대조합니다. |
|
| jsonContents[*].main.vars[*].datasource | string | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 선택적 데이터 소스 유형이며 기본값은 빈 문자열이고 원본 내보내기대로 유지합니다. 예시: metric가져오기 또는 입력 방법: 유효한 내보내기 변수 객체에서 복사하고 이 템플릿의 쿼리 참조와 대조합니다. |
|
| jsonContents[*].main.vars[*].valueSort | string | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 선택적 값 정렬이며 기본값은 빈 문자열입니다. 예시: asc가져오기 또는 입력 방법: 유효한 내보내기 변수 객체에서 복사하고 이 템플릿의 쿼리 참조와 대조합니다. |
|
| jsonContents[*].main.vars[*].hide | integer | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 숨김 표시 스위치이며 기본값은 0입니다. 예시: 0가져오기 또는 입력 방법: 유효한 내보내기 변수 객체에서 복사하고 이 템플릿의 쿼리 참조와 대조합니다. |
|
| jsonContents[*].main.vars[*].isHiddenAsterisk | integer | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 별표 숨김 옵션 스위치이며 기본값은 0입니다. 예시: 0가져오기 또는 입력 방법: 유효한 내보내기 변수 객체에서 복사하고 이 템플릿의 쿼리 참조와 대조합니다. |
|
| jsonContents[*].main.vars[*].multiple | boolean | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 다중 선택 여부이며 기본값은 true입니다. 예시: true가져오기 또는 입력 방법: 유효한 내보내기 변수 객체에서 복사하고 이 템플릿의 쿼리 참조와 대조합니다. |
|
| jsonContents[*].main.vars[*].includeStar | boolean | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 별표 옵션 포함 여부이며 기본값은 true입니다. 예시: true가져오기 또는 입력 방법: 유효한 내보내기 변수 객체에서 복사하고 이 템플릿의 쿼리 참조와 대조합니다. |
|
| jsonContents[*].main.vars[*].extend | json | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 변수 확장 객체이며 기본값은 {}이고 원본 내보내기대로 완전히 복사합니다. 예시: {}가져오기 또는 입력 방법: 유효한 내보내기 변수 객체에서 복사하고 이 템플릿의 쿼리 참조와 대조합니다. |
|
| jsonContents[*].main.vars[*].seq | integer | dashboard 템플릿 원본 구성 키입니다. 이 라이브러리 가져오기는 주로 그대로 저장하며, 실제 적용 규칙은 대시보드 식별자 가져오기를 참조하십시오. 가져오기 시 배열 위치로 다시 계산하며 이 값으로 최종 순서를 제어하지 않습니다. 예시: 0가져오기 또는 입력 방법: 유효한 내보내기 변수 객체에서 복사하고 이 템플릿의 쿼리 참조와 대조합니다. |
|
| isCover | boolean | 선택 사항이며 생략/null은 false입니다. 덮어쓰지 않을 때 기존 사용자 정의 동일 이름 충돌은 이번 배치를 차단합니다. true는 일치하는 사용자 정의 템플릿 덮어쓰기를 허용하지만 배치 내 중복 이름/식별자 충돌/필드 오류를 우회하지 않습니다. 덮어쓰기는 전체 meta 또는 지원되는 스크립트 구성 교체이며 JSON 병합이 아닙니다. Pipeline.testData 덮어쓰기에는 현재 매핑 제한이 있으므로 해당 필드를 참조하십시오. null 허용: True 예시: false가져오기 또는 입력 방법: 일반 최초 가져오기는 false이고, 동일 유형/동일 언어 대상 덮어쓰기가 가능함을 확인한 후 true를 사용합니다. |
|
| jsonContents | array | Y | 필수 객체 배열입니다. 빈 []는 기록하지 않으며 HTTP200의 index=-1/err_fields=[jsonContents]를 반환합니다. 각 항목은 JSON 객체여야 하며 직렬화된 문자열이 아닙니다. 고정 전용 탐색기는 현재 첫 번째 항목만 처리하고 나머지는 무시합니다. 기타 분기는 아래 표에 따라 처리합니다. null 허용: False 예시: [{"title": "业务指标", "identifier": "business-dashboard", "main": {"groups": [], "charts": [], "vars": []}}]가져오기 또는 입력 방법: 템플릿 상세 content에서 type과 일치하는 전체 객체를 가져와 배열에 넣습니다. Pipeline은 pipelines 래퍼를 유지합니다. |
| language | string | Y | 선언상 필수이며 zh, en, zh-hant, id, ja, ko, null 또는 빈 문자열일 수 있습니다. null/빈 문자열은 현재 zh로 처리됩니다. 사용자 정의 이름 일치는 일반적으로 해당 언어와 정확히 일치해야 하며, Pipeline은 공통 빈 언어도 일치시킵니다. 항상 명확한 비어 있지 않은 언어를 전달할 것을 권장하며 표시 이름으로 대체할 수 없습니다. 빈 문자열 허용: True null 허용: True 선택 가능 값: ['zh', 'en', 'zh-hant', 'id', 'ja', 'ko'] 예시: zh가져오기 또는 입력 방법: 생성/덮어쓸 정확한 언어를 선택합니다. |
| summary | string | 선택 사항이며 monitor는 meta.summary에 기록합니다. 기타 분기는 이 최상위 필드를 무시하고 원본 객체 메타데이터를 사용합니다. 생략 시 기본값은 비어 있습니다. null 허용: False 예시: 业务异常检测模板가져오기 또는 입력 방법: monitor일 때 검사 라이브러리 요약을 제공합니다. |
|
| title | string | monitor에서 실제 필수이며 비어 있지 않을 것을 권장하고 하위 콘텐츠 title에서 자동으로 가져오지 않습니다. 기타 가져오기 분기는 jsonContents 항목의 title 또는 main.source를 사용하며 이 최상위 필드는 무시됩니다. 생략 시 기본값은 비어 있습니다. null 허용: False 예시: 业务监控检测库가져오기 또는 입력 방법: monitor일 때만 새 검사 라이브러리 이름을 입력하고 목록에서 중복 이름을 확인합니다. |
|
| type | string | Y | 필수 단일 유형이며 한 배치에서 서로 다른 카테고리를 혼합해 가져올 수 없습니다. dashboard/monitor/pipeline은 전용 구조가 있습니다. object/resource-catalog 및 고정 탐색기는 아래 표 규칙을 따릅니다. security/customer-explorer 등 기타 유형은 title 기준으로 전체 meta를 저장합니다. null 허용: False 선택 가능 값: ['dashboard', 'monitor', 'security', 'customer-explorer', 'pipeline', 'object-explorer', 'resource-catalog-explorer', 'ci-explorer', 'rum-explorer', 'tracing-default-explorer', 'cloud-test-explorer', 'tracing-profile-explorer', 'tracing-error-track-explorer', 'logging-default-explorer', 'keyevent-default-explorer', 'security-check-explorer', 'network-explorer', 'tracing-service-explorer', 'logging-error-track-explorer', 'cloud-billing-explorer'] 예시: dashboard가져오기 또는 입력 방법: 템플릿 용도에 따라 이 요청에서 선언할 유형 열거형을 선택하며 GET 콘텐츠 구조와 일치해야 합니다. |
파라미터 추가 설명¶
유형별 콘텐츠 구성 방법¶
공통 title 유형(dashboard, security, customer-explorer 등): 각 항목은 자체 title과 전체 원본 meta를 사용합니다. dashboard는 identifier 충돌을 추가로 검사하지만 모든 차트 쿼리를 사전 검사하지 않습니다. monitor는 모든 항목의 checkers를 최상위 title로 정의된 하나의 검사 라이브러리로 병합하며, 각 jsonScript.title/type을 검사해야 합니다. Pipeline은 pipelines 배열로 래핑하며 스크립트/테스트 데이터는 UTF-8 Base64로 처리하고 평문을 content에 직접 넣을 수 없습니다.
고정 전용 탐색기는 jsonContents[0]만 처리합니다. 이후 항목은 무시되며 반환되지 않은 index를 보고 가져와졌다고 추론하지 않습니다. object-explorer와 resource-catalog-explorer는 항목별로 가져올 수 있지만 각각 첫 main 항목에서 사전 정의 object 소스 또는 실제 custom_object 소스를 선택합니다.
| 가져오기/필터 type | 저장 fileName | 권장 class | 권장 source.key |
|---|---|---|---|
| ci-explorer | ci | gitlab | gitlab_pipeline |
| rum-explorer | rum | rum | session |
| tracing-default-explorer | tracing__default | tracing | tracing |
| cloud-test-explorer | cloud_test | dial_testing | http_dial_testing |
| tracing-profile-explorer | tracing__profile | profiling | tracing |
| tracing-error-track-explorer | tracing__error_track | error_track | tracing |
| logging-default-explorer | logging__default | logging | logging__default |
| keyevent-default-explorer | keyevent__default | keyevent | monitor |
| security-check-explorer | security_check | security | security_check |
| network-explorer | network | network | netflow |
| tracing-service-explorer | tracing__service | tracing | tracing |
| logging-error-track-explorer | logging__error_track | error_track | logging__error_track |
| cloud-billing-explorer | cloud_billing | billing | cloud_billing |
| object 소스 키 | 고정 fileName | 고정 표시 이름 |
|---|---|---|
| kubernetes_jobs | object__job | Jobs |
| kubernetes_nodes | object__node | Nodes |
| kubernetes_cron_jobs | object__cron_job | Cron Jobs |
| kubernetes_deployments | object__deployment | Deployments |
| docker_containers | object__container | Containers |
| host | object__host | host |
| host_processes | object__process | host_processes |
| kubernetes_dfpv | object__dfpv | Persistent Volumes |
| kubernetes_statefulsets | object__statefulset | Statefulsets |
| kubernetes_clusters | object__cluster | Clusters |
| kubernetes_daemonset | object__daemonset | Daemonset |
| others | object__others | others |
| kubelet_pod | object__pod | Pods |
| kubernetes_replica_sets | object__replica_set | Replica Sets |
| kubernetes_services | object__service | Services |
| database_mysql | object__mysql | MySQL |
| kubernetes_persistentvolumeclaims | object__pvc | Persistent Volume Claims |
Base64 구성 예시¶
import base64
import json
script = 'add_key("example", "value")'
content = base64.b64encode(script.encode("utf-8")).decode("ascii")
test_data = base64.b64encode(json.dumps({"sample": {"message": "example"}}, ensure_ascii=False).encode("utf-8")).decode("ascii")
print(content, test_data)
요청 예시¶
import hashlib
import hmac
import json
import time
import uuid
from urllib.parse import urlencode
from urllib.request import Request, urlopen
# 대상 사이트 주소 및 관리자가 할당한 External API AK/SK로 교체합니다.
server = "https://external-api.guance.com"
access_key = "<external-access-key>"
secret_key = "<external-secret-key>"
method = 'POST'
path = '/api/v1/sys_template/custom/import'
query = {}
data = {'type': 'dashboard', 'language': 'zh', 'isCover': False, 'jsonContents': [{'title': '业务指标', 'identifier': 'business-dashboard', 'main': {'groups': [], 'charts': [], 'vars': []}}]}
full_path = path + ("?" + urlencode(query) if query else "")
body = "" if data is None else json.dumps(data, ensure_ascii=False, separators=(",", ":"))
timestamp = str(int(time.time()))
nonce = uuid.uuid4().hex
string_to_sign = " ".join([method, nonce, full_path, timestamp, body])
signature = hmac.new(secret_key.encode("utf-8"), string_to_sign.encode("utf-8"), hashlib.sha256).hexdigest()
headers = {
"X-Df-Access-Key": access_key,
"X-Df-Timestamp": timestamp,
"X-Df-Nonce": nonce,
"X-Df-Signature": signature,
"X-Df-SVersion": "v20240417",
}
if data is not None:
headers["Content-Type"] = "application/json"
request = Request(server + full_path, data=None if data is None else body.encode("utf-8"), headers=headers, method=method)
with urlopen(request) as result:
print(result.read().decode("utf-8"))
응답¶
HTTP200이며 application/json 표준 External 셸입니다. content는 이 페이지의 분기에 따라 객체/배열/null/true가 되며, OpenAPI declaration에 자동으로 추가되지 않고 목록 페이지네이션은 content.pageInfo에 있습니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | 객체 배열 | 가져오기 진단 배열입니다. HTTP200/success=true는 커밋되었음을 의미하지 않습니다. 차단 필드/충돌이 하나라도 있으면 해당 분기의 전체 배치가 기록되지 않습니다. 가져온 후의 UUID는 반환되지 않습니다. |
| content[].index | integer | jsonContents 외부의 0부터 시작하는 순번이며, 최상위/monitor 사전 검사 오류는 -1일 수 있습니다. Pipeline의 여러 하위 항목은 동일한 index를 가질 수 있으며 하위 위치는 err_fields 경로를 확인합니다. |
| content[].name | string 또는 null | 템플릿 이름 또는 소스 키입니다. 고정 전용 탐색기 진단의 name은 비어 있을 수 있습니다. |
| content[].err_fields | 문자열 배열 | 이 항목의 필드 오류 경로입니다. 비어 있지 않으면 해당 분기의 전체 배치 기록을 차단합니다. |
| content[].err_fields[] | string | 예: name, main.checkers, [0].pipelines[0].content. |
| content[].is_exists_name | boolean | 기존 사용자 정의 동일 이름/동일 파일 충돌입니다. 성공적으로 덮어쓸 때 false로 정규화됩니다. |
| content[].import_exists_name | boolean | 이 요청 내 중복 이름/동일 파일 대상이며, true이면 전체 배치를 차단합니다. |
| content[].is_exists_identify | boolean | dashboard 전용: 다른 기존 템플릿 identifier와 충돌하며 덮어쓰기로도 우회할 수 없습니다. |
| content[].identifier | string | dashboard 전용 이 항목의 identifier입니다. |
| content[].import_exists_identity_id | boolean | dashboard 전용 이번 배치의 identifier 중복입니다. |
{
"code": 200,
"content": [
{
"index": 0,
"name": "业务指标",
"err_fields": [],
"is_exists_name": false,
"is_exists_identify": false,
"identifier": "business-dashboard",
"import_exists_name": false,
"import_exists_identity_id": false
}
],
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
HTTP200 비즈니스 검증 실패, 전체 배치 미가져오기 예시:
{
"code": 200,
"content": [
{
"index": 0,
"name": "已有模板",
"err_fields": [],
"is_exists_name": true,
"import_exists_name": false
}
],
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
빈 jsonContents 예시:
{
"code": 200,
"content": [
{
"index": -1,
"name": "",
"err_fields": [
"jsonContents"
],
"is_exists_name": false
}
],
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반함 | 파라미터 파싱 실패 | 파라미터 위치, 필드 이름, 유형 및 값을 확인합니다. |
| 400 | ft.RequestJsonFormatError | 요청 JSON 구문이 유효하지 않음 | 요청 JSON 형식 오류 | content.reason, line, column에 따라 JSON을 수정합니다. |
| 400 | ft.JsonFormatError | 요청 JSON 최상위가 객체가 아님 | 일부 json 파일 형식 오류 | 전체 JSON 객체를 제출합니다. |
| 500 | ft.InternalServerError | jsonContents 요소/동적 필드 유형 오류, Base64 이외의 미검증 구조, 데이터베이스 저장/삭제 예외 | 내부 오류 | 먼저 템플릿 목록과 상세로 현재 상태를 확인한 후 재시도하십시오. HTTP200 진단은 500과 다르며, 오류는 항목별 기록 UUID를 제공하지 않습니다. traceId를 보존하고 무작정 반복 덮어쓰지 마십시오. |