すべてのプロダクト
Search

このプロダクト

    Elastic Compute Service:DescribeDedicatedBlockStorageClusters

    ドキュメントセンター

    Elastic Compute Service:DescribeDedicatedBlockStorageClusters

    最終更新日:Dec 21, 2025

    専用クラスターを照会します。

    操作説明

    注意事項

    説明

    専用ブロックストレージクラスター機能は、中国 (河源)、インドネシア (ジャカルタ)、および中国 (深セン) リージョンでのみ利用可能です。

    • 複数のリクエストパラメーターを指定してクエリを実行できます。指定されたパラメーターは AND オペレーターで評価されます。フィルター条件には、指定されたパラメーターのみが含まれます。

    • ページ分割クエリを実行するには、NextToken と MaxResults を使用することを推奨します。各リクエストで返されるエントリの最大数を指定するには、MaxResults を使用することを推奨します。NextToken の戻り値はページネーショントークンであり、次のリクエストで新しいページの結果を取得するために使用できます。DescribeDedicatedBlockStorageClusters 操作を呼び出して新しいページの結果を取得する際、NextToken を前の呼び出しで返された NextToken 値に設定し、MaxResults を指定して返されるエントリの数を制限します。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    ebs:DescribeDedicatedBlockStorageClusters

    get

    *DedicatedBlockStorageCluster

    acs:ebs:{#regionId}:{#accountId}:dedicatedblockstoragecluster/*

    *DedicatedBlockStorageCluster

    acs:ebs:{#regionId}:{#accountId}:dedicatedblockstoragecluster/{#DedicatedBlockStorageClusterId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    専用ブロックストレージクラスターのリージョン ID。DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。

    cn-heyuan
    AzoneId

    string

    任意

    専用ブロックストレージクラスターのゾーン ID。DescribeZones 操作を呼び出して、最新のゾーンリストを照会できます。

    cn-heyuan-b
    DedicatedBlockStorageClusterId

    array

    任意

    専用ブロックストレージクラスターの ID。リクエストで複数の専用ブロックストレージクラスターの ID を指定できます。

    string

    任意

    専用ブロックストレージクラスター N の ID。1 つのリクエストで複数の専用ブロックストレージクラスターの ID を指定できます。

    dbsc-f8z4d3k4nsgg9okb****
    Status

    array

    任意

    専用ブロックストレージクラスターの状態。有効値：

    • Preparing

    • Running

    • Expired

    • Offline

    複数の状態を指定できます。N の有効値：1、2、3、4。

    列挙値:

    • Running :

      実行中

    • Offline :

      オフライン

    • Expired :

      期限切れ

    • Preparing :

      準備中

    string

    任意

    専用ブロックストレージクラスターの状態。有効値：

    • Preparing

    • Running

    • Expired

    • Offline

    N は複数の状態を指定できることを示します。N の有効値：1、2、3、4。

    Running
    Category

    string

    任意

    専用ブロックストレージクラスターで作成できるディスクのカテゴリ。

    値を `cloud_essd` に設定します。専用ブロックストレージクラスターでは、拡張 SSD (ESSD) のみを作成できます。

    cloud_essd
    Tag

    array<object>

    任意

    タグ。最大 20 個のタグがサポートされます。

    object

    任意

    Key

    string

    任意

    専用ブロックストレージクラスターのタグキー。

    TestKey
    Value

    string

    任意

    専用ブロックストレージクラスターのタグ値。

    TestValue
    ResourceGroupId

    string

    任意

    専用ブロックストレージクラスターが属するリソースグループの ID。

    rg-acfmvs4****
    NextToken

    string

    任意

    クエリトークン。最後の呼び出しで返された `NextToken` 値に設定します。

    AAAAAdDWBF2
    MaxResults

    integer

    任意

    トークンを使用してクエリを実行する各リクエストで返されるエントリの最大数。

    10
    PageSize

    integer

    任意

    1 ページあたりのエントリ数。有効値：1～100。

    10
    PageNumber

    integer

    任意

    ページ番号。

    1
    ClientToken

    string

    任意

    クライアントがリクエストを送信するための識別子としてサーバーによって生成される文字列。

    123e4567-e89b-12d3-a456-426655440000

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答。

    DedicatedBlockStorageClusters

    array<object>

    専用ブロックストレージクラスターの詳細。

    array<object>

    DedicatedBlockStorageClusterId

    string

    専用ブロックストレージクラスターの ID。

    dbsc-f8z4d3k4nsgg9okb****
    DedicatedBlockStorageClusterName

    string

    専用ブロックストレージクラスターの名前。

    myDBSCCluster
    Description

    string

    専用ブロックストレージクラスターの説明。

    This is description.
    RegionId

    string

    専用ブロックストレージクラスターのリージョン ID。

    cn-heyuan
    ZoneId

    string

    専用ブロックストレージクラスターのゾーン ID。

    cn-heyuan-b
    Status

    string

    専用ブロックストレージクラスターの状態。有効値：

    • Preparing

    • Running

    • Expired

    • Offline

    Running
    Category

    string

    専用ブロックストレージクラスターで作成できるディスクのカテゴリ。

    cloud_essd
    Type

    string

    専用ブロックストレージクラスターのタイプ。有効値：

    • Standard：基本的な専用ブロックストレージクラスター。パフォーマンスレベル 0 (PL0) の ESSD は、基本的な専用ブロックストレージクラスターで作成できます。

    • Premium：パフォーマンス専用ブロックストレージクラスター。パフォーマンスレベル 1 (PL1) の ESSD は、パフォーマンス専用ブロックストレージクラスターで作成できます。

    Standard
    PerformanceLevel

    string

    ディスクのパフォーマンスレベル。有効値：

    • PL0

    • PL1

    • PL2

    • PL3

    説明

    このパラメーターは、`SupportedCategory` の値が `cloud_essd` の場合にのみ有効です。

    PL0
    SupportedCategory

    string

    このパラメーターはサポートされていません。

    cloud_essd
    CreateTime

    string

    専用ブロックストレージクラスターが作成された時刻。値は UNIX タイムスタンプです。単位：秒。

    1657113211
    ExpiredTime

    string

    専用ブロックストレージクラスターの有効期限が切れる時刻。値は UNIX タイムスタンプです。単位：秒。

    1673020800
    DedicatedBlockStorageClusterCapacity

    object

    専用ブロックストレージクラスターのストレージ容量の詳細。

    AvailableCapacity

    integer

    専用ブロックストレージクラスターの利用可能な容量。単位：GiB。

    61440
    TotalCapacity

    integer

    専用ブロックストレージクラスターの総容量。単位：GiB。

    61440
    DeliveryCapacity

    integer

    専用ブロックストレージクラスターで配信される容量。単位：GiB。

    0
    UsedCapacity

    integer

    専用ブロックストレージクラスターの使用済み容量。単位：GiB。

    1440
    ClusterDeliveryCapacity

    integer

    注文で配信される予定の専用ブロックストレージクラスターの容量。単位：GB。

    0
    ClusterAvailableCapacity

    integer

    注文で配信された専用ブロックストレージクラスターの容量。単位：GB。

    61440
    AvailableDeviceCapacity

    integer

    ディスク作成注文で配信された専用ブロックストレージクラスターの総容量。単位：GB。

    61440
    TotalDeviceCapacity

    integer

    ディスク作成注文で配信される予定の専用ブロックストレージクラスターの総容量。単位：GB。

    61440
    UsedDeviceCapacity

    integer

    ディスク作成に使用された専用ブロックストレージクラスターの容量。単位：GB。

    32000
    AvailableSpaceCapacity

    number

    このパラメーターは、シンプロビジョニングが有効な場合にのみ表示されます。

    40000.3
    TotalSpaceCapacity

    integer

    このパラメーターは、シンプロビジョニングが有効な場合にのみ表示されます。

    73728
    UsedSpaceCapacity

    number

    このパラメーターは、シンプロビジョニングが有効な場合にのみ表示されます。

    33727.7
    AliUid

    string

    ユーザー ID。

    12345601234560***
    StorageDomain

    string

    StorageDomain

    StorageDomain
    EnableThinProvision

    boolean

    シンプロビジョニングが有効かどうかを示します。

    true
    SizeOverSoldRatio

    number

    容量オーバーコミット率。

    1.2
    Tags

    array<object>

    専用ブロックストレージクラスターのタグ。

    object

    TagKey

    string

    専用ブロックストレージクラスターのタグキー。

    testKey
    TagValue

    string

    専用ブロックストレージクラスターのタグ値。

    testValue
    ResourceGroupId

    string

    専用ブロックストレージクラスターが属するリソースグループの ID。ListResourceGroups 操作を呼び出して、リソースグループの ID を取得できます。

    rg-aekzsoux****
    NextToken

    string

    ページネーショントークン。次のリクエストで新しいページの結果を取得するために使用できます。

    AAAAAdDWBF2
    PageNumber

    integer

    ページ番号。

    1
    PageSize

    integer

    1 ページあたりのエントリ数。

    10
    TotalCount

    integer

    返されたエントリの総数。

    20
    RequestId

    string

    リクエスト ID。

    11B55F58-D3A4-4A9B-9596-342420D0****

    例

    成功レスポンス

    JSONJSON

    {
  "DedicatedBlockStorageClusters": [
    {
      "DedicatedBlockStorageClusterId": "dbsc-f8z4d3k4nsgg9okb****",
      "DedicatedBlockStorageClusterName": "myDBSCCluster",
      "Description": "This is description.",
      "RegionId": "cn-heyuan",
      "ZoneId": "cn-heyuan-b",
      "Status": "Running",
      "Category": "cloud_essd",
      "Type": "Standard",
      "PerformanceLevel": "PL0",
      "SupportedCategory": "cloud_essd",
      "CreateTime": "1657113211",
      "ExpiredTime": "1673020800",
      "DedicatedBlockStorageClusterCapacity": {
        "AvailableCapacity": 61440,
        "TotalCapacity": 61440,
        "DeliveryCapacity": 0,
        "UsedCapacity": 1440,
        "ClusterDeliveryCapacity": 0,
        "ClusterAvailableCapacity": 61440,
        "AvailableDeviceCapacity": 61440,
        "TotalDeviceCapacity": 61440,
        "UsedDeviceCapacity": 32000,
        "AvailableSpaceCapacity": 40000.3,
        "TotalSpaceCapacity": 73728,
        "UsedSpaceCapacity": 33727.7
      },
      "AliUid": "12345601234560***",
      "StorageDomain": "StorageDomain",
      "EnableThinProvision": true,
      "SizeOverSoldRatio": 1.2,
      "Tags": [
        {
          "TagKey": "testKey",
          "TagValue": "testValue"
        }
      ],
      "ResourceGroupId": "rg-aekzsoux****"
    }
  ],
  "NextToken": "AAAAAdDWBF2",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 20,
  "RequestId": "11B55F58-D3A4-4A9B-9596-342420D0****"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 MissingParameter The input parameter %s that is mandatory for processing this request is not supplied.
    500 InternalError The request processing has failed due to some unknown error, exception or failure.
    403 Forbidden User is not authorized to operate.
    403 Forbidden.Action User is not authorized to operate this action.
    403 InvalidDiskCategory.NotSupported The specified disk category is not supported.
    403 NoPermission.SLR The RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS.
    404 InvalidApi.NotFound Specified api is not found, please check your url and method.
    404 InvalidRegionId.NotFound The specified RegionId does not exist.
    404 InvalidResourceId.NotFound The specified ResourceIds are not found in our records.
    404 InvalidResourceType.NotFound The ResourceType provided does not exist in our records.
    404 InvalidZoneId.NotFound The specified ZoneId does not exist.
    404 NoSuchResource The specified resource does not exist.
    504 RequestTimeout The request is timeout, please try again later.

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

    変更履歴

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