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

ApsaraDB for SelectDB:DescribeDBInstanceAttribute

最終更新日:Jul 05, 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

selectdb:DescribeDBInstanceAttribute

list

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

DBInstanceId

string

必須

DB インスタンス ID。

selectdb-cn-7213cjv****

RegionId

string

必須

リージョン ID。

cn-hangzhou

レスポンスフィールド

フィールド

説明

object

レスポンスのスキーマ

RequestId

string

リクエスト ID。

06758CAB-1204-5852-A471-29C87D5C1D0F

Status

string

インスタンスの状態。有効な値は次のとおりです:

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

  • ACTIVE:インスタンスは実行中です。

  • RESOURCE_CHANGING:インスタンスの設定を変更中です。

  • ORDER_PREPARING:注文を確認中です。

  • READONLY_RESOURCE_CHANGING:インスタンスの設定を変更中で、インスタンスは書き込みロックされています。

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

ACTIVE

SubDomain

string

このパラメーターは予約されています。

Reserved parameter.

GmtModified

string

インスタンスが最後に変更された時刻 (再起動やパブリックエンドポイントリクエストなど)。時刻は UTC で、yyyy-MM-ddTHH:mmZ 形式です。

2023-08-17T09:58Z

LockMode

integer

インスタンスのロックモード。値が lock の場合、インスタンスは期限切れまたは支払い遅延により自動的にロックされることを示します。

lock

LockReason

string

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

nolock

ResourceCpu

integer

CPU コア数。

8

StorageSize

integer

ストレージ容量 (単位:GB)。

400

ObjectStoreSize

integer

オブジェクトストレージ容量 (単位:GB)。

0

MaintainStarttime

string

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

Reserved parameter.

MaintainEndtime

string

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

Reserved parameter.

DBClusterList

array<object>

インスタンスが属するクラスターに関する情報。

object

単一クラスターの詳細。

DbInstanceName

string

インスタンス名。

Instance test

DbClusterId

string

クラスター ID。

selectdb-cn-h033cjs****-be

DbClusterName

string

クラスター名。

test01

Status

string

クラスターの状態。有効な値は次のとおりです:

  • CREATING:クラスターは作成中です。

  • ACTIVE:クラスターは実行中です。

  • RESOURCE_CHANGING:クラスターの設定を変更中です。

  • ORDER_PREPARING:注文を確認中です。

  • READONLY_RESOURCE_CHANGING:クラスターの設定を変更中で、クラスターは書き込みロックされています。

  • DELETING:クラスターは削除中です。

ACTIVATION

CreatedTime

string

クラスターが作成された時刻。

2023-08-14T09:24:13Z

DbClusterClass

string

クラスターの仕様。有効な値は次のとおりです:

  • selectdb.xlarge:4 コア、16 GB のメモリ。

  • selectdb.2xlarge:8 コア、32 GB のメモリ。

  • selectdb.4xlarge:16 コア、64 GB のメモリ。

  • selectdb.8xlarge:32 コア、128 GB のメモリ。

  • selectdb.16xlarge:64 コア、256 GB のメモリ。

  • selectdb.24xlarge:96 コア、384 GB のメモリ。

  • selectdb.32xlarge:128 コア、512 GB のメモリ。

selectdb.2xlarge

CpuCores

integer

CPU コア数。

8

Memory

integer

メモリサイズ (単位:GB)。

64

CacheStorageType

string

キャッシュストレージのタイプ。

cloud_essd

PerformanceLevel

string

パフォーマンスレベル。

PL1

CacheStorageSizeGB

string

キャッシュストレージのサイズ (単位:GB)。

200

StartTime

string

クラスターが起動された時刻。

2023-08-14T09:24:13Z

ChargeType

string

クラスターの課金方法。有効な値は次のとおりです:

  • Postpaid:従量課金

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

Prepaid

ModifiedTime

string

クラスターが最後に変更された時刻。

2024-07-02T16:35:44+08:00

ScalingRulesEnable

boolean

スケジュールされたスケーリングポリシーがクラスターで有効になっているかどうかを示します。

false

ZoneId

string

ゾーン ID。

cn-hangzhou-k

VSwitchId

string

vSwitch ID。

vsw-t4n8x7jcc8rknon85tqoa

SubDomain

string

