修改一个查看器¶

POST /api/v1/viewer/{viewer_uuid}/modify

概述¶

修改查看器

路由参数¶

参数名	类型	必选	说明
viewer_uuid	string	Y	查看器UUID

Body 请求参数¶

参数名	类型	必选	说明
name	string		查看器名称例子: 查看器1号允许为空: False 最大长度: 64
desc	string		描述例子: 描述1 允许为空: False 允许为空字符串: True 最大长度: 2048
type	string		类型, 默认为 CUSTOM 例子: CUSTOM 允许为空: False 最大长度: 32
extend	json		查看器的额外数据, 默认为{} 例子: {} 允许为空: False
pathName	string		explorer 路径名例子: tracing__profile 允许为空: False 最大长度: 32
tagNames	array		tag的name 允许为空: False
tagNames[*]	string		tag名允许为空: False 最大长度: 128
dashboardBindSet	array		查看器绑定的视图信息例子: [] 允许为空: False 允许为空字符串: False

参数补充说明¶

请求例子¶

curl 'https://openapi.guance.com/api/v1/viewer/dsbd_xxxx32/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"name":"modify_viewer","tagNames":["应用性能"]}' \
--compressed

响应¶

{
    "code": 200,
    "content": {
        "chartGroupPos": [],
        "chartPos": [],
        "createAt": 1677661673,
        "createdWay": "manual",
        "creator": "wsak_xxxxx",
        "dashboardBidding": {},
        "dashboardBindSet": [],
        "deleteAt": -1,
        "extend": {
            "analysisField": "message",
            "charts": [
                null,
                null,
                null
            ],
            "filters": [],
            "index": "tracing",
            "quickFilter": {
                "columns": []
            },
            "rumAppId": "",
            "rumType": "",
            "selectedIndex": "default",
            "source": "",
            "table": {
                "columns": []
            }
        },
        "iconSet": {},
        "id": 712,
        "isPublic": 1,
        "mapping": [],
        "name": "modify_viewer",
        "old_name": "add_viewer",
        "ownerType": "viewer",
        "status": 0,
        "tag_info": {
            "tagInfo": [
                {
                    "id": "tag_xxxx32",
                    "name": "应用性能"
                }
            ]
        },
        "type": "CUSTOM",
        "updateAt": 1677662058.377045,
        "updator": "wsak_xxxxx",
        "updatorInfo": {
            "email": "wsak_xxxxx",
            "iconUrl": "",
            "name": "智能巡检测试",
            "username": "xxxx"
        },
        "uuid": "dsbd_xxxx32",
        "workspaceUUID": "wksp_xxxx32"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-AECCF8D3-29D3-431E-AB68-046688C30035"
}