全部產品
Search
文件中心

ApsaraDB RDS:DescribeDBInstances

更新時間:Aug 17, 2026

該介面用於查詢 RDS 的執行個體清單。

介面說明

適用引擎。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

rds:DescribeDBInstances

get

DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

  • rds:ResourceTag
  • rds:ResourceTag
  • rds:ResourceTag
  • rds:ResourceTag

請求參數

名稱

類型

必填

描述

樣本值

ClientToken

string

用於保證請求的冪等性,防止重複提交請求。由用戶端產生該參數值,要保證在不同請求間唯一,最大值不超過 64 個 ASCII 字元,且該參數值中不能包含非 ASCII 字元。

ETnLKlblzczshOTUbOCz****

proxyId

string

廢棄參數,無需設定。

API

Engine

string

資料庫類型。取值:

  • MySQL

  • SQLServer

  • PostgreSQL

  • MariaDB

預設返回所有資料庫類型。

MySQL

ZoneId

string

可用區 ID。

cn-hangzhou-a

ResourceGroupId

string

資源群組 ID。

rg-acfmy****

DBInstanceStatus

string

執行個體狀態,詳情請參見執行個體狀態表

Running

Expired

string

執行個體的過期狀態。取值:

True

SearchKey

string

可基於執行個體 ID 或者執行個體備註模糊搜尋。

rm-uf6w

DBInstanceId

string

執行個體 ID。

rm-uf6wjk5****

DBInstanceType

string

執行個體類型。取值:

  • Primary:主執行個體

  • Readonly:唯讀執行個體

  • Guard:災備執行個體

  • Temp:臨時執行個體

預設返回所有執行個體類型。

Primary

RegionId

string

地域 ID。可呼叫 DescribeRegions 取得。

cn-hangzhou

PageSize

integer

每頁記錄數,取值:1~100

30

PageNumber

integer

頁碼,取值:大於 0 且不超過 Integer 的最大值。

1

InstanceNetworkType

string

執行個體的網路類型。取值:

Classic

VpcId

string

VPC ID。

vpc-uf6f7l4fg90****

VSwitchId

string

交換器 ID。

vsw-uf6adz52c2p****

DBInstanceClass

string

執行個體規格,詳見執行個體規格表

rds.mys2.small

EngineVersion

string

資料庫版本。

8.0

PayType

string

付費類型。取值:

Postpaid

ConnectionMode

string

執行個體的存取模式。取值:

Standard

Tags

string

查詢綁定有該標籤的執行個體,包括 TagKey 和 TagValue。單次最多支援傳入 5 組值,格式:{"key1":"value1","key2":"value2"...}。命中任意傳入的一組 Tag 就會返回該執行個體資訊。

{"key1":"value1"}

DedicatedHostGroupId

string

專屬叢集 ID。

dhg-7a9****

DedicatedHostId

string

專屬叢集內的主機 ID。

i-bp****

InstanceLevel

integer

是否返回執行個體系列(Category)資訊。取值:

0

QueryAutoRenewal

boolean

備用參數,無需設定。

test

ConnectionString

string

執行個體的連線地址。透過該連線地址查詢對應的執行個體。

rm-uf6wjk5****.mysql.rds.aliyuncs.com

NextToken

string

翻頁憑證。取值為上一次呼叫 DescribeDBInstances 介面時返回的 NextToken 參數值。如果呼叫結果分多頁展示,再次呼叫介面時傳入該值便可以展示下一頁的內容。

o7PORW5o2TJg****

MaxResults

integer

每頁記錄數。取值:1~100

30

Filter

string

執行個體篩選條件參數及其值的 JSON 字串。

{"babelfishEnabled":"true"}

Category

string

執行個體的系列。取值:

  • Basic:基礎系列

  • HighAvailability:高可用系列

  • cluster:叢集系列

  • serverless_basic:Serverless

cluster

本介面支援如下兩種方式檢視返回資料:

  • 方式一:透過傳入 MaxResults 參數設定每頁的記錄數,再透過 NextToken 參數設定翻頁憑證來展示下一頁的內容。NextToken 取值為上一次呼叫 DescribeDBInstances 介面返回的 NextToken 參數值。

說明

首次呼叫介面進行分頁查詢時,您只需設定 MaxResults 參數,介面會返回第一頁的資料和 NextToken 參數值。

  • 方式二:透過 PageSize 參數設定每頁的記錄數,透過 PageNumber 參數進行翻頁。

說明

