スナップショット/チャート共有の取り消し¶
GET /api/v1/share_config/delete
概要¶
GET を使用して、指定した共有設定と初回遷移認証情報を取り消します。
呼び出し前の前提条件と使用手順¶
現在のキーには share.shareManage が必要です。GET ですが、この API は状態を変更してアクセスを取り消すため、プリフェッチや定期的なヘルスチェックには使用しないでください。shareConfigUUIDs は、現在のコンソールの共有管理リストから現在のワークスペースの share_ UUID を取得します。スナップショットの snap_、token/authCode、共有 URL ではありません。複数の UUID はカンマで区切り、各項目の trim は行いません。
この共有削除エンドポイントは resourceType=snapshot に限定されず、同一ワークスペース内の他のチャート/ダッシュボード共有も削除できます。呼び出し元は事前に resourceType と resourceUUID を確認する必要があります。現在のワークスペース内の未削除かつ一致する設定のみをソフト削除し、不明な設定、別ワークスペースの設定、削除済みの設定は無視されます。通常は true を返し、項目ごとの結果は返しません。
最初に共有削除をコミットし、その後、長期有効な初回遷移コードとキャッシュを取り消し、二段階の share token キャッシュをクリアします。失敗した場合、共有がすでに無効化されているか、一部のキャッシュクリアがまだ完了していない可能性があります。まずコンソールで共有状態を確認し、実際にアクセスして受け入れ確認を行ってください。500 をロールバックによる取り消しと見なさないでください。元のスナップショット、ダッシュボード、テレメトリは削除されません。再共有すると新しい設定とコードが生成され、以前の URL の復元は保証されません。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| shareConfigUUIDs | commaArray | Y | 必須の空でないカンマ区切り文字列で、JSON 配列ではありません。各共有のタイプを事前に確認し、他のリソース共有を誤って取り消さないようにしてください。前後の空白は項目ごとに trim されません。 空文字列を許可: False null を許可: False 例: share_example取得または入力方法: 現在のコンソールの共有管理リストから共有設定 uuid( share_)を取得し、resourceType=snapshot と対象の resourceUUID を確認します。この OpenAPI グループには ShareConfig リストがないため、UI に UUID が表示されない場合はワークスペース管理者に取得を依頼してください。別ワークスペースの認可設定 grant_ UUID は使用できません。 |
パラメータ補足説明¶
スナップショットはページ設定とサーバー側のクエリ範囲を保存します。インターネット共有では別途共有設定を作成する必要があり、snap_、share_、初回遷移コード、二段階 token はそれぞれ異なる識別子です。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/share_config/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode shareConfigUUIDs=share_example
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | 成功時は true、一致するものがない場合も通常は true です。declaration/項目ごとの結果は含まれません。 |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、共通リクエストエラーの詳細は共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたは応答の説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 宣言されていない Query パラメータを使用した、またはパラメータがルールに違反している | パラメータの解析に失敗しました | Query パラメータ表と例を確認してください。 |
| 500 | ft.InternalServerError | 共有のソフト削除、後続の初回遷移コード取り消し/二段階 token キャッシュクリア、または監査資料インデックスで未処理の例外が発生した | 内部エラー | まずコンソールで共有設定の状態を確認し、旧リンクが無効になっているか検証してください。本体はすでに削除されている可能性があります。traceId を保持して認証情報キャッシュの照合を完了し、共有を重複して作成しないでください。 |