콘텐츠로 이동

목록¶

POST /api/v1/notes_v2/list

개요¶

현재 API Key가 속한 계정에서 볼 수 있는 새 버전 노트를 조회합니다.

Body 요청 파라미터¶

파라미터명	유형	필수	설명
pageIndex	integer		페이지 번호 빈 값 허용: False
pageSize	integer		페이지당 항목 수 빈 값 허용: False
search	string		제목 및 본문 검색어 빈 값 허용: False
query	string		제목 및 본문 검색어, search보다 우선순위가 높음 빈 값 허용: False
tags	array		전역 태그 필터, 여러 태그 전달 시 기본 OR 조건으로 매칭 빈 값 허용: False
tagKV	json		키-값 태그 필터, 예: {"host":"127.0.0.1"} 빈 값 허용: False
tagKVQuery	string		키-값 태그 표현식 필터, 예: host:"127.0.0.1" 빈 값 허용: False
tagMode	string		태그 매칭 방식, 미전달 시 tags는 기본적으로 or 조건으로 매칭 빈 값 허용: False 可选值: ['and', 'or']
createdSource	string		생성 소스 필터, 예: manual 또는 ai 빈 값 허용: False
noteType	string		노트 유형 필터, normal은 일반 노트, runbook은 운영 매뉴얼 빈 값 허용: False 可选值: ['normal', 'runbook']
isPublic	boolean		공개 또는 비공개 노트만 반환할지 여부; Status Page는 항상 true를 전달해야 함 빈 값 허용: False
tagKVRange	json		TagKV 문자열 폐구간 필터, 예: {"date":{"gte":"2026-05-03","lte":"2026-07-31"}} 빈 값 허용: False
includeContent	boolean		목록 항목에 Markdown content를 포함할지 여부; 활성화 시 반드시 페이지네이션을 사용하고 pageSize는 100을 초과할 수 없음 빈 값 허용: False

파라미터 추가 설명¶

이 인터페이스를 사용하여 현재 워크스페이스에서 현재 API Key가 액세스할 수 있는 새 버전 노트 요약을 가져옵니다.

페이지네이션이 필요한 경우 pageIndex와 pageSize를 함께 전달하십시오.
제목 또는 본문으로 검색이 필요한 경우 search를 전달하거나 query를 전달할 수 있습니다. 두 값이 모두 존재하는 경우 query가 우선 적용됩니다.
태그로 필터링이 필요한 경우 tags, tagKV 또는 tagKVQuery를 전달하십시오. 예: tagKVQuery: "host:\"127.0.0.1\""; tags에 여러 값을 전달하고 tagMode를 전달하지 않으면 OR 조건으로 매칭됩니다.
목록 응답에는 Markdown 본문이 포함되지 않습니다. 본문을 읽으려면 상세 정보 인터페이스를 호출하십시오.
이후 조회, 수정, 삭제는 모두 응답의 noteUUID를 사용하십시오.

요청 예시¶

curl 'https://openapi.guance.com/api/v1/notes_v2/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"pageIndex":1,"pageSize":20,"isPublic":true,"includeContent":true,"tagKV":{"page_scope":"status_page","publish_status":"published"},"tagKVRange":{"date":{"gte":"2026-05-03","lte":"2026-07-31"}}}'

응답¶

{
    "code": 200,
    "content": {
        "data": [
            {
                "noteUUID": "nbnote_xxx",
                "title": "A",
                "name": "A",
                "tags": [
                    "ops"
                ],
                "tagKV": {
                    "host": "127.0.0.1"
                },
                "isPublic": 1,
                "createdSource": "manual",
                "noteType": "normal",
                "etag": "etag_xxx",
                "version": 1,
                "createAt": 1782370000,
                "updateAt": 1782370100
            }
        ],
        "pageInfo": {
            "pageIndex": 1,
            "pageSize": 20,
            "totalCount": 1
        }
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}