変更¶
POST /api/v1/dashboards/{dashboard_uuid}/modify
概要¶
指定したダッシュボードの属性、タグ、可視範囲を変更します。
呼び出し前の確認と使用手順¶
まずダッシュボード詳細を呼び出して現在の設定を読み取り、変更するフィールドを送信します。extend、mapping、または tagNames を指定した場合は、対応する内容が全体置換されます。同じダッシュボードの変更は直列に実行し、並行する読み取り・変更・書き込みが相互に上書きしないようにしてください。デフォルトのクエリ空間のみを調整する場合は、拡張情報設定を使用します。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| dashboard_uuid | string | Y | 対象ダッシュボードの UUID。 例: dsbd_example取得または入力方法: ダッシュボード一覧の content.data[].uuid からコピーするか、作成結果の content.uuid を使用します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API キー管理から、この操作権限を持つ OpenAPI キーを取得します。 |
ボディのリクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| name | string | ダッシュボードの表示名。 null を許可: False 例: 生产巡检取得または入力方法: 現在のワークスペース内で他のダッシュボードに使用されていない名前を使用します。 |
|
| desc | string | ダッシュボードの説明。 null を許可: False 空文字列を許可: True 最大長: 2048 例: 生产服务巡检指标取得または入力方法: このダッシュボードの用途を入力します。空文字列を渡すと説明をクリアします。 |
|
| identifier | string | カスタム識別 ID。最大 128 文字です。この値と UUID は別々に使用します。 null を許可: False 空文字列を許可: True 最大長: 128 例: prod-check取得または入力方法: 呼び出し元の命名規則に従い、このワークスペース内で他のダッシュボードに使用されていない識別子を指定します。 |
|
| extend | json | ダッシュボードの拡張設定。必要に応じて既存フィールドを再利用します。 null を許可: False 例: {}取得または入力方法: ダッシュボード詳細の content.extend から既存オブジェクトを取得します。 |
|
| mapping | array | ダッシュボード変数のフィールドマッピング配列。マッピングがない場合は空配列を渡せます。 null を許可: False 例: []取得または入力方法: 既存ダッシュボードの content.mapping またはエクスポートテンプレートの content.dashboardMapping から値を取得します。 |
|
| tagNames | array | 完全なタグリストを送信します。[] を渡すと、すべてのタグ関連付けを解除できます。 null を許可: False 例: ["team:ops"]取得または入力方法: ダッシュボード詳細の content.tagInfo[].name からコピーするか、関連付けるタグ名を入力します。 |
|
| isPublic | int | 1 は公開、0 は作成したアイデンティティのみ表示、-1 はカスタム権限。省略時は元の可視範囲を保持します。 null を許可: False 例: 1取得または入力方法: 対象の可視範囲に応じて 1、0、または -1 を選択します。 |
|
| permissionSet | array | isPublic=-1 のときに使用する操作権限リスト。ロール(オーナーを除く)、メンバー、チームの UUID を含めることができます。 null を許可: False 例: ["role_example"]取得または入力方法: ロール一覧、メンバー一覧、またはチーム一覧から UUID を取得します。 |
|
| readPermissionSet | array | isPublic=-1 のときに使用する読み取り権限リスト。ロール(オーナーを除く)、メンバー、チームの UUID を含めることができます。 null を許可: False 例: ["role_example"]取得または入力方法: ロール一覧、メンバー一覧、またはチーム一覧から UUID を取得します。 |
パラメータ補足説明¶
フィールドを省略した場合は現在値が保持されます。タグ保存後に詳細を呼び出して、関連付けられたタグを完全に再取得できます。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/dashboards/dsbd_example/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"生产巡检 v2"}'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.id | integer | ダッシュボードレコード番号。 |
| content.uuid | string | ダッシュボード UUID。詳細、変更、削除、カルーセルで使用します。 |
| content.workspaceUUID | string | 所属ワークスペース。 |
| content.name | string | ダッシュボードの表示名。 |
| content.desc | string | ダッシュボードの説明。 |
| content.identifier | string | 外部向けのカスタム識別子。空の場合があります。 |
| content.ownerType | string | リソースタイプの所属。ダッシュボードでは通常 node です。 |
| content.type | string | ダッシュボードタイプ。例: CUSTOM。 |
| content.chartPos | array<object> |
グラフレイアウト配列。各項目の chartUUID はグラフ識別子、pos はレイアウトオブジェクトです。 |
| content.chartPos[].chartUUID | string | 関連付けられたグラフの UUID。 |
| content.chartPos[].pos | object | グラフのサイズと位置。例: x、y、w、h。 |
| content.chartGroupPos | array<string> |
グラフグループ識別子の並び順。 |
| content.iconSet | object | アイコン設定。 |
| content.isPublic | integer | 1 は公開、0 は作成したアイデンティティのみ表示、-1 はカスタム権限。 |
| content.extend | object | 拡張設定。 |
| content.mapping | array<object> |
変数フィールドマッピング。 |
| content.createdWay | string | リソースの作成元。 |
| content.dashboardBindSet | array | ビューバインド設定。 |
| content.openPermissionSet | boolean | 現在カスタム権限が有効かどうか。 |
| content.permissionSet | array<string> |
操作権限主体の UUID リスト。 |
| content.readPermissionSet | array<string> |
読み取り権限主体の UUID リスト。 |
| content.tagInfo | array<object> |
このレスポンスに関連するタグ情報。 |
| content.tagInfo[].id | string | タグ識別子。uuid と同じです。 |
| content.tagInfo[].uuid | string | タグ UUID。 |
| content.tagInfo[].name | string | 関連付けられたタグ名。 |
| content.tagInfo[].description | string | タグの説明。 |
| content.tagInfo[].colour | string | タグの色。 |
| content.tagInfo[].scope | array<string> |
タグの適用範囲。 |
| content.tagInfo[].tagPermissionInfo | object | タグ認可が存在する場合に付随する操作権限と読み取り権限の情報。 |
| content.status | integer | レコードステータス。 |
| content.creator | string | 作成者のアイデンティティ ID。 |
| content.updator | string | 最終更新者のアイデンティティ ID。更新がない場合は空の場合があります。 |
| content.createAt | number | 作成時刻(Unix 秒)。 |
| content.updateAt | number | 最終更新時刻(Unix 秒)。更新がない場合は -1 の場合があります。 |
| content.deleteAt | number | 削除時刻(Unix 秒)。未削除の場合は -1 です。 |
| content.creatorInfo | object | 作成者情報。空オブジェクトの場合があります。 |
| content.updatorInfo | object | 最終更新者情報。空オブジェクトの場合があります。 |
| content.declaration | object または null | ワークスペースの共通宣言。 |
| content.old_name | string | 更新前の名前。 |
| content.dashboardBidding | object | ビューバインドデータ。ダッシュボードに関連するバインド情報がない場合は空オブジェクトです。 |
{
"code": 200,
"content": {
"id": 21,
"uuid": "dsbd_example",
"name": "生产巡检 v2",
"desc": "生产服务巡检指标",
"workspaceUUID": "wksp_example",
"identifier": "prod-check",
"ownerType": "node",
"type": "CUSTOM",
"chartPos": [],
"chartGroupPos": [],
"iconSet": {},
"isPublic": 1,
"extend": {},
"mapping": [],
"createdWay": "manual",
"dashboardBindSet": [],
"openPermissionSet": false,
"permissionSet": [],
"readPermissionSet": [],
"tagInfo": [],
"creator": "wsak_example",
"updator": "wsak_example",
"createAt": 1785427200,
"updateAt": 1785427320,
"deleteAt": -1,
"status": 0,
"declaration": {},
"creatorInfo": {},
"updatorInfo": {},
"old_name": "生产巡检",
"dashboardBidding": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証・認可、レート制限、共通リクエストエラーについては、共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたは応答の説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドが欠落しているか、フィールド値が宣言された検証条件に違反しています | パラメータ解析に失敗しました | パラメータの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効です | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正してください。 |
| 400 | ft.JsonFormatError | JSON 構文は有効ですが、リクエストのトップレベルがオブジェクトではありません | 一部の JSON ファイル形式が不正です | パラメータを JSON オブジェクト内に配置してください。 |
| 404 | ft.NotFoundView | 対象のダッシュボードが存在しない、削除済み、または現在のワークスペースにありません | 指定されたビューが見つかりません | 現在のワークスペースのダッシュボード一覧で返された UUID に切り替えてください。 |
| 403 | ft.ForbiddenDashboardOperation | 呼び出し元のアイデンティティが対象のダッシュボードを操作できません | ダッシュボード【{}】の操作権限がありません | ダッシュボードの可視範囲、操作認可、使用している API キーを確認してください。 |
| 400 | ft.TagScopeMismatch | タグ名は既に存在しますが、そのスコープがシーンタグと互換性がありません | メッセージにはタグ名とスコープが含まれます。例: team:ops: ['monitor'] -> scene。 | シーンまたは汎用スコープのタグ名を選択するか、名前を変更してください。 |
| 406 | ft.ExceedMaxCharacterLimit | タグ名が 128 文字を超えています | {} が最大文字数制限を超えています | タグ名を短縮してから再送信してください。 |
| 400 | ft.ObjectParmeterExists | 変更後の名前が他の同種ダッシュボードと重複しています | {} は既に存在します |
別の名前にするか、対象 UUID を確認してください。 |
| 400 | ft.IdentificationIdExists | 新しい identifier は現在のワークスペース内の他のダッシュボードで既に使用されています | 識別 ID は既に存在します | identifier を変更してから再送信してください。 |
| 400 | ft.IndexDashboardForbiddenSetVisibleSet | 対象が現在のホームダッシュボードであり、非公開の可視範囲が送信されています | ホームダッシュボードでは可視範囲を設定できません | 公開のままにしてください。範囲を制限する必要がある場合は、先にワークスペースのホーム設定を調整してください。 |