変更¶
POST /api/v1/viewer/{viewer_uuid}/modify
概要¶
既存のエクスプローラーの表示情報、拡張設定、タグ、またはバインドを変更します。
呼び出し前の確認と使用手順¶
まずエクスプローラー詳細で現在の内容を確認してください。変更が必要なフィールドのみを送信してください。extend、tagNames、dashboardBindSet を送信すると、フィールド全体が置き換えられます。tagNames=[] を指定すると、既存の関連付けをクリアします。tagNames を送信しない場合、元のタグは保持されます。レスポンスの tagInfo は空配列になる場合があるため、詳細で確認できます。同じエクスプローラーの設定更新は直列に実行することを推奨します。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| viewer_uuid | string | Y | 現在のワークスペースにある対象エクスプローラーの UUID。 例: dsbd_view_example取得または入力方法: エクスプローラー一覧 の content.data[].uuid から取得します。作成レスポンスの content.uuid を使用することもできます。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得してください。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| name | string | エクスプローラー名。最大 64 文字。 null を許可: False 最大長: 64 例: 主机巡检查看器取得または入力方法: このワークスペース内で他のエクスプローラーに使用されていない名前を選択してください。 |
|
| desc | string | エクスプローラーの説明。最大 2048 文字。 null を許可: False 空文字列を許可: True 最大長: 2048 例: 主机巡检与状态核对取得または入力方法: このエクスプローラーの用途を記述します。空文字列はクリアに使用します。 |
|
| type | string | エクスプローラーのタイプ。 null を許可: False 最大長: 32 例: CUSTOM取得または入力方法: 通常は CUSTOM を使用します。変更時は詳細の content.type から取得してそのまま使用できます。 |
|
| extend | json | エクスプローラーの拡張情報。送信時は完全なオブジェクトを使用します。 null を許可: False 例: {}取得または入力方法: エクスプローラー詳細の content.extend またはテンプレートの dashboardExtend から取得します。 |
|
| pathName | string | 互換性のためのパス名。現在のエクスプローラーエンティティでは、このフィールドを個別に保存していません。 null を許可: False 最大長: 32 例: host取得または入力方法: 旧クライアントではこのフィールドが含まれる場合があります。新規接続では省略を推奨します。 |
|
| tagNames | array | 完全なタグ一覧。[] を渡すとクリアします。 null を許可: False 例: ["team:ops"]取得または入力方法: 既存のエクスプローラー詳細 の content.tagInfo[].name からコピーするか、関連付けるユースケースタグを入力してください。 |
|
| tagNames[*] | string | 個々のタグ名。最大 128 文字。 null を許可: False 最大長: 128 例: team:ops取得または入力方法: 既存のエクスプローラー詳細 の content.tagInfo[].name からコピーするか、関連付けるユースケースタグを入力してください。 |
|
| dashboardBindSet | array | 保存するエクスプローラーのバインド済みビュー情報の配列。 null を許可: False 空文字列を許可: False 例: []取得または入力方法: エクスプローラー詳細の content.dashboardBindSet から完全なバインド一覧を取得します。バインドが不要な場合は空のリストを送信できます。 |
パラメータ補足説明¶
フィールドを省略した場合は現在値が保持されます。更新後に詳細を呼び出して設定を確認できます。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/viewer/dsbd_view_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 | エクスプローラーリソースの所属。通常は viewer です。 |
| 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.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.creatorInfo.uuid | string | 対応するアイデンティティが見つかった場合に提供されることがあります。アイデンティティ識別子。 |
| content.creatorInfo.status | integer | 対応するアイデンティティが見つかった場合に提供されることがあります。アカウントステータス。 |
| content.creatorInfo.wsAccountStatus | integer | 対応するアイデンティティが見つかった場合に提供されることがあります。ワークスペースメンバーステータス。 |
| content.creatorInfo.username | string | 対応するアイデンティティが見つかった場合に提供されることがあります。ログイン名。 |
| content.creatorInfo.name | string | 対応するアイデンティティが見つかった場合に提供されることがあります。表示名。 |
| content.creatorInfo.iconUrl | string | 対応するアイデンティティが見つかった場合に提供されることがあります。アバター URL。 |
| content.creatorInfo.email | string | 対応するアイデンティティが見つかった場合に提供されることがあります。アカウントのメールアドレス。API Key アイデンティティの場合は、その識別子が返されることがあります。 |
| content.creatorInfo.mobile | string | 対応するアイデンティティが見つかった場合に提供されることがあります。連絡先。 |
| content.creatorInfo.countryCode | string | 対応するアイデンティティが見つかった場合に提供されることがあります。電話番号の国または地域コード。 |
| content.creatorInfo.acntWsNickname | string | 対応するアイデンティティが見つかった場合に提供されることがあります。ワークスペース内のニックネーム。 |
| content.updatorInfo.uuid | string | 対応するアイデンティティが見つかった場合に提供されることがあります。アイデンティティ識別子。 |
| content.updatorInfo.status | integer | 対応するアイデンティティが見つかった場合に提供されることがあります。アカウントステータス。 |
| content.updatorInfo.wsAccountStatus | integer | 対応するアイデンティティが見つかった場合に提供されることがあります。ワークスペースメンバーステータス。 |
| content.updatorInfo.username | string | 対応するアイデンティティが見つかった場合に提供されることがあります。ログイン名。 |
| content.updatorInfo.name | string | 対応するアイデンティティが見つかった場合に提供されることがあります。表示名。 |
| content.updatorInfo.iconUrl | string | 対応するアイデンティティが見つかった場合に提供されることがあります。アバター URL。 |
| content.updatorInfo.email | string | 対応するアイデンティティが見つかった場合に提供されることがあります。アカウントのメールアドレス。API Key アイデンティティの場合は、その識別子が返されることがあります。 |
| content.updatorInfo.mobile | string | 対応するアイデンティティが見つかった場合に提供されることがあります。連絡先。 |
| content.updatorInfo.countryCode | string | 対応するアイデンティティが見つかった場合に提供されることがあります。電話番号の国または地域コード。 |
| content.updatorInfo.acntWsNickname | string | 対応するアイデンティティが見つかった場合に提供されることがあります。ワークスペース内のニックネーム。 |
| content.old_name | string | 更新前の名前。 |
| content.dashboardBidding | object | 返却されるビュー関連設定。空の場合があります。 |
| content.declaration | object または null | ワークスペースの公開宣言。 |
{
"code": 200,
"content": {
"id": 25,
"uuid": "dsbd_view_example",
"name": "主机巡检查看器 v2",
"desc": "主机巡检与状态核对",
"workspaceUUID": "wksp_example",
"identifier": "",
"ownerType": "viewer",
"type": "CUSTOM",
"isPublic": 1,
"chartPos": [],
"chartGroupPos": [],
"iconSet": {},
"extend": {},
"mapping": [],
"dashboardBindSet": [],
"createdWay": "manual",
"openPermissionSet": false,
"permissionSet": [],
"readPermissionSet": [],
"tagInfo": [],
"status": 0,
"creator": "wsak_example",
"updator": "wsak_example",
"createAt": 1785427200,
"updateAt": 1785427320,
"deleteAt": -1,
"old_name": "主机巡检查看器",
"dashboardBidding": {},
"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 を再確認してください。 |
| 400 | ft.TagScopeMismatch | 同名のタグが既に存在するが、スコープがユースケースと互換性がない | メッセージにはタグ名、既存および対象のスコープが含まれます。 | ユースケースタグまたは汎用タグに変更してください。 |
| 400 | ft.ObjectParmeterExists | 新しい名前が現在のワークスペース内の他のエクスプローラーで使用されている | {} は既に存在します |
未使用のエクスプローラー名を選択してください。 |