ExecuteBackupPlan API でバックアッププランを実行 - Cloud Backup

今すぐお試しください

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

create

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PlanId	string	必須	バックアッププランの ID です。	plan-*********************
VaultId	string	任意	バックアップボールトの ID です。	v-*********************
SourceType	string	任意	データソースのタイプ。有効な値: ECS_FILE: ECS ファイルをバックアップします。 OSS: Alibaba Cloud OSS をバックアップします。 NAS: Alibaba Cloud NAS をバックアップします。	ECS_FILE
RuleId	string	任意	バックアップルールの ID です。	rule-0002*****ux8
Edition	string	任意	エディション。有効な値: BASIC および STANDARD。デフォルト値: STANDARD。	STANDARD

レスポンスフィールド

フィールド	型	説明	例
	object
Code	string	リターンコード。値が 200 の場合は成功を示します。	200
Message	string	返されたメッセージ。リクエストが成功した場合、`successful` が返されます。リクエストが失敗した場合、エラーメッセージが返されます。	successful
RequestId	string	リクエスト ID です。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Success	boolean	リクエストが成功したかどうかを示します。 true: 成功 false: 失敗	true
JobId	string	バックアップジョブの ID です。	job-*********************

例

成功レスポンス

JSONJSON

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true,
  "JobId": "job-*********************"
}

エラーコード

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

変更履歴

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