콘텐츠로 이동

생성¶

POST /api/v1/viewer/add

개요¶

탐색기를 생성합니다.

Body 요청 파라미터¶

파라미터명	타입	필수	설명
ownerType	string		뷰 분류 유형, 기본값은 viewer 예시: viewer 빈 값 허용: False
templateUUID	string		뷰 템플릿 UUID 빈 값 허용: False 빈 문자열 허용: True 최대 길이: 128
sourceDashboardUUID	string		소스 뷰 UUID 빈 값 허용: False 빈 문자열 허용: True 최대 길이: 128
name	string	Y	탐색기 이름 빈 값 허용: False 최대 길이: 64
desc	string		설명 예시: 설명1 빈 값 허용: False 빈 문자열 허용: True 최대 길이: 2048
type	string		타입, 기본값은 CUSTOM 예시: CUSTOM 빈 값 허용: False 최대 길이: 32
extend	json		탐색기의 추가 데이터, 기본값은 {} 예시: {} 빈 값 허용: False
templateInfos	json		사용자 정의 템플릿 데이터 예시: {} 빈 값 허용: False 빈 문자열 허용: False
isImport	boolean		가져온 탐색기 여부 빈 값 허용: False
tagNames	array		태그의 name 목록 빈 값 허용: False
tagNames[*]	string		태그명 빈 값 허용: False 최대 길이: 128

파라미터 추가 설명¶

요청 예시¶

curl 'https://openapi.guance.com/api/v1/viewer/add' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"name":"add_viewer","templateInfos":{},"isImport":false,"tagNames":[],"extend":{"index":"tracing"}}' \
--compressed

응답¶

{
    "code": 200,
    "content": {
        "chartGroupPos": [],
        "chartPos": [],
        "createAt": 1677661673,
        "createdWay": "manual",
        "creator": "wsak_xxxxx",
        "dashboardBindSet": [],
        "deleteAt": -1,
        "extend": {
            "index": "tracing"
        },
        "iconSet": {},
        "id": null,
        "isPublic": 1,
        "mapping": [],
        "name": "add_viewer",
        "ownerType": "viewer",
        "status": 0,
        "tag_info": [
            {
                "id": "tag_xxxx32",
                "name": "Function"
            },
            {
                "id": "tag_xxxx32",
                "name": "Host"
            },
            {
                "id": "tag_xxxx32",
                "name": "Profile"
            },
            {
                "id": "tag_xxxx32",
                "name": "data"
            },
            {
                "id": "tag_xxxx32",
                "name": "ok"
            },
            {
                "id": "tag_xxxx32",
                "name": "ui"
            },
            {
                "id": "tag_xxxx32",
                "name": "personal"
            },
            {
                "id": "tag_xxxx32",
                "name": "for"
            },
            {
                "id": "tag_xxxx32",
                "name": "inner"
            },
            {
                "id": "tag_xxxx32",
                "name": "security"
            },
            {
                "id": "tag_xxxx32",
                "name": "tracing"
            },
            {
                "id": "tag_xxxx32",
                "name": "logging"
            },
            {
                "id": "tag_xxxx32",
                "name": "rum"
            },
            {
                "id": "tag_xxxx32",
                "name": "aliyun"
            },
            {
                "id": "tag_xxxx32",
                "name": "aliyun monitor"
            }
        ],
        "type": "CUSTOM",
        "updateAt": 1677661673,
        "updator": "wsak_xxxxx",
        "uuid": "dsbd_xxxx32",
        "workspaceUUID": "wksp_xxxx32"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-7EB1D391-C7BA-47BA-A535-DEE932554366"
}