DescribeBackupMachineStatus を使用してサーバーのバックアップステータスをクエリ - Security Center - Alibaba Cloud - Security Center

ランサムウェア対策バックアップポリシーに関連付けられたサーバーのバックアップステータスを照会します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

yundun-sas:DescribeBackupMachineStatus

get

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PolicyId	integer	必須	ランサムウェア対策バックアップポリシーの ID。説明このパラメーターを取得するには、 DescribeBackupPolicies 操作を呼び出します。	123
Uuid	string	必須	クエリするサーバーの UUID。説明このパラメーターを取得するには、 DescribeBackupPolicy 操作を呼び出します。	eb2c782e-64f2-4590-a86c-d90164df****
PolicyVersion	string	任意	軽減ポリシーのバージョン。有効な値: 1.0.0: 軽減ポリシーのバージョンは 1.0.0 です。 2.0.0: 軽減ポリシーのバージョンは 2.0.0 です。	2.0.0

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエスト ID。Alibaba Cloud は各リクエストに一意の識別子を生成します。リクエスト ID を使用して問題のトラブルシューティングを行えます。	09969D2C-4FAD-429E-BFBF-9A60DEF8****
BackupMachineStatus	object	サーバーのバックアップステータス。
Status	string	ランサムウェア対策クライアントのステータス。有効な値: NOT_INSTALLED: 未インストール。 CLIENT_CONNECTION_ERROR: クライアントのステータスが異常です。 ACTIVATED: 正常。 INSTALLING: クライアントのインストール中です。このステータスは、通常、ポリシーがサーバーに初めてバインドされた後に表示されます。	ACTIVATED
Uuid	string	サーバーの UUID。	eb2c782e-64f2-4590-a86c-d90164df****
VaultId	string	バックアップデータが保存されるボールトの ID。	v-0005i2qh5fcr6seo****
ErrorCode	string	異常なステータスに対して返されるエラーコード。	CLIENT_CONNECTION_ERROR
SavedBackupCount	integer	復元可能なバージョンの数。	7
InstanceId	string	サーバーインスタンスの ID。	i-2zeaqkb80vloxjcj****
ClientStatus	string	サービスステータス。有効な値: ONLINE: 正常。 CLIENT_CONNECTION_ERROR: クライアント接続が異常です。 UNINSTALLING: アンインストール中。 UNINSTALL_FAILED: アンインストールに失敗しました。 UPGRADING: アップグレード中。 UPGRADE_FAILED: アップグレードに失敗しました。 INSTALLING: クライアントのインストール中です。このステータスは、通常、ポリシーがサーバーに初めてバインドされた後に表示されます。	ONLINE
RegionId	string	サーバーのリージョン ID。	cn-shenzhen
ClientVersion	string	ランサムウェア対策クライアントのバージョン番号。	2.11.0
ClientId	string	ランサムウェア対策クライアントの ID。	c-000dbefaw9f7gnbw****
ErrorList	array<object>	バックアップサーバーによって報告されたエラーメッセージのリスト。
	object	バックアップサーバーによって報告されたエラー情報。
ErrorCode	string	エラーコード。	TARGET_NOT_EXIST
ErrorStatus	string	エラーステータス情報。	FAILED
ServiceStatus	string	サービスステータス。有効な値: SERVICE_EXCEPTION: サービス例外。 RESTORING: 復元中。 BACKING_UP: バックアップ中。	RESTORING

例

成功レスポンス

JSONJSON

{
  "RequestId": "09969D2C-4FAD-429E-BFBF-9A60DEF8****",
  "BackupMachineStatus": {
    "Status": "ACTIVATED",
    "Uuid": "eb2c782e-64f2-4590-a86c-d90164df****",
    "VaultId": "v-0005i2qh5fcr6seo****",
    "ErrorCode": "CLIENT_CONNECTION_ERROR",
    "SavedBackupCount": 7,
    "InstanceId": "i-2zeaqkb80vloxjcj****",
    "ClientStatus": "ONLINE",
    "RegionId": "cn-shenzhen",
    "ClientVersion": "2.11.0",
    "ClientId": "c-000dbefaw9f7gnbw****",
    "ErrorList": [
      {
        "ErrorCode": "TARGET_NOT_EXIST",
        "ErrorStatus": "FAILED"
      }
    ],
    "ServiceStatus": "RESTORING"
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
500	ServerError	ServerError
403	NoPermission	caller has no permission

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

変更履歴

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