このパラメーターは予約済みであり、返されません。

预留参数,暂不返回。

ClusterBinding

string

このクラスターがバインドされているターゲットクラスター。

selectdb-cn-7213cjv****-be

ClusterNodeType

string

クラスターノードのタイプ。このパラメーターは、サーバーレスインスタンスでのみ有効です。

列挙値:

  • base :

    RCU あたりの CPU コアとメモリの比率は 1:4 です。

base

ClusterNodeCount

integer

クラスター内のノード数。このパラメーターは、サーバーレスインスタンスでのみ有効です。

1

ScaleMax

number

自動スケーリング範囲の RDS Capacity Unit (RCU) の最大数。

4

ScaleMin

number

自動スケーリング範囲の RDS Capacity Unit (RCU) の最小数。

0.5

Engine

string

データベースエンジンのタイプ。

selectdb

EngineVersion

string

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

2.4

EngineMinorVersion

string

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

3.0.1

DBInstanceId

string

インスタンス ID。

selectdb-cn-7213cjv****

Description

string

インスタンスの説明。

test

CreateTime

string

インスタンスが作成された時刻。

2023-08-14T03:00:42Z

CanUpgradeVersions

array

インスタンスがアップグレードできるエンジンバージョン。

string

エンジンバージョン。

test

ChargeType

string

インスタンスの課金方法。有効な値は次のとおりです:

  • Postpaid:従量課金

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

Prepaid

ExpireTime

string

インスタンスの有効期限が切れる時刻。

2023-09-17T00:00Z

ResourceGroupId

string

インスタンスが属するリソースグループの ID。

rg-aekzbck4asz3dsa

Tags

array<object>

インスタンスにアタッチされたタグのリスト。

object

インスタンスにアタッチされているタグ。

TagKey

string

タグキー。

testKey

TagValue

string

タグ値。

testValue

RegionId

string

リージョン ID。

cn-beijing

ZoneId

string

インスタンスのゾーン ID。

cn-beijing-h

VpcId

string

インスタンスの VPC ID。

vpc-bp175iuvg8nxqraf2****

VSwitchId

string

vSwitch ID。

vsw-bp18iztwqrs8qj2nc6nyu

DeployScheme

string

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

multi_az

MultiZone

array<object>

マルチ AZ デプロイの設定。

説明
  • このパラメーターは、DeploySchememulti_az に設定されている場合にのみ有効です。

object

マルチ AZ デプロイのゾーンのリスト。

ZoneId

string

ゾーン ID。

cn-hangzhou-k

VSwitchIds

array

vSwitch ID のリスト。

string

vSwitch ID。

vsw-bp10dbralpn4bzmgkkh8f

Cidr

string

CIDR ブロック。

113.88.14.211/32

AvailableIpCount

integer

ゾーン内の利用可能な IP アドレスの数。

4096

Serverless

boolean

サーバーレス機能がインスタンスで有効になっているかどうかを示します。

false

SecGroupConnValid

string

インスタンスが属する VPC でダイレクトポート接続機能が有効になっているかどうかを示します。

false

VirtualClusterList

array<object>

仮想クラスターのリスト。

object

DbClusterId

string

クラスター ID。

selectdb-vcg-33cjs****-be

DbClusterName

string

クラスター名。

vgcdemo

Status

string

仮想クラスターの状態。有効な値は次のとおりです:

  • CREATING:仮想クラスターは作成中です。

  • RUNNING:仮想クラスターは実行中です。

  • DELETING:仮想クラスターは削除中です。

  • UPDATING:仮想クラスターは更新中です。

UPDATING

CreatedTime

string

仮想クラスターが作成された時刻。

2025-05-31T21:01:09Z

ActiveClusterId

string

プライマリクラスターの ID。

selectdb-xx78***-be

ActiveClusterName

string

プライマリクラスターの名前。

test1

StandbyClusterId

string

スタンバイクラスターの ID。

selectdb-x6u7***-be

StandbyClusterName

string

スタンバイクラスターの名前。

test2

ConfigPatternType

string

インスタンスに適用される設定テンプレート。

log

OTelGrafanaServiceStatus

string

OTelBearerToken

string

LangfuseInstanceIds

array

string

lfu-xxkshuf23sdj

CanUpgradeVersionCommunityMap

object

