すべてのプロダクト
Search

このプロダクト

    ApsaraDB for SelectDB:DescribeDBInstances

    ドキュメントセンター

    ApsaraDB for SelectDB:DescribeDBInstances

    最終更新日:Jan 06, 2026

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    selectdb:DescribeDBInstances

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ResourceGroupId

    string

    任意

    リソースグループの ID。

    rg-4690g37929****
    DBInstanceIds

    string

    任意

    インスタンス ID。複数のインスタンス ID はコンマ (,) で区切ります。

    selectdb-cn-7213cjv****
    DBInstanceStatus

    string

    任意

    インスタンスの状態。有効な値：

    • CREATING：インスタンスは作成中です。

    • ACTIVATION：インスタンスは実行中です。

    • RESOURCE_CHANGING：インスタンスはスペックアップまたはスペックダウン中です。

    • ORDER_PREPARING：注文は確認中です。

    • READONLY_RESOURCE_CHANGING：インスタンス構成が変更中で、インスタンスは書き込みロックされています。

    • DELETING：インスタンスは削除中です。

    ACTIVATION
    DBInstanceDescription

    string

    任意

    インスタンスの説明。

    新建实例测试
    PageSize

    integer

    任意

    各ページに返すエントリ数。有効な値：

    • 30 (デフォルト)

    • 50

    • 100

    30
    PageNumber

    integer

    任意

    ページ番号。

    1
    RegionId

    string

    必須

    リージョン ID。

    cn-hangzhou
    Tag

    array<object>

    任意

    インスタンスのタグのリスト。

    object

    任意

    インスタンスタグのリスト。

    Key

    string

    任意

    タグキー。

    testKey
    Value

    string

    任意

    タグ値。

    testValue

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答のスキーマ

    RequestId

    string

    リクエスト ID。

    BC854513-E85E-54F3-9842-B9CCD3308CDD
    PageNumber

    integer

    1 ページあたりに返すエントリ数。有効な値：

    • 30 (デフォルト値)

    • 50

    • 100

    30
    PageSize

    integer

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

    1
    TotalRecordCount

    integer

    エントリの総数。

    2
    Items

    array<object>

    インスタンス詳細のリスト。

    array<object>

    インスタンス詳細のリスト。

    connectionString

    string

    エンドポイント。

    暂不返回
    DBInstanceId

    string

    インスタンス ID。

    selectdb-cn-7213cjv****
    Description

    string

    インスタンスの説明。

    新建实例测试
    Engine

    string

    データベースタイプ。

    selectdb
    EngineVersion

    string

    データベースバージョン。

    2.4
    InstanceUsedType

    string

    インスタンスの使用タイプ。

    Instance
    RegionId

    string

    リージョン ID。

    cn-hangzhou
    ZoneId

    string

    ゾーン ID。

    cn-hangzhou-i
    ChargeType

    string

    インスタンスの課金方法。有効な値：

    • Postpaid：従量課金

    • Prepaid：サブスクリプション

    PrePaid
    Category

    string

    インスタンスエディション。デフォルト値は basic です。

    basic
    Status

    string

    インスタンスの状態。有効な値：

    • CREATING：インスタンスは作成中です。

    • ACTIVATION：インスタンスは実行中です。

    • RESOURCE_CHANGING：インスタンスはスペックアップまたはスペックダウン中です。

    • ORDER_PREPARING：注文は確認中です。

    • READONLY_RESOURCE_CHANGING：インスタンス構成が変更中で、インスタンスは書き込みロックされています。

    • DELETING：インスタンスは削除中です。

    ACTIVATION
    VpcId

    string

    VPC ID。

    vpc-bp175iuvg8nxqraf2****
    VswitchId

    string

    vSwitch ID。

    vsw-bp1gzt31twhlo0sa5****
    ResourceCpu

    integer

    リソースに割り当てられた CPU。

    8
    ResourceMemory

    integer

    メモリサイズ。

    64
    ScaleMin

    integer

    インスタンスの RDS キャパシティユニット (RCU) の最小数。

    0
    ScaleMax

    integer

    インスタンスの RDS キャパシティユニット (RCU) の最大数。

    0
    ScaleReplica

    integer

    このフィールドは冗長です。

    空
    StorageSize

    integer

    ストレージ容量。

    100
    StorageType

    string

    インスタンスのストレージクラス。

    cloud_essd
    ObjectStoreSize

    integer

    インスタンスのストレージサイズ。単位：GB。

    200
    ExpireTime

    string

    クラスターの有効期限。

    説明

    このパラメーターは、Prepaid (サブスクリプション) クラスターに対してのみ返されます。Postpaid (従量課金) クラスターの場合、このパラメーターは空です。

    2024-03-29T03:47:05Z
    LockMode

    integer

    インスタンスのロックモード。

    0
    LockReason

    string

    インスタンスがロックされている理由。

    nolock
    IsDeleted

    boolean

    インスタンスが削除されたかどうかを示します。有効な値：

    • true：インスタンスは削除されました。

    • false：インスタンスは削除されていません。

    false
    MaintainStarttime

    string

    インスタンスのメンテナンスウィンドウの開始時刻。

    保留参数，暂不返回
    MaintainEndtime

    string

    インスタンスのメンテナンスウィンドウの終了時刻。

    保留参数，暂不返回
    GmtCreated

    string

    タスクが作成された時刻 (GMT)。

    2023-08-12T04:14Z

    GmtModified

    string

    タスクが最後に変更された時刻 (GMT)。

    2023-08-12T19:05Z
    ParentInstance

    string

    作成時刻。

    保留参数，暂不返回
    ResourceGroupId

    string

    リソースグループ ID。

    保留参数，暂不返回
    MaintainStartTimeStr

    string

    メンテナンスウィンドウの開始を示すタイムスタンプ。

    保留参数，暂不返回
    MaintainEndTimeStr

    string

    メンテナンスウィンドウの終了を示すタイムスタンプ。

    保留参数，暂不返回
    TenantClusterId

    string

    Prometheus モニタリングクラスターの ID。

    保留参数，暂不返回

    TenantToken

    string

    Prometheus モニタリングに接続するためのトークン。

    保留参数，暂不返回

    TenantUserId

    string

    Prometheus モニタリングのユーザーアカウントラベル。

    保留参数，暂不返回

    Tags

    array<object>

    インスタンスのタグのリスト。

    object

    インスタンスタグのリスト。

    TagKey

    string

    タグキー。

    testKey
    TagValue

    string

    タグ値。

    testValue
    ClusterCount

    integer

    クラスターの総数。

    1
    DeployScheme

    string

    インスタンスのデプロイモード：

    • multi_az：ゾーン冗長ストレージ。

    • single_az：ローカル冗長ストレージ。

    single_az
    MultiZone

    array<object>

    マルチゾーン構成。

    object

    複数ゾーンのリスト。

    ZoneId

    string

    ゾーン ID。

    cn-beijing-k
    VSwitchIds

    array

    vSwitch ID のリスト。

    string

    vSwitch ID。

    vsw-bp1pla4vl8bs9uw9c7l2w
    EngineMinorVersion

    string

    インスタンスのマイナーエンジンバージョン。

    4.0.4
    Serverless

    boolean

    インスタンスがサーバーレスインスタンスであるかどうかを示します。

    false

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "BC854513-E85E-54F3-9842-B9CCD3308CDD",
  "PageNumber": 30,
  "PageSize": 1,
  "TotalRecordCount": 2,
  "Items": [
    {
      "connectionString": "暂不返回",
      "DBInstanceId": "selectdb-cn-7213cjv****",
      "Description": "新建实例测试",
      "Engine": "selectdb",
      "EngineVersion": "2.4",
      "InstanceUsedType": "Instance",
      "RegionId": "cn-hangzhou",
      "ZoneId": "cn-hangzhou-i",
      "ChargeType": "PrePaid",
      "Category": "basic",
      "Status": "ACTIVATION",
      "VpcId": "vpc-bp175iuvg8nxqraf2****",
      "VswitchId": "vsw-bp1gzt31twhlo0sa5****",
      "ResourceCpu": 8,
      "ResourceMemory": 64,
      "ScaleMin": 0,
      "ScaleMax": 0,
      "ScaleReplica": 0,
      "StorageSize": 100,
      "StorageType": "cloud_essd",
      "ObjectStoreSize": 200,
      "ExpireTime": "2024-03-29T03:47:05Z",
      "LockMode": 0,
      "LockReason": "nolock",
      "IsDeleted": false,
      "MaintainStarttime": "保留参数，暂不返回",
      "MaintainEndtime": "保留参数，暂不返回",
      "GmtCreated": "2023-08-12T04:14Z\n",
      "GmtModified": "2023-08-12T19:05Z",
      "ParentInstance": "保留参数，暂不返回",
      "ResourceGroupId": "保留参数，暂不返回",
      "MaintainStartTimeStr": "保留参数，暂不返回",
      "MaintainEndTimeStr": "保留参数，暂不返回",
      "TenantClusterId": "保留参数，暂不返回\n",
      "TenantToken": "保留参数，暂不返回\n",
      "TenantUserId": "保留参数，暂不返回\n",
      "Tags": [
        {
          "TagKey": "testKey",
          "TagValue": "testValue"
        }
      ],
      "ClusterCount": 1,
      "DeployScheme": "single_az",
      "MultiZone": [
        {
          "ZoneId": "cn-beijing-k",
          "VSwitchIds": [
            "vsw-bp1pla4vl8bs9uw9c7l2w"
          ]
        }
      ],
      "EngineMinorVersion": "4.0.4",
      "Serverless": false
    }
  ]
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidPageNumber.Malformed The specified parameter "PageNumber" is not valid.
    400 DocumentConvertFailed.ExceedFileSizeLimit The conversion has been failed, exceed file size limit. 日文说明1
    400 Forbidden User not authorized to operate on the specified resource, or this API does not support RAM. 日文说明1
    400 InvalidDBName The specified database name is not allowed. 日文说明1
    400 CreateOrderFailed Failed to create order. 注文の作成に失敗しました。
    403 DBClusterNotSupported The requested operation can not be performed while the cluster is not sale. 日文说明1
    403 IncorrectDBInstanceState Current DB instance state does not support this operation. 日文说明1
    403 InstanceEngineType.NotSupport The instance engine and type does not support operations. 日文说明1
    403 InvalidDBInstanceState.NotSupport The specified instance state does't support this operation. 日文说明1
    403 MoneyLessThan100 The Account Monet less Than 100. 日文说明1
    403 OperationDenied.DBNameAndAccountPrivilegeCount The operation is not permitted due to count of database or account privilege. 日文说明1
    403 InsufficientResourceCapacity The resource is out of usage. リソースが不足しています。しばらくしてからやり直してください。
    404 DBInstanceLocked The current instance lock mode does not support this operation. 日文说明1
    404 IncorrectVswitchId The specified parameter VSwitchId is not valid. 日文说明1
    404 InvalidApi.NotFound Specified api is not found, please check your url and method.
    404 InvalidDBInstance.NotFound The specified instance is not found. 日文说明1
    404 InvalidDBInstanceClass.NotFound The specified instance classic does not exist. 日文说明1
    404 InvalidRegionId.NotFound The provided RegionId does not exist in our records. 日文说明1
    404 QueryPrice.Failed The inquiry failed. Contact Alibaba Cloud customer service representatives. 日文说明1

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

    変更履歴

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