ListProtectedResources API による保護リソース一覧取得 - Cloud Backup - Alibaba Cloud -

保護されたリソースのリストを照会します。

今すぐお試しください

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

list

*すべてのリソース。

*

なし

リクエスト構文

GET  HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
NextToken	string	任意	次のページを取得するためのページネーショントークンです。このパラメーターが空の場合、後続のページはありません。	aWQj********MCMy
MaxResults	integer	任意	1回のクエリで返される結果の数です。値の範囲は 10～100 です。デフォルト値は 10 です。	10
CreatedByProduct	string	任意	リソースが属する製品機能です。有効な値は次のとおりです。 HBR：Cloud Backup の標準機能です。 BASIC：ECS File Backup Essential Edition です。	BASIC
SourceType	string	任意	バックアップ機能タイプです。有効な値は次のとおりです。 ECS_FILE：ECS ファイルバックアップです。 COMMON_FILE_SYSTEM：Cloud Parallel File Storage (CPFS) バックアップです。 COMMON_NAS：オンプレミス NAS バックアップです。 File：オンプレミスファイルバックアップです。 NAS：Alibaba Cloud NAS バックアップです。 OSS：OSS バックアップです。列挙値: NAS : NAS COMMON_FILE_SYSTEM : COMMON_FILE_SYSTEM ECS_FILE : ECS_FILE COMMON_NAS : COMMON_NAS File : File OSS : OSS	ECS_FILE
ResourceId	string	任意	リソース ID です。 SourceType=ECS_FILE：ECS インスタンス ID。 SourceType=COMMON_FILE_SYSTEM：CPFS データソース ID。 SourceType=COMMON_NAS：オンプレミス NAS データソース ID。 SourceType=File：ローカルサービスクライアント ID。 SourceType=NAS：Alibaba Cloud NAS ファイルシステム ID。 SourceType=OSS：OSS バケット。	i-wz95************7zrd
Skip	integer	任意	ページングでスキップするエントリ数です。スキップするエントリ数が条件に一致するエントリの総数を超えた場合、空のリストが返されます。スキップするエントリ数は、`MaxResults` の倍数である必要があります。	10
HasSnapshot	boolean	任意	リソースにバックアップポイントがあるかどうかを指定します。	true

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマです。
RequestId	string	リクエスト ID です。	EB09**----******6C38
Code	string	リターンコードです。値が「200」の場合は成功を示します。	200
Message	string	レスポンスメッセージです。リクエストが成功した場合は「successful」、失敗した場合はエラーメッセージが返されます。	successful
Success	boolean	リクエストが成功したかどうかを示します。 true ：リクエストの成功を示します。 false ：リクエストの失敗を示します。	true
TotalCount	integer	保護されたリソースの総数です。	3
ProtectedResources	array<object>	保護されたリソースのリストです。
	object	保護されたリソースです。
SourceType	string	バックアップ機能のタイプです。有効値： ECS_FILE ：ECS ファイルバックアップ。 COMMON_FILE_SYSTEM ：クラウド並列ファイルストレージ (CPFS) バックアップ。 COMMON_NAS ：オンプレミス NAS バックアップ。 File ：オンプレミスファイルバックアップ。 NAS ：Alibaba Cloud NAS バックアップ。 OSS ：OSS バックアップ。	ECS_FILE
ResourceId	string	リソース ID です。 SourceType=ECS_FILE ：ECS インスタンス ID です。 SourceType=COMMON_FILE_SYSTEM ：CPFS データソース ID です。 SourceType=COMMON_NAS ：オンプレミス NAS データソース ID です。 SourceType=File ：ローカルサービスクライアント ID です。 SourceType=NAS ：Alibaba Cloud NAS ファイルシステム ID です。 SourceType=OSS ：OSS バケットです。	i-wz95************7zrd
ResourceOwnerId	integer	リソース所有者の UID です。	1024********0703
CreatedByProduct	string	リソースが属する製品機能です。有効値： HBR ：Cloud Backup の標準機能です。 BASIC ：ECS File Backup Essential Edition です。	BASIC
SnapshotCount	integer	バックアップ数です。	30
ProtectedResourceId	string	保護されたリソースの ID です。	pr-0004************gs61
ProtectedDataSize	integer	保護されているデータ量です (単位：バイト)。現在、このパラメーターは ECS File Backup Essential Edition でのみサポートされます。 SourceType=ECS_FILE ：バックアップされたブロックストレージ容量です。	107374182400
ResourceRegionId	string	リソースのリージョン ID です。	cn-hangzhou
BackupPlanCount	integer	バックアッププランの数です。	1
MaxResults	integer	1 回のクエリで返されるエントリ数です。有効値：10～100。デフォルト値：10。	10
NextToken	string	ページネーショントークンです。このパラメーターが空の場合、後続のページはありません。	eyJJ************MX0=

例

成功レスポンス

JSONJSON

{
  "RequestId": "EB09****-****-****-****-********6C38",
  "Code": "200",
  "Message": "successful",
  "Success": true,
  "TotalCount": 3,
  "ProtectedResources": [
    {
      "SourceType": "ECS_FILE",
      "ResourceId": "i-wz95************7zrd",
      "ResourceOwnerId": 0,
      "CreatedByProduct": "BASIC",
      "SnapshotCount": 30,
      "ProtectedResourceId": "pr-0004************gs61",
      "ProtectedDataSize": 107374182400,
      "ResourceRegionId": "cn-hangzhou",
      "BackupPlanCount": 1
    }
  ],
  "MaxResults": 10,
  "NextToken": "eyJJ************MX0="
}

エラーコード

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

変更履歴

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