string

CommunityVersion

string

MCPServerServiceStatus

string

not_enabled

成功レスポンス

JSONJSON

{
  "RequestId": "06758CAB-1204-5852-A471-29C87D5C1D0F",
  "Status": "ACTIVE",
  "SubDomain": "Reserved parameter.",
  "GmtModified": "2023-08-17T09:58Z",
  "LockMode": 0,
  "LockReason": "nolock",
  "ResourceCpu": 8,
  "StorageSize": 400,
  "ObjectStoreSize": 0,
  "MaintainStarttime": "Reserved parameter.",
  "MaintainEndtime": "Reserved parameter.",
  "DBClusterList": [
    {
      "DbInstanceName": "Instance test",
      "DbClusterId": "selectdb-cn-h033cjs****-be",
      "DbClusterName": "test01",
      "Status": "ACTIVATION",
      "CreatedTime": "2023-08-14T09:24:13Z",
      "DbClusterClass": "selectdb.2xlarge",
      "CpuCores": 8,
      "Memory": 64,
      "CacheStorageType": "cloud_essd",
      "PerformanceLevel": "PL1",
      "CacheStorageSizeGB": "200",
      "StartTime": "2023-08-14T09:24:13Z",
      "ChargeType": "Prepaid",
      "ModifiedTime": "2024-07-02T16:35:44+08:00",
      "ScalingRulesEnable": false,
      "ZoneId": "cn-hangzhou-k",
      "VSwitchId": "vsw-t4n8x7jcc8rknon85tqoa",
      "SubDomain": "预留参数,暂不返回。",
      "ClusterBinding": "selectdb-cn-7213cjv****-be",
      "ClusterNodeType": "base",
      "ClusterNodeCount": 1,
      "ScaleMax": 4,
      "ScaleMin": 0.5
    }
  ],
  "Engine": "selectdb",
  "EngineVersion": "2.4",
  "EngineMinorVersion": "3.0.1",
  "DBInstanceId": "selectdb-cn-7213cjv****",
  "Description": "test",
  "CreateTime": "2023-08-14T03:00:42Z",
  "CanUpgradeVersions": [
    "test"
  ],
  "ChargeType": "Prepaid",
  "ExpireTime": "2023-09-17T00:00Z",
  "ResourceGroupId": "rg-aekzbck4asz3dsa",
  "Tags": [
    {
      "TagKey": "testKey",
      "TagValue": "testValue"
    }
  ],
  "RegionId": "cn-beijing",
  "ZoneId": "cn-beijing-h",
  "VpcId": "vpc-bp175iuvg8nxqraf2****",
  "VSwitchId": "vsw-bp18iztwqrs8qj2nc6nyu",
  "DeployScheme": "multi_az",
  "MultiZone": [
    {
      "ZoneId": "cn-hangzhou-k",
      "VSwitchIds": [
        "vsw-bp10dbralpn4bzmgkkh8f"
      ],
      "Cidr": "113.88.14.211/32",
      "AvailableIpCount": 4096
    }
  ],
  "Serverless": false,
  "SecGroupConnValid": "false",
  "VirtualClusterList": [
    {
      "DbClusterId": "selectdb-vcg-33cjs****-be",
      "DbClusterName": "vgcdemo",
      "Status": "UPDATING",
      "CreatedTime": "2025-05-31T21:01:09Z",
      "ActiveClusterId": "selectdb-xx78***-be",
      "ActiveClusterName": "test1",
      "StandbyClusterId": "selectdb-x6u7***-be\n",
      "StandbyClusterName": "test2"
    }
  ],
  "ConfigPatternType": "log",
  "OTelGrafanaServiceStatus": "",
  "OTelBearerToken": "",
  "LangfuseInstanceIds": [
    "lfu-xxkshuf23sdj"
  ],
  "CanUpgradeVersionCommunityMap": {
    "key": ""
  },
  "CommunityVersion": "",
  "MCPServerServiceStatus": "not_enabled"
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

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. 注文の作成に失敗しました。
400 InvalidDBName.Duplicate Specified DB name already exists in the This instance.
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 InvalidDBInstanceId.NotFound The DBInstanceId provided does not exist in our records.
404 InvalidClusterInstance.NotFound Specified cluster instance does not exist.
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

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

変更履歴

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