すべてのプロダクト
Search

このプロダクト

    :DescribeVaults

    ドキュメントセンター

    :DescribeVaults

    最終更新日:Dec 16, 2025

    指定された条件を満たす 1 つ以上のバックアップボールトを照会します。

    今すぐお試しください

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

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    VaultId

    string

    任意

    バックアップボールトの ID。

    v-*********************
    VaultRegionId

    string

    任意

    バックアップボールトが存在するリージョンの ID。

    cn-shanghai
    Status

    string

    任意

    バックアップボールトのステータス。

    • UNKNOWN：ステータスは不明です。

    • INITIALIZING：バックアップボールトは初期化中です。

    • CREATED：バックアップボールトは作成済みです。

    • ERROR：エラーが発生しました。

    CREATED
    PageNumber

    integer

    任意

    ページ番号。ページは 1 から始まります。デフォルト値：1。

    1
    PageSize

    integer

    任意

    1 ページあたりのエントリ数。有効値：1～99。デフォルト値：10。

    10
    VaultType

    string

    任意

    バックアップボールトのタイプ。有効な値：

    • STANDARD：標準バックアップボールト。このタイプのボールトは、Elastic Compute Service (ECS) のファイルバックアップ、Object Storage Service (OSS) のバックアップ、および NAS バックアップに使用できます。

    • OTS_BACKUP：Tablestore バックアップボールト。このタイプのボールトは Tablestore のバックアップにのみ使用できます。Tablestore ではこのタイプのボールトが必要です。

    STANDARD
    Tag

    array<object>

    任意

    タグ。最大 20 個のタグを指定できます。

    6a745bceffb042959b3b5206d6f12ad1

    object

    任意

    タグ情報。

    Key

    string

    任意

    タグキー。

    key1
    Value

    string

    任意

    タグ値。

    value1
    ResourceGroupId

    string

    任意

    リソースグループの ID。

    rg-*********************
    VaultName

    string

    任意

    バックアップボールトの名前。名前の長さは 1～64 文字である必要があります。

    vaultname

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    Success

    boolean

    リクエストが成功したかどうかを示します。

    • true：リクエストは成功しました。

    • false：リクエストは失敗しました。

    true
    Code

    string

    リターンコード。値が 200 の場合は、リクエストが成功したことを示します。

    200
    Message

    string

    返されるメッセージ。リクエストが成功した場合、「successful」が返されます。リクエストが失敗した場合、エラーメッセージが返されます。

    successful
    PageNumber

    integer

    ページ番号。ページは 1 から始まります。デフォルト値：1。

    1
    PageSize

    integer

    1 ページあたりのエントリ数。有効値：1～99。デフォルト値：10。

    10
    TotalCount

    integer

    返されたバックアップボールトの総数。

    8
    Vaults

    object

    Vault

    array<object>

    バックアップボールトのリスト。

    {'Vault': []}

    array<object>

    バックアップボールトのリスト。

    Status

    string

    バックアップボールトのステータス。

    • UNKNOWN：ステータスは不明です。

    • INITIALIZING：バックアップボールトは初期化中です。

    • CREATED：バックアップボールトは作成済みです。

    • ERROR：エラーが発生しました。

    CREATED
    VaultId

    string

    バックアップボールトの ID。

    v-*********************
    ChargeType

    string

    バックアップボールトの課金方法。

    FREE
    VaultType

    string

    バックアップボールトのタイプ。値は STANDARD に固定されており、標準バックアップボールトを示します。

    STANDARD
    Dedup

    boolean

    データ重複除去が有効になっているかどうかを示します。

    true
    ReplicationSourceVaultId

    string

    地理的冗長性のソースボールトの ID。

    v-*********************
    IndexUpdateTime

    integer

    インデックスが更新された時刻。

    1639645628
    Description

    string

    ボールトの説明。

    vault description
    VaultStorageClass

    string

    バックアップボールトのストレージクラス。値は STANDARD に固定されており、標準ストレージを示します。

    STANDARD
    Retention

    integer

    バックアップボールトの保持期間 (日数)。

    2
    CreatedTime

    integer

    バックアップボールトが作成された時刻。この値は UNIX タイムスタンプです。単位：秒。

    1554347313
    IndexLevel

    string

    インデックスレベル。

    • OFF：インデックスは作成されません。

    • META：メタデータインデックスが作成されます。

    • ALL：フルテキストインデックスが作成されます。

    OFF
    VaultName

    string

    バックアップボールトの名前。

    vaultname
    StorageSize

    integer

    バックアップボールトのストレージ使用量。単位：バイト。

    10
    LatestReplicationTime

    integer

    最後の地理的冗長性同期の時刻。この値は UNIX タイムスタンプです。単位：秒。

    1554347313
    VaultStatusMessage

    string

    地理的冗長ボールトのエラーメッセージ。このパラメーターは、地理的冗長ボールトに対してのみ有効です。有効な値：

    • UNKNOWN_ERROR：不明なエラーが発生しました。

    • SOURCE_VAULT_ALREADY_HAS_REPLICATION：ソースボールトに別のイメージリポジトリがすでに設定されています。

    SOURCE_VAULT_ALREADY_HAS_REPLICATION
    Replication

    boolean

    ボールトが地理的冗長ボールトであるかどうかを示します。

    • true：ボールトは地理的冗長ボールトです。

    • false：ボールトはローカルバックアップボールトです。

    false
    ReplicationSourceRegionId

    string

    地理的冗長ボールトのソースボールトが存在するリージョンの ID。このパラメーターは、地理的冗長ボールトに対してのみ有効です。

    cn-shanghai
    VaultRegionId

    string

    バックアップボールトが存在するリージョンの ID。

    cn-shanghai
    UpdatedTime

    integer

    バックアップボールトが更新された時刻。この値は UNIX タイムスタンプです。単位：秒。

    1554347313
    ResourceGroupId

    string

    リソースグループの ID。

    rg-*********************
    BucketName

    string

    バックアップボールトが使用する OSS バケットの名前。

    hbr-0005i51******t58
    SearchEnabled

    boolean

    バックアップ検索が有効になっているかどうかを示します。

    true
    IndexAvailable

    boolean

    インデックスが利用可能かどうかを示します。インデックスは更新中でない場合に利用可能です。

    true
    BytesDone

    integer

    バックアップデータサイズ。単位：バイト。

    20
    Tags

    object

    Tag

    array<object>

    バックアップボールトのタグ。

    object

    バックアップボールトのタグ。

    Key

    string

    ボールトのタグキー。

    • タグキーは aliyun または acs: で始めることはできません。

    • タグキーに http:// または https:// を含めることはできません。

    • タグキーを空の文字列にすることはできません。

    aaa
    Value

    string

    ボールトのタグ値。

    • タグ値は aliyun または acs: で始めることはできません。

    • タグ値に http:// または https:// を含めることはできません。

    • タグ値を空の文字列にすることはできません。

    a1
    SourceTypes

    object

    SourceType

    array

    バックアップボールトにバックアップされるデータソースのタイプ。

    string

    データソースのタイプ。

    ECS_FILE
    ReplicationProgress

    object

    イメージリポジトリのデータ同期の進捗。

    HistoricalReplicationProgress

    integer

    イメージリポジトリ内の既存データの同期の進捗。有効値：0～100。

    100
    NewReplicationProgress

    integer

    イメージリポジトリ内の増分データの最終同期時刻。

    1579413159
    BackupPlanStatistics

    object

    バックアップボールトのバックアッププランの統計。

    Oracle

    integer

    Oracle バックアッププランの数。

    1
    LocalFile

    integer

    オンプレミスサーバーのバックアッププランの数。

    1
    Nas

    integer

    NAS バックアッププランの数。

    1
    CommonNas

    integer

    汎用 NAS のバックアッププランの数。

    1
    Isilon

    integer

    Isilon バックアッププランの数。

    1
    Oss

    integer

    OSS バックアッププランの数。

    1
    SqlServer

    integer

    SQL Server バックアッププランの数。

    1
    Csg

    integer

    Cloud Storage Gateway (CSG) バックアッププランの数。

    1
    EcsFile

    integer

    ECS ファイルバックアッププランの数。

    1
    MySql

    integer

    MySQL バックアッププランの数。

    1
    EcsHana

    integer

    SAP HANA バックアッププランの数。

    1
    LocalVm

    integer

    オンプレミス仮想マシンのバックアッププランの数。

    1
    Ots

    integer

    Tablestore バックアッププランの数。

    1
    Archive

    integer

    アーカイブプランの数。

    1
    CommonFileSystem

    integer

    CPFS バックアッププランの数。

    1
    TrialInfo

    object

    無料トライアルのプロパティ。

    TrialStartTime

    integer

    無料トライアルの開始時刻。

    1579413159
    TrialVaultReleaseTime

    integer

    無料トライアルボールトがリリースされる時刻。

    1594965600
    TrialExpireTime

    integer

    無料トライアルの有効期限。

    1584597600
    KeepAfterTrialExpiration

    boolean

    無料トライアル終了後、ボールトが従量課金ボールトに変換されるかどうかを示します。

    true
    EncryptType

    string

    バックアップボールトの暗号化タイプ。

    • NONE：バックアップボールトは暗号化されません。

    • HBR_PRIVATE：バックアップボールトは HBR が提供するキーを使用して暗号化されます。これがデフォルト値です。

    • KMS：バックアップボールトは Key Management Service (KMS) のキーを使用して暗号化されます。

    HBR_PRIVATE
    WormEnabled

    boolean

    バックアップロックが有効になっているかどうかを示します。

    true
    SnapshotCount

    integer

    ボールト内のスナップショットの数。

    0
    CompressionAlgorithm

    string

    バックアップボールトに使用される圧縮アルゴリズム。有効な値：

    • DISABLED：データは圧縮されません。

    • SNAPPY：データは SNAPPY アルゴリズムを使用して圧縮されます。

    • ZSTD：データは高速な可逆圧縮アルゴリズムである Zstandard アルゴリズムを使用して圧縮されます。

    ZSTD
    RedundancyType

    string

    バックアップボールトのデータ冗長タイプ。有効な値：

    • LRS：ローカル冗長ストレージ (LRS)。HBR は、各オブジェクトの冗長データを同じゾーン内の複数のデバイスに保存し、ハードウェア障害が発生した場合のデータの耐久性と可用性を確保します。

    • ZRS：ゾーン冗長ストレージ (ZRS)。HBR はマルチゾーンメカニズムを使用して、ユーザーデータを同じリージョン内の 3 つのゾーンに分散させます。これにより、ゾーンが利用できなくなった場合でもデータにアクセスできることが保証されます。

    LRS
    KmsKeyId

    string

    KMS で暗号化に使用されるカスタマーマスターキー (CMK) または CMK のエイリアス。このパラメーターは、EncryptType を KMS に設定した場合にのみ必須です。

    alias/acs/acm
    ChargedStorageSize

    integer

    アーカイブボールトの課金容量。単位：バイト。

    1024000
    ArchiveStorageSize

    integer

    アーカイブ層の課金容量。単位：バイト。

    1024000
    ArchiveBytesDone

    integer

    アーカイブ層のバックアップデータサイズ。単位：バイト。

    1024000
    ReplicationSourceVault

    boolean

    ボールトが地理的冗長ボールトのソースボールトであるかどうかを示します。

    • true：ボールトは地理的冗長ボールトのソースボールトです。

    • false：ボールトは地理的冗長ボールトのソースボールトではありません。

    false
    ReplicationTargetRegionId

    string

    地理的冗長ボールトのターゲットリージョン。

    cn-shanghai
    VaultOwnerId

    integer

    ReplicationTargetVaultId

    string

    ReplicationSourceOwnerId

    integer

    ReplicationTargetOwnerId

    integer

    ReplicationStatus

    string

    RsTargetAccountIds

    object

    RsTargetAccountId

    array

    integer

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 8,
  "Vaults": {
    "Vault": [
      {
        "Status": "CREATED",
        "VaultId": "v-*********************",
        "ChargeType": "FREE",
        "VaultType": "STANDARD",
        "Dedup": true,
        "ReplicationSourceVaultId": "v-*********************",
        "IndexUpdateTime": 1639645628,
        "Description": "vault description",
        "VaultStorageClass": "STANDARD",
        "Retention": 2,
        "CreatedTime": 1554347313,
        "IndexLevel": "OFF",
        "VaultName": "vaultname",
        "StorageSize": 10,
        "LatestReplicationTime": 1554347313,
        "VaultStatusMessage": "SOURCE_VAULT_ALREADY_HAS_REPLICATION",
        "Replication": false,
        "ReplicationSourceRegionId": "cn-shanghai",
        "VaultRegionId": "cn-shanghai",
        "UpdatedTime": 1554347313,
        "ResourceGroupId": "rg-*********************",
        "BucketName": "hbr-0005i51******t58",
        "SearchEnabled": true,
        "IndexAvailable": true,
        "BytesDone": 20,
        "Tags": {
          "Tag": [
            {
              "Key": "aaa",
              "Value": "a1"
            }
          ]
        },
        "SourceTypes": {
          "SourceType": [
            "ECS_FILE"
          ]
        },
        "ReplicationProgress": {
          "HistoricalReplicationProgress": 100,
          "NewReplicationProgress": 1579413159
        },
        "BackupPlanStatistics": {
          "Oracle": 1,
          "LocalFile": 1,
          "Nas": 1,
          "CommonNas": 1,
          "Isilon": 1,
          "Oss": 1,
          "SqlServer": 1,
          "Csg": 1,
          "EcsFile": 1,
          "MySql": 1,
          "EcsHana": 1,
          "LocalVm": 1,
          "Ots": 1,
          "Archive": 1,
          "CommonFileSystem": 1
        },
        "TrialInfo": {
          "TrialStartTime": 1579413159,
          "TrialVaultReleaseTime": 1594965600,
          "TrialExpireTime": 1584597600,
          "KeepAfterTrialExpiration": true
        },
        "EncryptType": "HBR_PRIVATE",
        "WormEnabled": true,
        "SnapshotCount": 0,
        "CompressionAlgorithm": "ZSTD",
        "RedundancyType": "LRS",
        "KmsKeyId": "alias/acs/acm",
        "ChargedStorageSize": 1024000,
        "ArchiveStorageSize": 1024000,
        "ArchiveBytesDone": 1024000,
        "ReplicationSourceVault": false,
        "ReplicationTargetRegionId": "cn-shanghai",
        "VaultOwnerId": 0,
        "ReplicationTargetVaultId": "",
        "ReplicationSourceOwnerId": 0,
        "ReplicationTargetOwnerId": 0,
        "ReplicationStatus": "",
        "RsTargetAccountIds": {
          "RsTargetAccountId": [
            0
          ]
        }
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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