コンテンツにスキップ

AWS Role クラウドアカウントの削除



POST /api/v1/cloud_account/{cloud_account_uuid}/do/delete

概要

現在のワークスペースにある AWS assume_role アカウントとそのコレクター設定を削除します。

呼び出し前と使用手順

対象ワークスペースの API Key を使用します。管理用4エントリには cloudAccount.accountManage が必要で、無料プランでは明示的に拒否されます。アカウントスコープは Key が所属するワークスペースです。一時認証情報の読み取りには別途 cloudAccount.temporaryCredentialsRead が必要で、管理権限には自動的に含まれません。プラットフォーム認可はこのワークスペースのブランドと cn/intl パーティションに従って選択され、他のブランドへフォールバックしません。すべてのレスポンスには Cache-Control: no-store、Pragma: no-cache が付与されます。

JSON の空オブジェクト {} を POST する必要があり、source/ワークスペース/プロバイダーなどの追加 Body フィールドは受け付けません。既存のコレクターおよび外部自動化が該当レコードに依存していないことを先に確認してください。先にアンインストール用コレクタースクリプトを配信し、その後コレクターとクラウドアカウント設定をソフト削除してコミットします。顧客の AWS IAM Role、許可/信頼ポリシーは削除せず、AWS が発行済みの一時認証情報も取り消しません。残りの有効期間中のアクセスを停止する必要がある場合は、顧客側で別途 AWS 認可を管理してください。

データベースと外部スクリプトのアンインストールはアトミックではありません。失敗時にはスクリプトが停止済みでも設定が削除されていない可能性があるため、まず設定と実際の収集タスクを照会してください。500 だけで「まったく変更されていない」と判断しないでください。存在しない/別ワークスペース/削除済みの場合は 404 を返します。重複リクエストを「操作なしの成功」として扱わないでください。利用できるのは AWS assume_role のみです。

ルートパラメーター

パラメーター名 型 必須 説明
cloud_account_uuid string Y パス必須。削除されていない AWS assume_role レコードである必要があります。顧客の Account ID、ロール ARN、または他のワークスペースの UUID は使用しません。
空文字列を許可: False
例: clac_example
取得または入力方法: クラウドアカウント一覧 の content.data[].uuid、または作成成功時の content.uuid から、現在のワークスペースの clac_ レコードを取得します。

リクエストヘッダー

パラメーター名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証情報。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

パラメーター補足説明

このワークスペースの AWS assume_role のみをサポートします。cloudAccount.accountManage が必要で、body は {} である必要があります。

削除は Front の動作を踏襲します。クラウドアカウントをソフト削除し、関連するコレクターとタスクを削除しますが、履歴の観測データや顧客の AWS IAM Role は削除しません。プライベート Func のキュー投入は、アンインストールが完了したことを意味しません。実行前にターゲット UUID と関連コレクターを確認してください。収集を保持する必要がある場合は削除を中止してください。

重複削除は元の「存在しない」エラーを返し、自動的に成功にはなりません。削除後に再作成すると新しい UUID/External ID が生成され、顧客は信頼ポリシーとコレクターを再設定する必要があり、以前のリクエスト結果を復元することはできません。顧客の Role は顧客自身が管理し、プラットフォームが AWS をまたいで自動ロールバックすることはありません。

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/cloud_account/clac_example/do/delete' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{}'

レスポンス

HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。

フィールド 型 説明
content.uuid string 削除されたクラウドアカウントの UUID。
content.declaration object 共通宣言。
レスポンスヘッダー 型 説明
Cache-Control string no-store。成功時およびこのブループリントのルートエラー時はいずれもキャッシュを禁止します。
Pragma string no-cache。
{
  "code": 200,
  "content": {
    "uuid": "clac_example",
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラー応答

認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。

公開宣言/認証層の失敗では、標準の content={} のみが返る場合があり、validationResult が必ず出現することを保証しません。管理用4エントリがビジネスアダプテーションに入った後、作成/変更の失敗時には安全操作結果が含まれる場合があります。その内部の通常の 5xx は一律で 500 ft.CodeError を自身で返し、content には今回の検証状態が保持され、グローバルに InternalServerError へ置き換えられることはありません。一時認証情報エントリでは、通常の未キャッチ例外のみがグローバル 500 ft.InternalServerError になります。HTTP や success だけを見ず、操作結果、検証結果、saved、および読み戻したレコードを組み合わせて判断する必要があります。

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
406 ft.ParameterValidationFailed リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している パラメーター解析失敗 パラメーターの位置、フィールド名、型、値を確認してください。
400 ft.RequestJsonFormatError リクエスト JSON の構文が無効 リクエスト JSON の形式エラー content.reason、line、column に従って JSON を修正してください。
400 ft.JsonFormatError Body のトップレベルが JSON オブジェクトではない 一部の json ファイル形式エラー 例に合致する JSON オブジェクトを送信してください。
403 ft.Forbidden 管理用4エントリが無料プランのワークスペースで明示的なバージョンチェックにより拒否された 操作権限がありません ワークスペースのバージョンと管理権限を確認し、該当する機能と認可を持つ対象ワークスペースに切り替えてください。
404 ft.CloudAccountNotFound 対象 UUID が現在のワークスペースの削除されていないクラウドアカウントの範囲にない クラウドアカウントが存在しません 現在のワークスペースの AWS Role クラウドアカウント一覧の content.data[].uuid から対象を再取得してください。この読み取りは書き込みロックを待機しません。
404 ft.InvalidCloudAccountType 渡されたレコードまたは対象レコードが AWS assume_role ではない 無効なクラウドアカウントタイプ 現在のワークスペースの専用クラウドアカウント一覧からレコードを取得してください。旧 accessKey/role および他のプロバイダーはこのエントリでは使用できません。
400 ft.ParamsValidateError JSON Body が空オブジェクト {} ではない、または履歴として保存済みの AWS assume_role 設定がアカウント/ロール/External ID の仕様に適合していない パラメーター検証失敗: {} リクエストでは {} のみを送信してください。履歴設定が不正な場合は、権限のあるクラウドアカウント管理フローで確認・修正してください。この API では dryRun/設定更新フィールドを渡さないでください。
429 ft.OperationTooFrequently 書き込みロックの競合/ロック消失、待機中に設定が他のリクエストによって変更された 操作が頻繁すぎます。しばらくしてから再試行してください 限定的なバックオフを行う前に UUID で読み戻し、古いスナップショットに基づいて新しい送信内容を上書きしないでください。作成結果が不明な場合は、まず Account ID に基づいて復旧してください。
500 ft.CodeError クラウドアカウント/履歴 JSON/コレクター情報の読み取り、またはプラットフォーム認可の表示で内部例外が発生した 内部処理エラー traceId と Query を保持し、履歴設定/データベースおよびプラットフォーム認可を確認してください。この読み取りでは収集スクリプトのデプロイや設定の書き込みは実行しません。

関連ドキュメント

フィードバック

このページは役に立ちましたか?