Gunakan DescribeDBInstanceAttribute untuk mengkueri detail instans-ApsaraDB untuk SelectDB-Alibaba Cloud - ApsaraDB for SelectDB

Mengambil detail suatu instance.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

selectdb:DescribeDBInstanceAttribute

list

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	ID instans database.	selectdb-cn-7213cjv****
RegionId	string	Yes	ID wilayah.	cn-hangzhou

Elemen respons

Element	Type	Description	Example
	object	Skema Respons
RequestId	string	ID permintaan.	06758CAB-1204-5852-A471-29C87D5C1D0F
Status	string	Status instans. Nilai yang valid: CREATING: Instans sedang dibuat. ACTIVE: Instans sedang berjalan. RESOURCE_CHANGING: Konfigurasi instans sedang diubah. ORDER_PREPARING: Pesanan sedang dikonfirmasi. READONLY_RESOURCE_CHANGING: Konfigurasi instans sedang diubah dan instans dalam kondisi write-locked. DELETING: Instans sedang dihapus.	ACTIVE
SubDomain	string	Parameter ini dipesan.	Reserved parameter.
GmtModified	string	Waktu terakhir instans dimodifikasi, misalnya karena restart atau permintaan titik akhir publik. Waktu dalam UTC dengan format `yyyy-MM-ddTHH:mmZ`.	2023-08-17T09:58Z
LockMode	integer	Mode penguncian instans. Nilai lock menunjukkan bahwa instans secara otomatis dikunci setelah kedaluwarsa atau karena pembayaran tertunda.	lock
LockReason	string	Alasan instans dikunci.	nolock
ResourceCpu	integer	Jumlah core CPU.	8
StorageSize	integer	Kapasitas penyimpanan, dalam GB.	400
ObjectStoreSize	integer	Kapasitas penyimpanan objek, dalam GB.	0
MaintainStarttime	string	Waktu mulai jendela pemeliharaan.	Reserved parameter.
MaintainEndtime	string	Waktu akhir jendela pemeliharaan.	Reserved parameter.
DBClusterList	array<object>	Informasi tentang kluster tempat instans tersebut berada.
	object	Detail untuk satu kluster.
DbInstanceName	string	Nama instans.	Instance test
DbClusterId	string	ID kluster.	selectdb-cn-h033cjs****-be
DbClusterName	string	Nama kluster.	test01
Status	string	Status kluster. Nilai yang valid: CREATING: Kluster sedang dibuat. ACTIVE: Kluster sedang berjalan. RESOURCE_CHANGING: Konfigurasi kluster sedang diubah. ORDER_PREPARING: Pesanan sedang dikonfirmasi. READONLY_RESOURCE_CHANGING: Konfigurasi kluster sedang diubah dan kluster dalam kondisi write-locked. DELETING: Kluster sedang dihapus.	ACTIVATION
CreatedTime	string	Waktu kluster dibuat.	2023-08-14T09:24:13Z
DbClusterClass	string	Spesifikasi kluster. Nilai yang valid: selectdb.xlarge: 4 core, memori 16 GB. selectdb.2xlarge: 8 core, memori 32 GB. selectdb.4xlarge: 16 core, memori 64 GB. selectdb.8xlarge: 32 core, memori 128 GB. selectdb.16xlarge: 64 core, memori 256 GB. selectdb.24xlarge: 96 core, memori 384 GB. selectdb.32xlarge: 128 core, memori 512 GB.	selectdb.2xlarge
CpuCores	integer	Jumlah core CPU.	8
Memory	integer	Ukuran memori, dalam GB.	64
CacheStorageType	string	Jenis penyimpanan cache.	cloud_essd
PerformanceLevel	string	Tingkat kinerja.	PL1
CacheStorageSizeGB	string	Ukuran penyimpanan cache, dalam GB.	200
StartTime	string	Waktu kluster dijalankan.	2023-08-14T09:24:13Z
ChargeType	string	Metode penagihan kluster. Nilai yang valid: Postpaid: bayar sesuai penggunaan Prepaid: subscription	Prepaid
ModifiedTime	string	Waktu terakhir kluster dimodifikasi.	2024-07-02T16:35:44+08:00
ScalingRulesEnable	boolean	Menunjukkan apakah kebijakan elastis terjadwal diaktifkan untuk kluster.	false
ZoneId	string	ID zona.	cn-hangzhou-k
VSwitchId	string	ID vSwitch.	vsw-t4n8x7jcc8rknon85tqoa
SubDomain	string	Parameter ini dipesan dan tidak dikembalikan.	预留参数，暂不返回。
ClusterBinding	string	Kluster target tempat kluster ini terikat.	selectdb-cn-7213cjv****-be
ClusterNodeType	string	Jenis node kluster. Parameter ini hanya berlaku untuk instans serverless. Valid values: base : Rasio core CPU terhadap memori adalah 1:4 per RCU.	base
ClusterNodeCount	integer	Jumlah node dalam kluster. Parameter ini hanya berlaku untuk instans serverless.	1
ScaleMax	number	Jumlah maksimum Unit Kapasitas RDS (RCU) untuk rentang auto-scaling.	4
ScaleMin	number	Jumlah minimum Unit Kapasitas RDS (RCU) untuk rentang auto-scaling.	0.5
Engine	string	Jenis mesin database.	selectdb
EngineVersion	string	Versi mesin database.	2.4
EngineMinorVersion	string	Versi minor mesin instans.	3.0.1
DBInstanceId	string	ID instans.	selectdb-cn-7213cjv****
Description	string	Deskripsi instans.	test
CreateTime	string	Waktu instans dibuat.	2023-08-14T03:00:42Z
CanUpgradeVersions	array	Versi mesin yang dapat ditingkatkan untuk instans.
	string	Versi mesin.	test
