変更¶
POST /api/v1/dashboard/{dashboard_uuid}/modify
概要¶
組み込みビューの名前、説明、識別子、またはバインディング条件を更新します。
呼び出し前の準備と使用手順¶
まず組み込みビューの詳細を呼び出して、既存の dashboardBidding と名前を保存します。dashboardBidding を省略するか空のオブジェクトを送信すると、既存のバインディングは削除されます。名前などのフィールドのみを変更し、バインディングを保持する場合も、詳細で返された完全な dashboardBidding を送信する必要があります。変更後は詳細で再度確認します。
パスパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| dashboard_uuid | string | Y | 現在のワークスペースの組み込みビュー UUID。 例: dsbd_inner_example取得または入力方法: 組み込みビュー一覧 の content.data[].uuid から取得するか、作成レスポンスの content.uuid を使用できます。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
リクエストボディパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| dashboardBidding.* | array | 属性値は、対応するフィールドのマッチ条件配列です。 例: [{"op": "in", "value": ["web-01"]}]取得または入力方法: 組み込みビューの詳細で現在のバインディングを読み取るか、ビューへのジャンプ元となるログやオブジェクトなどのデータでフィールド値を確認します。 |
|
| dashboardBidding.*[].op | string | in は指定値のいずれかに一致、wildcard はワイルドカードパターンで一致します。ソースフィールドの値が空でない場合、単独の * はすべての値に一致します。複数の条件は、いずれかに一致したものとして処理されます。 例: in取得または入力方法: 詳細にあるそのフィールドのマッチ方式を優先して使用します。 |
|
| dashboardBidding.*[].value | array | 文字列配列です。ワークスペースで左ワイルドカードが制限されている場合は、*example 形式の使用を避けてください。 例: ["web-01"]取得または入力方法: 元データのそのフィールドから実際の値を選択します。タグに一致させる場合は label、元データの df_label を使用できます。 |
|
| name | string | 組み込みビュー名。最大 256 文字。 null 許可: False 最大長: 256 例: 主机详情内置视图取得または入力方法: 現在のワークスペース内で別の組み込みビューに使用されていない名前を入力します。 |
|
| desc | string | 組み込みビューの説明。最大 2048 文字。 null 許可: False 最大長: 2048 例: 根据主机查看运行状态取得または入力方法: このビューの用途を入力します。 |
|
| identifier | string | 同じワークスペース内の組み込みビュー識別子は一意である必要があります。最大 128 文字で、空でもかまいません。 null 許可: False 空文字列許可: True 最大長: 128 例: host-overview取得または入力方法: 安定した識別子を独自に定義します。変更前に詳細から現在の identifier を取得できます。 |
|
| dashboardBidding | json | 完全なバインディング条件。空でないオブジェクトを送信すると全体が置き換えられます。省略するか {} を渡すとバインディングが削除されます。 null 許可: False 例: {"host": [{"op": "in", "value": ["web-01"]}]}取得または入力方法: 組み込みビューの詳細で現在のバインディングを読み取るか、ビューへのジャンプ元となるログやオブジェクトなどのデータでフィールド値を確認します。 |
パラメータ補足説明¶
識別子を変更する場合は、その識別子に依存する呼び出しも同時に更新してください。バインディングを保持する場合は、例の値を自身の詳細結果で置き換えてください。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/dashboard/dsbd_inner_example/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"主机详情内置视图 v2","dashboardBidding":{"host":[{"op":"in","value":["web-01"]}]}}'
レスポンス¶
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 | 組み込みビューのリソース所有種別。組み込みビューの場合は inner です。 |
| content.type | string | 組み込みビューの種類。例: CUSTOM。 |
| content.isPublic | integer | 詳細のアクセス範囲。1 は公開、0 は作成者のみアクセス可能です。 |
| 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.extend | object | 組み込みビューの拡張情報。 |
| content.mapping | array<object> |
変数フィールドのマッピング情報。 |
| content.dashboardBindSet | array | ビューのバインディング設定。 |
| content.createdWay | string | リソースの作成元。 |
| content.openPermissionSet | boolean | エンティティレコードの権限設定スイッチ。 |
| content.permissionSet | array<string> |
レコード内の操作権限プリンシパル UUID。 |
| content.readPermissionSet | array<string> |
レコード内の読み取り権限プリンシパル UUID。 |
| 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.creatorInfo.uuid | string | 対応する ID が見つかった場合に提供されることがあります。ID 識別子。 |
| content.creatorInfo.status | integer | 対応する ID が見つかった場合に提供されることがあります。アカウントステータス。 |
| content.creatorInfo.wsAccountStatus | integer | 対応する ID が見つかった場合に提供されることがあります。ワークスペースメンバーステータス。 |
| content.creatorInfo.username | string | 対応する ID が見つかった場合に提供されることがあります。ログイン名。 |
| content.creatorInfo.name | string | 対応する ID が見つかった場合に提供されることがあります。表示名。 |
| content.creatorInfo.iconUrl | string | 対応する ID が見つかった場合に提供されることがあります。アバター URL。 |
| content.creatorInfo.email | string | 対応する ID が見つかった場合に提供されることがあります。アカウントのメールアドレス。API Key の ID の場合は、その識別子が返されることがあります。 |
| content.creatorInfo.mobile | string | 対応する ID が見つかった場合に提供されることがあります。連絡先。 |
| content.creatorInfo.countryCode | string | 対応する ID が見つかった場合に提供されることがあります。電話番号の国または地域コード。 |
| content.creatorInfo.acntWsNickname | string | 対応する ID が見つかった場合に提供されることがあります。ワークスペース内のニックネーム。 |
| content.updatorInfo.uuid | string | 対応する ID が見つかった場合に提供されることがあります。ID 識別子。 |
| content.updatorInfo.status | integer | 対応する ID が見つかった場合に提供されることがあります。アカウントステータス。 |
| content.updatorInfo.wsAccountStatus | integer | 対応する ID が見つかった場合に提供されることがあります。ワークスペースメンバーステータス。 |
| content.updatorInfo.username | string | 対応する ID が見つかった場合に提供されることがあります。ログイン名。 |
| content.updatorInfo.name | string | 対応する ID が見つかった場合に提供されることがあります。表示名。 |
| content.updatorInfo.iconUrl | string | 対応する ID が見つかった場合に提供されることがあります。アバター URL。 |
| content.updatorInfo.email | string | 対応する ID が見つかった場合に提供されることがあります。アカウントのメールアドレス。API Key の ID の場合は、その識別子が返されることがあります。 |
| content.updatorInfo.mobile | string | 対応する ID が見つかった場合に提供されることがあります。連絡先。 |
| content.updatorInfo.countryCode | string | 対応する ID が見つかった場合に提供されることがあります。電話番号の国または地域コード。 |
| content.updatorInfo.acntWsNickname | string | 対応する ID が見つかった場合に提供されることがあります。ワークスペース内のニックネーム。 |
| content.old_name | string | 更新前の名前。 |
| content.dashboardBidding | object | バインディング条件オブジェクト。バインディングがない場合は空オブジェクトです。 |
| content.dashboardBidding.* | array<object> |
実際のソースフィールドごとに構成されたマッチ条件配列。 |
| content.dashboardBidding.*[].op | string | マッチ演算子。 |
| content.dashboardBidding.*[].value | array<string> |
マッチ値配列。 |
| content.tagInfo | array<object> |
組み込みビューでは現在、空の配列が返されます。 |
| content.declaration | object または null | ワークスペースのパブリック宣言。 |
{
"code": 200,
"content": {
"id": 72,
"uuid": "dsbd_inner_example",
"name": "主机详情内置视图 v2",
"desc": "根据主机查看运行状态",
"workspaceUUID": "wksp_example",
"identifier": "host-overview",
"ownerType": "inner",
"type": "CUSTOM",
"isPublic": 1,
"chartPos": [],
"chartGroupPos": [],
"iconSet": {},
"extend": {},
"mapping": [],
"dashboardBindSet": [],
"createdWay": "manual",
"openPermissionSet": false,
"permissionSet": [],
"readPermissionSet": [],
"status": 0,
"creator": "wsak_example",
"updator": "wsak_example",
"createAt": 1785427200,
"updateAt": 1785427320,
"deleteAt": -1,
"old_name": "主机详情内置视图",
"dashboardBidding": {
"host": [
{
"op": "in",
"value": [
"web-01"
]
}
]
},
"tagInfo": [],
"creatorInfo": {},
"updatorInfo": {},
"declaration": {}
},
"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.ForbiddenOperationResource | API Key に対象ビューの有効な操作権限がない | 操作権限がありません | ワークスペースの所属と API Key の権限を確認するか、リソースの作成者に問い合わせてください。 |
| 406 | ft.ParameterCheckFailed | ワークスペースが左ワイルドカードを制限しており、バインディング値が先頭 * のワイルドカード条件に一致 | クエリ設定のあいまい一致では左*マッチは現在サポートされていません | 値の先頭の * を削除するか、完全一致の値に変更してください。この制限は wildcard、またはフィールド名が *、-* で始まる条件に適用されます。単独の * ではこの検証はトリガーされません。エラーレスポンスの content は true です。 |
| 400 | ft.IdentificationIdExists | 識別子が同じワークスペース内の別の組み込みビューで使用されている | 識別子 ID は既に存在します | 未使用の識別子を選択するか、このフィールドを省略して元の値を保持してください。 |
| 400 | ft.ObjectParmeterExists | 新しい名前が現在のワークスペース内の別の組み込みビューで使用されている | {} は既に存在します |
まだ使用されていない名前に変更してください。 |