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

*All Resource

*

なし

リクエスト構文

GET  HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
NextToken	string	任意	次の結果ページを取得するためのトークンです。このパラメーターを空のままにすると、すべての結果が返されます。	aWQj********MCMy
MaxResults	integer	任意	1 リクエストあたりに返すエントリの最大数です。有効値：10～100。デフォルト値：10。	10
CreatedByProduct	string	任意	リソースを保護するために使用されるプロダクトです。有効値： BASIC: File Backup Essential Edition。	BASIC
SourceType	string	任意	データソースタイプです。有効値： ECS_FILE: ECS ファイルバックアップ。	ECS_FILE
ResourceId	string	任意	リソース ID です。 `SourceType` が ECS_FILE に設定されている場合、このパラメーターは ECS インスタンス ID を指定します。	i-wz95************7zrd
Skip	integer	任意	ページングクエリでスキップするエントリ数です。この値が結果の総数を超えると、空のリストが返されます。値は `MaxResults` の倍数である必要があります。	10

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスボディ。
RequestId	string	リクエスト ID。	EB09**----******6C38
Code	string	HTTP ステータスコード。値が `200` の場合は、リクエストが成功したことを示します。	200
Message	string	レスポンスメッセージ。リクエストが成功した場合は `successful` が返され、失敗した場合はエラーメッセージが返されます。	successful
Success	boolean	リクエストが成功したかどうかを示します。 `true`：リクエストは成功しました。 `false`：リクエストは失敗しました。	true
TotalCount	integer	保護対象リソースの総数。	3
ProtectedResources	array<object>	保護対象リソースのリスト。
	object
SourceType	string	データソースのタイプです。 SourceType=ECS_FILE：データソースは ECS インスタンスです。	ECS_FILE
ResourceId	string	リソース ID。 SourceType=ECS_FILE：ECS インスタンスの ID です。	i-wz95************7zrd
ResourceOwnerId	integer	リソースのオーナーのユーザー UID。	1024********0703
CreatedByProduct	string	リソースを保護するプロダクト。有効値： BASIC: ECS File Backup Essential Edition。	BASIC
SnapshotCount	integer	バックアップ数。	30
ProtectedResourceId	string	保護対象リソースの ID。	pr-0004************gs61
ProtectedDataSize	integer	保護対象データのサイズ (バイト単位)。 SourceType=ECS_FILE：バックアップされたブロックストレージのサイズです。	107374182400
ResourceRegionId	string	リソースのリージョン ID。	cn-hangzhou
BackupPlanCount	integer	バックアッププランの数。	1
MaxResults	integer	各ページで返すエントリ数です。有効値：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="
}

エラーコード

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

変更履歴

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