コンテンツにスキップ

機能メニュー設定¶

POST /api/v1/workspace/menu/set

概要¶

現在のワークスペースの機能メニューを設定します。

Body リクエストパラメータ¶

パラメータ名	タイプ	必須	説明
menu	array	Y	設定するメニューバーのリスト空を許可: False
menu[*]	json	Y	メニューオプション空を許可: False
menu[*].key	string	Y	メニュー例: CloudDial 空を許可: False 選択可能な値: ['Scene', 'Events', 'ExceptionsTracking', 'Objectadmin', 'MetricQuery', 'LogIndi', 'Tracing', 'Rum', 'CloudDial', 'Security', 'GitLabCI', 'Monitor', 'Integration', 'Workspace', 'Billing']
menu[*].value	int	Y	メニュー項目の有効/無効: 1 有効、0 無効例: 1 空を許可: False 選択可能な値: [0, 1]

パラメータ補足説明¶

パラメータ説明

パラメータ名	type	必須	説明
menu	array[json]	Y	メニューバーのリスト
key	string	Y	メニュー項目
value	int	Y	有効/無効: 0 無効、1 有効

メニュー項目の説明

key	説明
Scene	シーン
Events	イベント
ExceptionsTracking	インシデント
Objectadmin	インフラストラクチャ
MetricQuery	メトリクス
LogIndi	ログ
Tracing	APM
Rum	RUM
CloudDial	Synthetic モニタリング
Security	セキュリティチェック
GitLabCI	CI 可視化
Monitor	モニター
Integration	インテグレーション
Workspace	管理
Billing	料金プランと請求

注意:
1. 設定されていない場合、フロントエンドは新しいメニューとして扱い、デフォルトで開きます。
2. 管理画面に存在するメニュー設定は、ワークスペース設定の最終的な表示に影響を与える可能性があります。

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/workspace/menu/set' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'DF-API-KEY: <DF-API-KEY>' \

--data-raw '{"menu":[{"key":"Scene","value":1},{"key":"Notebook","value":1},{"key":"Events","value":1},{"key":"ExceptionsTracking","value":1},{"key":"Objectadmin","value":1},{"key":"MetricQuery","value":1},{"key":"LogIndi","value":1},{"key":"Tracing","value":1},{"key":"Rum","value":1},{"key":"CloudDial","value":1},{"key":"Security","value":1},{"key":"GitLabCI","value":1},{"key":"Monitor","value":1},{"key":"Integration","value":1},{"key":"Workspace","value":1},{"key":"Billing","value":1}]}' \

レスポンス¶

{
    "code": 200,
    "content": {
        "config": [
            {
                "key": "Scene",
                "value": 1
            },
            {
                "key": "Notebook",
                "value": 1
            },
            {
                "key": "Events",
                "value": 1
            },
            {
                "key": "ExceptionsTracking",
                "value": 1
            },
            {
                "key": "Objectadmin",
                "value": 1
            },
            {
                "key": "MetricQuery",
                "value": 1
            },
            {
                "key": "LogIndi",
                "value": 1
            },
            {
                "key": "Tracing",
                "value": 1
            },
            {
                "key": "Rum",
                "value": 1
            },
            {
                "key": "CloudDial",
                "value": 1
            },
            {
                "key": "Security",
                "value": 1
            },
            {
                "key": "GitLabCI",
                "value": 1
            },
            {
                "key": "Monitor",
                "value": 1
            },
            {
                "key": "Integration",
                "value": 1
            },
            {
                "key": "Workspace",
                "value": 1
            },
            {
                "key": "Billing",
                "value": 1
            }
        ],
        "createAt": 1697627382,
        "creator": "acnt_xxxx32",
        "deleteAt": -1,
        "id": 763,
        "keyCode": "WsMenuCfg",
        "status": 0,
        "updateAt": 1697627382,
        "updator": "acnt_xxxx32",
        "uuid": "ctcf_xxxx32",
        "workspaceUUID": "wksp_xxxx20"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "475074598825122309"
}