ECS インスタンスでの HBR クライアントの一括アップグレード - Cloud Backup

1 つ以上の Elastic Compute Service (ECS) インスタンス上の HBR クライアントをアップグレードします。

操作説明

この操作は、バックエンドで非同期ジョブを作成し、クラウドアシスタントを呼び出して、ECS インスタンスにインストールされている HBR クライアントをアップグレードします。
DescribeTask 操作を呼び出して、非同期ジョブの実行結果をクエリできます。
非同期ジョブのタイムアウト期間は 15 分です。

今すぐお試しください

この 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:UpgradeBackupClients

update

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceIds	object	任意	ECS インスタンスの ID。 ECS インスタンス ID と Cloud Backup クライアント ID の合計数は 100 を超えることはできません。	["c-*********************"]
ClientIds	object	任意	Cloud Backup クライアントの ID。 Cloud Backup クライアント ID と ECS インスタンス ID の合計数は 100 を超えることはできません。	["i-0xi5wj******3j3bh2gj5"]
CrossAccountType	string	任意	データが同一 Alibaba Cloud アカウント内でバックアップされるか、Alibaba Cloud アカウント間でバックアップされるかを指定します。有効な値： SELF_ACCOUNT：データは同一 Alibaba Cloud アカウント内でバックアップされます。 CROSS_ACCOUNT：データは Alibaba Cloud アカウント間でバックアップされます。	CROSS_ACCOUNT
CrossAccountUserId	integer	任意	現在の Alibaba Cloud アカウントに対し、アカウント間のデータバックアップを許可する、ソース Alibaba Cloud アカウントの ID。	1283948272xxxxx
CrossAccountRoleName	string	任意	クロスアカウントでのデータバックアップを現在の Alibaba Cloud アカウントに許可するために、ソース Alibaba Cloud アカウント内で作成され、現在の Alibaba Cloud アカウントに割り当てられた RAM ロールの名前。	hbrcrossrole

レスポンスフィールド

フィールド	型	説明	例
	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 インスタンスのステータス。ECS インスタンスのステータスが HBR クライアントのインストール要件を満たさず、`InstanceIds` パラメーターの値が 1 より大きい場合、このパラメーターに基づいてエラーメッセージが返されます。
	object
ValidInstance	boolean	HBR クライアントを ECS インスタンスにインストールできるかどうかを示します。有効な値： true：HBR クライアントは ECS インスタンスにインストールできます。 false：HBR クライアントは 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"
    }
  ]
}

エラーコード

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

変更履歴

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