ChargeType	string	Metode penagihan instans. Nilai yang valid: Postpaid: bayar sesuai penggunaan Prepaid: subscription	Prepaid
ExpireTime	string	Waktu instans kedaluwarsa.	2023-09-17T00:00Z
ResourceGroupId	string	ID kelompok sumber daya tempat instans berada.	rg-aekzbck4asz3dsa
Tags	array<object>	Daftar tag yang dilampirkan pada instans.
	object	Tag yang dilampirkan pada instans.
TagKey	string	Kunci tag.	testKey
TagValue	string	Nilai tag.	testValue
RegionId	string	ID wilayah.	cn-beijing
ZoneId	string	ID zona instans.	cn-beijing-h
VpcId	string	ID VPC instans.	vpc-bp175iuvg8nxqraf2****
VSwitchId	string	ID vSwitch.	vsw-bp18iztwqrs8qj2nc6nyu
DeployScheme	string	Mode penyebaran instans.	multi_az
MultiZone	array<object>	Konfigurasi multi-zona. Catatan Parameter ini hanya berlaku ketika `DeployScheme` diatur ke `multi_az`.
	object	Daftar zona dalam penyebaran multi-zona.
ZoneId	string	ID zona.	cn-hangzhou-k
VSwitchIds	array	Daftar ID vSwitch.
	string	ID vSwitch.	vsw-bp10dbralpn4bzmgkkh8f
Cidr	string	Blok CIDR.	113.88.14.211/32
AvailableIpCount	integer	Jumlah alamat IP yang tersedia di zona tersebut.	4096
Serverless	boolean	Menunjukkan apakah fitur serverless diaktifkan untuk instans.	false
SecGroupConnValid	string	Menunjukkan apakah fitur koneksi port langsung diaktifkan untuk VPC tempat instans berada.	false
VirtualClusterList	array<object>	Daftar kluster virtual.
	object
DbClusterId	string	ID kluster.	selectdb-vcg-33cjs****-be
DbClusterName	string	Nama kluster.	vgcdemo
Status	string	Status kluster virtual. Nilai yang valid: CREATING: Kluster virtual sedang dibuat. RUNNING: Kluster virtual sedang berjalan. DELETING: Kluster virtual sedang dihapus. UPDATING: Kluster virtual sedang diperbarui.	UPDATING
CreatedTime	string	Waktu kluster virtual dibuat.	2025-05-31T21:01:09Z
ActiveClusterId	string	ID kluster utama.	selectdb-xx78***-be
ActiveClusterName	string	Nama kluster utama.	test1
StandbyClusterId	string	ID kluster cadangan.	selectdb-x6u7***-be
StandbyClusterName	string	Nama kluster cadangan.	test2
ConfigPatternType	string	Templat konfigurasi yang diterapkan pada instans.	log
OTelGrafanaServiceStatus	string
OTelBearerToken	string
LangfuseInstanceIds	array
	string		lfu-xxkshuf23sdj
CanUpgradeVersionCommunityMap	object
	string
CommunityVersion	string
MCPServerServiceStatus	string		not_enabled

Contoh

Respons sukses

JSONformat

{
  "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"
}

Kode kesalahan

HTTP status code	Error code	Error message
400	DocumentConvertFailed.ExceedFileSizeLimit	The conversion has been failed, exceed file size limit.
400	Forbidden	User not authorized to operate on the specified resource, or this API does not support RAM.
400	InvalidDBName	The specified database name is not allowed.
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.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.
403	InstanceEngineType.NotSupport	The instance engine and type does not support operations.
403	InvalidDBInstanceState.NotSupport	The specified instance state does't support this operation.
403	MoneyLessThan100	The Account Monet less Than 100.
403	OperationDenied.DBNameAndAccountPrivilegeCount	The operation is not permitted due to count of database or account privilege.
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.
404	IncorrectVswitchId	The specified parameter VSwitchId is not valid.
404	InvalidApi.NotFound	Specified api is not found, please check your url and method.
404	InvalidDBInstance.NotFound	The specified instance is not found.
404	InvalidDBInstanceClass.NotFound	The specified instance classic does not exist.
404	InvalidRegionId.NotFound	The provided RegionId does not exist in our records.
404	QueryPrice.Failed	The inquiry failed. Contact Alibaba Cloud customer service representatives.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.