上述兩種方式只能任選其一。當返回的記錄數較多時,推薦使用方式一,可以獲得更快的查詢速度。

返回參數

名稱

類型

描述

樣本值

object

返回參數詳情。

Items

object

DBInstance

array<object>

執行個體資訊列表。

array<object>

執行個體詳情。

BpeEnabled

string

棄用參數。

0

BurstingEnabled

boolean

是否已啟用 IO 突發。返回值:

false

Category

string

執行個體系列。傳回值:

  • Basic:基礎系列

  • HighAvailability:高可用系列

  • Finance:三節點企業系列

說明

僅在 InstanceLevel 參數為 1 時傳回。

Basic

IsAnalyticReadOnlyIns

boolean

執行個體是否屬於 MySQL DuckDB 分析執行個體。返回值:

false

ConnectionMode

string

執行個體的存取模式。傳回值:

Standard

ConnectionString

string

執行個體的連線地址。

rm-uf6wjk5****.mysql.rds.aliyuncs.com

CreateTime

string

建立時間。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。

2018-11-05T11:26:02Z

DBInstanceCPU

string

執行個體 CPU 數量。

2

DBInstanceClass

string

執行個體規格,詳見執行個體規格表

rds.mys2.small

DBInstanceDescription

string

執行個體描述。

testdb

DBInstanceId

string

執行個體 ID。

rm-uf6wjk5****

DBInstanceMemory

integer

節點的記憶體大小。單位:MB。

4096

DBInstanceNetType

string

執行個體的網路連線類型。傳回值:

Internet

DBInstanceStatus

string

執行個體狀態,詳情請參見執行個體狀態表

Running

DBInstanceStorageType

string

執行個體儲存類型。

ModuleList.4.ModuleCode

DBInstanceType

string

執行個體類型。傳回值:

  • Primary:主執行個體

  • Readonly:唯讀執行個體

  • Guard:災備執行個體

  • Temp:臨時執行個體

Primary

DedicatedHostGroupId

string

專屬叢集 ID。

dhg-7a9****

DedicatedHostGroupName

string

專屬叢集名稱。

testhostgroup

DedicatedHostIdForLog

string

Log 節點所在主機的 ID。

dh-bp****

DedicatedHostIdForMaster

string

Master 節點所在主機的 ID。

dh-bp****

DedicatedHostIdForSlave

string

Slave 節點所在主機的 ID。

dh-bp****

DedicatedHostNameForLog

string

Log 節點所在主機的名稱。

testlog

DedicatedHostNameForMaster

string

Master 節點所在主機的名稱。

testmaster

DedicatedHostNameForSlave

string

Slave 節點所在主機的名稱。

testslave

DedicatedHostZoneIdForLog

string

Log 節點所在主機的可用區 ID。

cn-hangzhou-b

DedicatedHostZoneIdForMaster

string

Master 節點所在主機的可用區 ID。

cn-hangzhou-c

DedicatedHostZoneIdForSlave

string

Slave 節點所在主機的可用區 ID。

cn-hangzhou-d

DeletionProtection

boolean

是否已啟用釋放保護功能。返回值:

false

DestroyTime

string

銷毀時間。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。

2018-11-05T11:26:02Z

Engine

string

資料庫類型。

MySQL

EngineVersion

string

資料庫版本。

5.7

ExpireTime

string

到期時間。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。

2019-02-27T16:00:00Z

GeneralGroupName

string

專屬叢集 MySQL 通用版執行個體所屬的組名。

TestGroup

GuardDBInstanceId

string

主執行個體如果有災備執行個體,該參數即為災備執行個體的 ID。

rm-uf64zsu****

InstanceNetworkType

string

執行個體的網路類型。返回值:

Classic

IoAccelerationEnabled

string

是否啟用 IO 加速。返回值:

0

LockMode

string

執行個體的鎖定狀態。傳回值:

  • Unlock:正常。

  • ManualLock:手動觸發鎖定。

  • LockByExpiration:執行個體過期自動鎖定。

  • LockByRestoration:執行個體復原前自動鎖定。

  • LockByDiskQuota:執行個體空間滿自動鎖定。

  • Released:執行個體已釋放。此時執行個體無法進行解鎖,只能使用備份資料重新建立新執行個體,重建時間較長,請耐心等待。

Unlock

LockReason

string

執行個體被鎖定的原因。

instance_expired

MasterInstanceId

string

主執行個體的 ID,如果沒有返回此參數(即為 null)則表示該執行個體是主執行個體。

rm-uf6wjk5****

MutriORsignle

