콘텐츠로 이동

목록



GET /api/v1/viewer/list

개요

모든 조건에 맞는 탐색기를 나열합니다.

Query 요청 매개변수

매개변수명 유형 필수 설명
sortKey string 정렬 필드, 기본값은 updateAt 기준 정렬, 해당 값이 없을 경우 기본 정렬 사용
빈 값 허용 안 함: False
빈 문자열 허용: True
선택 가능 값: ['name', 'updateAt']
sortMethod string 정렬 방법, 기본값은 desc 기준 정렬
빈 값 허용 안 함: False
빈 문자열 허용: True
선택 가능 값: ['desc', 'asc']
search string 탐색기 이름 검색
빈 값 허용 안 함: False
pageIndex integer 페이지 번호
빈 값 허용 안 함: False
예시: 10
$minValue: 1
pageSize integer 페이지당 반환 개수
빈 값 허용 안 함: False
예시: 10
$minValue: 1
$maxValue: 100
filter string 필터 조건
빈 값 허용 안 함: False
선택 가능 값: ['total', 'favorite', 'import', 'myCreate', 'oftenBrowse', 'ofenBrowse', 'selfVisibleOnly']
tagNames json 필터링에 사용할 태그 name
빈 값 허용 안 함: False
예시: []

매개변수 추가 설명

요청 예시

curl 'https://openapi.guance.com/api/v1/viewer/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--compressed 

응답

{
    "code": 200,
    "content": [
        {
            "chartGroupPos": [],
            "chartPos": [],
            "createAt": 1677659952,
            "createdWay": "import",
            "creator": "acnt_xxxx32",
            "creatorInfo": {
                "email": "xxx@guance.com",
                "iconUrl": "",
                "name": "88Test",
                "username": "Test"
            },
            "dashboardBindSet": [],
            "deleteAt": -1,
            "extend": {
                "analysisField": "message",
                "charts": [
                    null,
                    {
                        "extend": {
                            "fixedTime": "",
                            "settings": {
                                "alias": [],
                                "chartType": "line",
                                "colors": [],
                                "compareColors": {
                                    "dayCompare": "rgba(11,11,12,0.5)",
                                    "hourCompare": "#0B0B0C",
                                    "monthCompare": "rgba(11,11,12,0.12)",
                                    "weekCompare": "rgba(11,11,12,0.3)"
                                },
                                "compareColorsDark": {
                                    "dayCompare": "rgba(213,217,226,0.5)",
                                    "hourCompare": "#D5D9E2",
                                    "monthCompare": "rgba(213,217,226,0.12)",
                                    "weekCompare": "rgba(213,217,226,0.25)"
                                },
                                "compareColorsLight": {
                                    "dayCompare": "rgba(11,11,12,0.5)",
                                    "hourCompare": "#0B0B0C",
                                    "monthCompare": "rgba(11,11,12,0.12)",
                                    "weekCompare": "rgba(11,11,12,0.3)"
                                },
                                "compareType": [],
                                "density": "medium",
                                "fixedTime": "",
                                "isPercent": false,
                                "isTimeInterval": true,
                                "legendPostion": "none",
                                "legendValues": "",
                                "levels": [],
                                "onlyShowGroupName": false,
                                "openCompare": false,
                                "openStack": false,
                                "showFieldMapping": false,
                                "showLine": false,
                                "showTitle": true,
                                "stackType": "time",
                                "timeInterval": "auto",
                                "titleDesc": "",
                                "units": [],
                                "xAxisShowType": "time",
                                "yAxixMaxVal": null,
                                "yAxixMinVal": null
                            }
                        },
                        "isQuery": true,
                        "name": "New Chart",
                        "queries": [
                            {
                                "color": "",
                                "datasource": "dataflux",
                                "name": "",
                                "qtype": "dql",
                                "query": {
                                    "alias": "",
                                    "code": "A",
                                    "dataSource": "",
                                    "field": "",
                                    "fieldFunc": "",
                                    "fill": null,
                                    "filters": [],
                                    "funcList": [],
                                    "groupBy": [],
                                    "groupByTime": "",
                                    "indexFilter": "",
                                    "namespace": "tracing",
                                    "q": "",
                                    "queryFuncs": [],
                                    "type": "simple"
                                },
                                "type": "sequence",
                                "unit": ""
                            }
                        ],
                        "type": "sequence"
                    },
                    null
                ],
                "filters": [],
                "index": "tracing",
                "quickFilter": {
                    "columns": []
                },
                "rumAppId": "",
                "rumType": "",
                "selectedIndex": "default",
                "source": "",
                "table": {
                    "columns": []
                }
            },
            "iconSet": {},
            "id": 711,
            "isFavorite": false,
            "isPublic": 1,
            "mapping": [],
            "name": "11",
            "ownerType": "viewer",
            "status": 0,
            "tag_info": {
                "tagInfo": []
            },
            "type": "CUSTOM",
            "updateAt": 1677662452,
            "updator": "acnt_xxxx32",
            "updatorInfo": {
                "email": "xxx@guance.com",
                "iconUrl": "",
                "name": "88Test",
                "username": "Test"
            },
            "uuid": "dsbd_xxxx32",
            "workspaceUUID": "wksp_xxxx32"
        }
    ]
}

문서 평가

이 페이지가 도움이 되었나요?