API による ECS バックアップクライアントの自動削除 - Cloud Backup

1 つ以上の Elastic Compute Service (ECS) インスタンスから Cloud Backup クライアントをアンインストールします。

操作説明

この操作は、バックエンドで非同期タスクを作成し、クラウドアシスタントを呼び出して ECS インスタンスからバックアップクライアントをアンインストールします。
DescribeTask 操作を呼び出して、非同期タスクの実行結果をクエリできます。
非同期タスクのタイムアウト期間は 15 分です。 UninstallBackupClients 操作を呼び出してバックアップクライアントをアンインストールした後、30 秒待ってから DescribeTask 操作で最初のクエリを実行することを推奨します。その後は 30 秒間隔でクエリを再実行してください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

hbr:UninstallBackupClients

update

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceIds	object	任意	ECS インスタンスの ID。最大 20 個の ECS インスタンスを指定できます。	["i-0xi5wj5*****v3j3bh2gj5"]
ClientIds	object	任意	Cloud Backup クライアントの ID。 Cloud Backup クライアントの ID と ECS インスタンスの ID は、合計で 20 を超えることはできません。超えた場合、エラーが発生します。	["c-*********************"]
CrossAccountType	string	任意	データが同じ Alibaba Cloud アカウント内でバックアップおよび復元されるか、Alibaba Cloud アカウント間でバックアップおよび復元されるかを指定します。有効な値： SELF_ACCOUNT：データは同じ Alibaba Cloud アカウント内でバックアップおよび復元されます。 CROSS_ACCOUNT：データは Alibaba Cloud アカウント間でバックアップおよび復元されます。	CROSS_ACCOUNT
CrossAccountUserId	integer	任意	現在の Alibaba Cloud アカウントに対し、クロスアカウントでのデータバックアップ・復元を許可する、ソース Alibaba Cloud アカウントの ID。	129349237xxxxx
CrossAccountRoleName	string	任意	現在の Alibaba Cloud アカウントにクロスアカウントでのデータバックアップ・復元権限を付与するために、ソース Alibaba Cloud アカウントで作成・割り当てられた RAM ロールの名前。	BackupRole

レスポンスフィールド

フィールド	型	説明	例
	object
Code	string	HTTP ステータスコード。ステータスコード 200 は、リクエストが成功したことを示します。	200
Message	string	返されるメッセージ。リクエストが成功した場合、「successful」という値が返されます。リクエストが失敗した場合、エラーメッセージが返されます。	successful
RequestId	string	リクエストの ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TaskId	string	非同期タスクの ID。 DescribeTask 操作を呼び出して、非同期タスクの実行結果をクエリできます。	t-*********************
Success	boolean	リクエストが成功したかどうかを示します。 true：リクエストは成功です。 false：リクエストは失敗です。	true
InstanceStatuses	array<object>	ECS インスタンスのステータス。
	object
ValidInstance	boolean	バックアップクライアントを ECS インスタンスにインストールできるかどうかを示します。 true：バックアップクライアントを ECS インスタンスにインストールできます。 false：バックアップクライアントを ECS インスタンスにインストールできません。	true
InstanceId	string	ECS インスタンスの ID。	i-0xi5w***v3j3bh2gj5
ErrorCode	string	エラーコード。有効な値：値が空の場合は、リクエストが成功したことを示します。 InstanceNotExists：ECS インスタンスが存在しません。 InstanceNotRunning：ECS インスタンスが実行されていません。 CloudAssistNotRunningOnInstance：クラウドアシスタントが利用できません。	InstanceNotExists

例

成功レスポンス

JSONJSON

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TaskId": "t-*********************",
  "Success": true,
  "InstanceStatuses": [
    {
      "ValidInstance": true,
      "InstanceId": "i-0xi5w***v3j3bh2gj5",
      "ErrorCode": "InstanceNotExists"
    }
  ]
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。