boolean

是否為組合可用區。傳回值:

  • true

  • false

說明

組合可用區即帶有 MAZ 字樣的可用區。例如:cn-hangzhou-MAZ10(h,i)

true

PayType

string

執行個體的付費類型。返回值:

Postpaid

ReadOnlyDBInstanceIds

object

ReadOnlyDBInstanceId

array<object>

主執行個體下如果有唯讀執行個體,該參數為唯讀執行個體的 ID 列表。

object

唯讀執行個體詳情。

DBInstanceId

string

唯讀執行個體 ID。

rr-uf6wjk5****

RegionId

string

地域 ID。

cn-hangzhou

ResourceGroupId

string

資源群組 ID。

rg-acfmy****

SwitchWeight

integer

目前專屬叢集 MySQL 通用版執行個體是否支援高可用性權重切換。傳回值:

100

TempDBInstanceId

string

主執行個體如果有臨時執行個體,該參數即為臨時執行個體的 ID。

rm-uf64zsu****

Tips

string

專屬叢集 MySQL 通用版執行個體的異常提示資訊。

normal

TipsLevel

integer

專屬叢集 MySQL 通用版執行個體的異常提示等級。返回值:

1

VSwitchId

string

交換器 ID。

vsw-uf6adz52c2p****

VpcCloudInstanceId

string

專有網路執行個體 ID。

rm-uf6wjk5****

VpcId

string

VPC ID。

vpc-uf6f7l4fg90****

VpcName

string

VPC 名稱。

test-huadong

ZoneId

string

可用區 ID。

cn-hangzhou-a

BlueGreenDeploymentName

string

備用參數,無需設定。

test

BlueInstanceName

string

備用參數,無需設定。

test

GreenInstanceName

string

備用參數,無需設定。

test

AutoRenewal

boolean

執行個體是否自動續費。傳回值:

  • true:自動續費。

  • false:不自動續費。

說明

僅當 PayType 取值為 Prepaid(包年包月)時,此參數才有傳回值。

false

ColdDataEnabled

boolean

預留參數。

false

IsAnalyticIns

string

NextToken

string

翻頁憑證。如果呼叫結果分多頁展示,再次呼叫介面時在 NextToken 處傳入該值便可以展示下一頁的內容。

o7PORW5o2TJg****

PageNumber

integer

頁碼。

1

PageRecordCount

integer

當前頁執行個體個數。

10

RequestId

string

請求 ID。

1AD222E9-E606-4A42-BF6D-8A4442913CEF

TotalRecordCount

integer

總記錄數。

100

樣本

正常返回樣本

JSON格式

