Skip to content

Modify a Viewer¶

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

Overview¶

Modify a viewer

Route Parameters¶

Parameter Name	Type	Required	Description
viewer_uuid	string	Y	Viewer UUID

Body Request Parameters¶

Parameter Name	Type	Required	Description
name	string		Viewer name Example: Viewer No.1 Can be empty: False Maximum length: 64
desc	string		Description Example: Description 1 Can be empty: False Can be an empty string: True Maximum length: 2048
type	string		Type, defaults to CUSTOM Example: CUSTOM Can be empty: False Maximum length: 32
extend	json		Additional data for the viewer, defaults to {} Example: {} Can be empty: False
pathName	string		Explorer path name Example: tracing__profile Can be empty: False Maximum length: 32
tagNames	array		Tag names Can be empty: False
tagNames[*]	string		Tag name Can be empty: False Maximum length: 128
dashboardBindSet	array		Information about views bound to the viewer Example: [] Can be empty: False Can be an empty string: False

Additional Parameter Notes¶

Request Example¶

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":["APM"]}' \
--compressed

Response¶

{
    "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": "APM"
                }
            ]
        },
        "type": "CUSTOM",
        "updateAt": 1677662058.377045,
        "updator": "wsak_xxxxx",
        "updatorInfo": {
            "email": "wsak_xxxxx",
            "iconUrl": "",
            "name": "Intelligent Inspection Test",
            "username": "xxxx"
        },
        "uuid": "dsbd_xxxx32",
        "workspaceUUID": "wksp_xxxx32"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-AECCF8D3-29D3-431E-AB68-046688C30035"
}