コンテンツにスキップ

作成¶

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		タグの名前空を許可: 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"
}