{
  "Items": {
    "DBInstance": [
      {
        "BpeEnabled": "0",
        "BurstingEnabled": false,
        "Category": "Basic",
        "IsAnalyticReadOnlyIns": false,
        "ConnectionMode": "Standard",
        "ConnectionString": "rm-uf6wjk5****.mysql.rds.aliyuncs.com",
        "CreateTime": "2018-11-05T11:26:02Z",
        "DBInstanceCPU": "2",
        "DBInstanceClass": "rds.mys2.small",
        "DBInstanceDescription": "testdb",
        "DBInstanceId": "rm-uf6wjk5****",
        "DBInstanceMemory": 4096,
        "DBInstanceNetType": "Internet",
        "DBInstanceStatus": "Running",
        "DBInstanceStorageType": "ModuleList.4.ModuleCode",
        "DBInstanceType": "Primary",
        "DedicatedHostGroupId": "dhg-7a9****",
        "DedicatedHostGroupName": "testhostgroup",
        "DedicatedHostIdForLog": "dh-bp****",
        "DedicatedHostIdForMaster": "dh-bp****",
        "DedicatedHostIdForSlave": "dh-bp****",
        "DedicatedHostNameForLog": "testlog",
        "DedicatedHostNameForMaster": "testmaster",
        "DedicatedHostNameForSlave": "testslave",
        "DedicatedHostZoneIdForLog": "cn-hangzhou-b",
        "DedicatedHostZoneIdForMaster": "cn-hangzhou-c",
        "DedicatedHostZoneIdForSlave": "cn-hangzhou-d",
        "DeletionProtection": false,
        "DestroyTime": "2018-11-05T11:26:02Z",
        "Engine": "MySQL",
        "EngineVersion": "5.7",
        "ExpireTime": "2019-02-27T16:00:00Z",
        "GeneralGroupName": "TestGroup",
        "GuardDBInstanceId": "rm-uf64zsu****",
        "InstanceNetworkType": "Classic",
        "IoAccelerationEnabled": "0",
        "LockMode": "Unlock",
        "LockReason": "instance_expired",
        "MasterInstanceId": "rm-uf6wjk5****",
        "MutriORsignle": true,
        "PayType": "Postpaid",
        "ReadOnlyDBInstanceIds": {
          "ReadOnlyDBInstanceId": [
            {
              "DBInstanceId": "rr-uf6wjk5****"
            }
          ]
        },
        "RegionId": "cn-hangzhou",
        "ResourceGroupId": "rg-acfmy****",
        "SwitchWeight": 100,
        "TempDBInstanceId": "rm-uf64zsu****",
        "Tips": "normal",
        "TipsLevel": 1,
        "VSwitchId": "vsw-uf6adz52c2p****",
        "VpcCloudInstanceId": "rm-uf6wjk5****",
        "VpcId": "vpc-uf6f7l4fg90****",
        "VpcName": "test-huadong",
        "ZoneId": "cn-hangzhou-a",
        "BlueGreenDeploymentName": "test",
        "BlueInstanceName": "test",
        "GreenInstanceName": "test",
        "AutoRenewal": false,
        "ColdDataEnabled": false,
        "IsAnalyticIns": ""
      }
    ]
  },
  "NextToken": "o7PORW5o2TJg****",
  "PageNumber": 1,
  "PageRecordCount": 10,
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "TotalRecordCount": 100
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 Invalid.NextToken The parameter NextToken is invalid. 參數 NextToken 無效。
400 InvalidDBInstanceType.ValueNotSupport The specified parameter DBInstanceType is not valid.
400 InvalidParameter.OwnerAccount The specified parameter OwnerAccount is not valid. 操作失敗,參數 OwnerAccount 不合法,請檢查。
400 TimeoutRetryLater Timeout, Please retry later.
400 InvalidExpired.Format The instance expiration status parameter is incorrect. 執行個體過期狀態參數有誤。
400 Abs.InvalidAccount.NotFound account is not found. 您的阿里雲端帳號不存在,或者您的 AccessKey 已經過期。
400 Abs.ImageNotFound The specified Image is disabled or is deleted. 指定的映像已經失效或已經被刪除了。
400 Order.ComboInstanceNotAllowOperate A package instance is not allowed to operate independently. 套件執行個體不允許單獨操作。
400 Price.PricingPlanResultNotFound Pricing plan price result not found. 定價計畫價格結果沒有找到。
400 Order.NoRealNameAuthentication You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication. 您尚未通過實名認證,不符合購買條件,請登入費用與成本進行實名認證。
400 InsufficientAvailableQuota Your account quota limit is less than 0, please recharge before trying to purchase. 您的帳戶可用額度小於 0,請先儲值後再嘗試購買。
400 CommodityServiceCalling.Exception Failed to call commodity service. 呼叫商品服務傳回失敗。
400 RegionDissolvedEOM Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support. 使用者您好,阿里雲端計劃對當前地域進行最佳化調整,該區域雲端服務將停止營運,為確保您的業務連續性及資料移轉工作的平穩過渡,您目前無法操作新購類型的訂單,感謝理解與支援。
400 Commodity.InvalidComponent The module you purchased is not legal, please buy it again. 您購買的模組不合法,請重新購買。
400 RegionEndTimeDissolvedAustralia Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024. 使用者您好,該地域已裁撤。
400 Price.CommoditySys Commodity system call exception. 商品系統呼叫異常。
400 Pay.InsufficientBalance Insufficient available balance.
400 Order.PeriodInvalid There is a problem with the period you selected, please choose again. 您選購的週期有問題,請重新選購。
400 pay.noCreditCard Account not bound to credit card. 無信用卡。
400 Order.InstHasUnpaidOrder There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. 您選購的服務存在未支付訂單,請支付或作廢後再下單。
400 noAvailablePaymentMethod No payment method is specified for your account. We recommend that you add a payment method. 帳戶未指定付款方式。我們建議您新增付款方式。
400 BasicInfoUncompleted Your information is incomplete. Complete your information before the operation. 您的基本資訊未完善,請在操作前先完善您的基本資訊。
400 Risk.RiskControlRejection Your account is abnormal, please contact customer service for details. 您的帳戶出現異常,詳情請聯絡客服。
400 Api.NotSupport Specified api is not supported. 目前介面不支援。
400 ContainForbiddenLabelError There is a label that prohibits placing orders. Please contact your distributor for assistance. 存在禁止下單的標籤,請聯絡您的經銷商處理。
400 InvalidDBInstanceId.NotFound The DBInstanceId provided does not exist in records. 提供的 DBInstanceId 不存在。
400 InvalidInstanceLevel.DiskType Specified instance level not support request disk type 目前執行個體規格不支援該儲存類型。
400 InvalidParam Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. 輸入參數無效。
400 KmsApiError User secret key invalid. 使用者金鑰失效。
400 System.SaleValidateFailed Sales expression validation system error.
400 SqlExecuteFailedOrTimeout sql command execution failed or timed out:%s. SQL 命令執行失敗或執行逾時。
400 ColdData.EngineVersionNotSupport The current instance engine version not support coldDataEnabled. 目前執行個體引擎版本不支援歸檔冷資料。
400 ColdData.MinorVersionNotSupport The current instance minor version not support coldDataEnabled. 目前核心版本不支援歸檔冷資料。
400 IncorrectTargetClasscode The current instance type does not support this operation. 目前規格不支援此操作。
400 InvalidConnectionString.Duplicate Specified connection string already exists in the RDS. 連結位址名稱重複,請重新設定連線字串。
400 RequiredParam.NotFound Required input param is not found. 沒有傳入必要的參數。
400 Parameters.Invalid Parameter error, please check the parameters. 參數錯誤,請檢查參數。
400 BackupPolicyNotSupport Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy. 當前的備份策略不支援此操作。
400 InvalideStatus.Format The instance status does not support this operation. 執行個體狀態不支援此操作。
400 InvalidReleasedKeepPolicy.Format Specified Released Keep Policy is not valid. 執行個體釋放後的歸檔備份保留策略無效。
400 InvalidDBInstanceEngineType.Format the DB instance engine type does not support this operation. DB 執行個體引擎類型不支援此操作。
400 Pay.NoCreditCard No credit cards.
400 VpcNetworkTypeNotSupport The vpc network type instance does not support this operation. VPC 網路類型執行個體不支援此操作。
400 MirrorInsExists Specified DB instance mirror ins already existed. 目前資料庫執行個體映像已存在。
400 UnsupportedClassCode The specified DB instance class stops selling. 執行個體規格已停止銷售。
400 InvalidBackupSet The specified database does not exist in the backup set. 備份集中沒有指定的資料庫。
400 OrdTCommodityQueryError Failed to query for product. 查詢產品失敗。
400 ProductInstanceReleased The instance has been released. Please check before placing the order. 執行個體已釋放,請核實後下單。
400 RegionEndTimeDissolvedIndia The region is no longer supported. 指定的地域無效。
500 ExternalFailure The request processing has failed due to external service failure. 請求服務失敗,請稍後重試。
500 RequestMetaDataFailed The service request failed. Please try again later or contact service personnel. 請求服務失敗,請稍後再試或聯絡服務人員。
500 InvokeProxyFailure The request processing has failed due to service failure of rds api. 由於 RDS API 服務失敗,請求處理失敗。
403 OrderStatus.UnPaid The specified db instance has unpaid order. 執行個體當前存在未支付訂單,請支付後重試。
403 InvalidReduceDiskSize The storage capacity after the scale-down must be larger than the used amount. 縮容目標容量不能小於目前儲存空間使用量。
403 CloudSSDNotSupport Cloud ssd does not support this operation, please upgrade to essd. SSD 磁碟不支援此操作,請升級至 ESSD。
403 InvalidUserOperatorPermission The user permission does not support this operation. 使用者權限不支援此操作。
403 InvalidVswitchId Specified conn vswitch id is not valid. 指定的 VSwitchId 格式不正確或為空。
403 IncorrectMinorVersion Current engine minor version does not support operations. 目前引擎小版本不支援此操作。
403 OperationDenied.ZoneResource There is no available zone for inventory. 沒有可用的庫存區域。
403 NotInFlowController Sorry,no permission. 非集團上雲使用者不可用,無權限。
403 InvalidKmsKey Kms key is disabled. Kms key 已停用。
403 InvalidInstanceLevel.Malformed Current DB instance level does not support this operation. 目前資料庫執行個體層級不支援此操作。
404 InvalidClusterKms The current instance does not authorized to access the Key Management Service. 當前執行個體未授權存取金鑰管理服務。
404 Request.NotFound The requested resource is not available. 請求的資源不可用。
404 HostInfo.NotFound The specified host info is not found. 指定的主機資訊不存在。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情