すべてのプロダクト
Search
ドキュメントセンター

Backup and Disaster Recovery Center:DescribeRules

最終更新日:Jul 13, 2026

データ保護ルールのリストを照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

bdrc:DescribeRules

none

*すべてのリソース。

*

なし なし

リクエスト構文

GET /api/v1/rules HTTP/1.1

リクエストパラメーター

パラメーター

必須 / 任意

説明

ResourceType

string

任意

リソースタイプ。

ACS::ECS::Instance

NextToken

string

任意

次のクエリのトークンが存在するかどうかを示します。有効な値: NextToken が空の場合、これ以上の結果はありません。NextToken が返される場合、その値は次のクエリのトークンを示します。

cae**********699

MaxResults

integer

任意

ページングクエリの 1 ページあたりの最大エントリ数。最大値: 50。デフォルト値: 10。

10

ResourceCategoryId

string

任意

リソースカテゴリの ID。

rc-000***123

ResourceRegionId

string

任意

リソースのリージョン ID。

cn-hangzhou

ResourceOwnerIds

array

任意

integer

任意

123***7890

レスポンスフィールド

フィールド

説明

object

BaseResponse<ListResult>

Data

object

返されたデータ。

Content

array<object>

このリクエストで返されたレコードのコレクション。

object

RuleId

string

ルールの一意の ID。

rule-bp11ggd8wr762

ProductType

string

ルールが適用されるプロダクトタイプ。

ecs

ResourceType

string

ルールが適用されるリソースタイプ。

ACS::ECS::Instance

RuleTemplate

string

ルールテンプレート。

ecs-backup

CheckStatus

string

チェックステータス。有効な値:NOT_CHECKED (未チェック)、PASSED (合格)、FAILED (不合格)、CHECKING (チェック中)、CHECK_FAILED (チェック失敗)。

PASSED

CheckTime

integer

チェックが実行された日時を示す UNIX タイムスタンプ。

1704157635

TotalResourceCount

integer

チェックされたリソースの総数。

1

RiskyResourceCount

integer

リスクのあるリソースの数。

0

CheckFailedResourceCount

integer

チェックに失敗したリソースの数。

0

NextToken

string

現在の呼び出しが読み取りを開始する位置。空の値は、すべてのデータが読み取られたことを示します。

0975951c75d7b41464c8d08ae17043ca

MaxResults

integer

このリクエストで返されるレコードの最大値。

10

TotalCount

integer

リクエスト条件に一致するレコードの総数。このパラメーターはオプションであり、デフォルトでは返されない場合があります。

42

RequestId

string

リクエストの一意の識別子。

86DEBAC9-AB6A-59AB-9E5C-A540E579ECC9

成功レスポンス

JSONJSON

{
  "Data": {
    "Content": [
      {
        "RuleId": "rule-bp11ggd8wr762",
        "ProductType": "ecs",
        "ResourceType": "ACS::ECS::Instance",
        "RuleTemplate": "ecs-backup",
        "CheckStatus": "PASSED",
        "CheckTime": 1704157635,
        "TotalResourceCount": 1,
        "RiskyResourceCount": 0,
        "CheckFailedResourceCount": 0
      }
    ],
    "NextToken": "0975951c75d7b41464c8d08ae17043ca",
    "MaxResults": 10,
    "TotalCount": 42
  },
  "RequestId": "86DEBAC9-AB6A-59AB-9E5C-A540E579ECC9"
}

エラーコード

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

変更履歴

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