調用DescribeDBInstanceAttribute介面查看RDS執行個體的詳細資料。

調試

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

請求參數

名稱 類型 是否必選 樣本值 描述
Action String DescribeDBInstanceAttribute

系統規定參數,取值:DescribeDBInstanceAttribute

DBInstanceId String rm-uf6wjk5xxxxxxxxxx

執行個體ID。可以一次輸入最多30個,以英文逗號(,)分隔。

Expired String False

執行個體到期狀態,取值:

  • True:已到期;
  • False:未到期。

返回資料

名稱 類型 樣本值 描述
Items

DBInstanceAttribute的參數。

DBInstanceId String rm-uf6wjk5xxxxxxxxxx

執行個體ID。

PayType String Postpaid

執行個體付費方式,取值:

  • Postpaid:隨用隨付;
  • Prepaid:訂用帳戶。
DBInstanceType String Primary

執行個體類型,取值:

  • Primary:主執行個體;
  • Readonly:唯讀執行個體;
  • Guard:災備執行個體;
  • Temp:臨時執行個體。
Category String Basic

執行個體系列,取值:

  • Basic:基礎版;
  • HighAvailability:高可用版;
  • AlwaysOn:叢集版;
  • Finance:金融版(僅中國站支援)。
InstanceNetworkType String Classic

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

  • Classic:傳統網路;
  • VPC:專用網路。
RegionId String cn-hangzhou

地區ID。

ZoneId String cn-hangzhou-a

可用性區域ID。

ConnectionString String rm-uf6wjk5xxxxxxxxxx.mysql.rds.aliyuncs.com

內網串連地址。

Port String 3306

內網串連連接埠。

Engine String MySQL

資料庫類型。

EngineVersion String 5.5

資料庫版本。

DBInstanceClassType String s

執行個體規格類型系列,取值:

  • s:共用型;
  • x:通用型;
  • d:獨享套餐;
  • h:獨佔物理機。
DBInstanceClass String rds.mys2.small

執行個體規格,詳情請參見執行個體規格表

DBInstanceMemory Long 4096

執行個體記憶體,單位:M。

DBInstanceStorage Integer 10

執行個體儲存空間,單位:GB。

DBInstanceNetType String Internet

執行個體是內網或外網,取值:

  • Internet:外網;
  • Intranet:內網。
DBInstanceStatus String Running

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

DBInstanceDescription String 測試資料庫

執行個體備忘。

LockMode String Unlock

執行個體鎖定模式:

  • Unlock:正常;
  • ManualLock:手動觸發鎖定;
  • LockByExpiration:執行個體到期自動鎖定;
  • LockByRestoration:執行個體復原前的自動鎖定;
  • LockByDiskQuota:執行個體空間滿自動鎖定。
LockReason String instance_expired

鎖定原因。

DBMaxQuantity Integer 200

一個執行個體下可建立最大資料庫數量。

AccountMaxQuantity Integer 50

可建立帳號的最大數量。

CreationTime String 2011-05-30T12:11:04Z

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

ExpireTime String 2019-03-27T16:00:00Z

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

说明 隨用隨付執行個體無到期時間。
MaintainTime String 00:00Z-02:00Z

執行個體可維護時間段,是UTC時間,+8小時才是控制台上顯示的可維護時間段。

AvailabilityValue String 100.0%

執行個體可用性狀態,單位:百分比。

MaxIOPS Integer 150

最大每秒IO請求次數。

MaxConnections Integer 60

最大並發串連數。

MasterInstanceId String rm-uf6wjk5xxxxxxxxxx

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

IncrementSourceDBInstanceId String rm-uf6wjk5xxxxxxxxxx

增量資料來源的執行個體ID,如災備執行個體的增量資料來源是主執行個體。唯讀執行個體的增量資料來源是主執行個體,如果沒有返回此參數(即為null)則表示該執行個體是主執行個體。

GuardDBInstanceId String rm-uf64zsuxxxxxxxxxx

該執行個體如果掛載著災備執行個體,即為災備執行個體的ID。

TempDBInstanceId String rm-uf64zsuxxxxxxxxxx

該執行個體如果掛載著臨時執行個體,即為臨時執行個體ID。

ReadOnlyDBInstanceIds

主執行個體下掛載的唯讀執行個體ID列表。

DBInstanceId String rm-bpxxxxxxxxx

唯讀執行個體ID。

AdvancedFeatures String LinkedServer

目前只針對SQL Server,擷取進階特性值,多個值之間用英文逗號(,)隔開,現傳回值如下:

  • LinkedServer:連結的伺服器;
  • DistributeTransaction:分散式交易。
AutoUpgradeMinorVersion String Auto

執行個體升級小版本的方式,取值:

  • Auto:自動升級小版本;
  • Manual:不自動升級,僅在目前的版本下線時才強制升級。
Collation String Chinese_PRC_CI_AS

系統字元集定序。

ConnectionMode String Standard

執行個體的訪問模式,取值:

  • Standard:標準訪問模式;
  • Safe:資料庫代理模式。
CurrentKernelVersion String rds_20181010

當前核心版本。

DBInstanceStorageType String local_ssd

執行個體儲存類型,取值:

  • local_ssd/ephemeral_ssd:本地SSD盤;
  • cloud_ssd:SSD雲端硬碟;
  • cloud_essd:ESSD雲端硬碟。
Extra

擴充資訊。

DBInstanceId rm-uf6wjk5xxxxxxxxxx

執行個體ID。

MasterZone String 5454284

主可用性區域ID。

ReadonlyInstanceSQLDelayedTime String 30

唯讀執行個體延遲複製時間,唯讀執行個體延遲ReadonlyInstanceSQLDelayedTime的時間後再同步主執行個體資料,單位:秒。

ResourceGroupId String rg-acfmyxxxxxxxxxx

資源群組ID。

SecurityIPMode String normal

白名單模式。

SlaveZones

組成SlaveZones的參數。

ZoneId String cn-hangzhou-a

可用性區域。

TimeZone String Central Standard Time

時區。

VSwitchId String vsw-xxxxxx

交換器ID。

VpcCloudInstanceId String vpc-23rsxdfxxxxxxx

專用網路執行個體ID。

VpcId String vpc-xxxxxxxxx

VPC ID。

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

請求ID。

樣本

請求樣本


http(s)://rds.aliyuncs.com/?Action=DescribeDBInstanceAttribute
&DBInstanceId=rm-uf6wjk5xxxxxxxxxx
&<公用請求參數>

正常返回樣本

XML 格式

<DescribeDBInstanceAttributeResponse>
		  <Items>
		    <DBInstanceAttribute>
			      <Extra>
				        <DBInstanceId></DBInstanceId>
			      </Extra>
			      <ConnectionString>rm-uf6wjk5xxxxxxxxxx.mysql.rds.aliyuncs.com</ConnectionString>
			      <AccountMaxQuantity>99999</AccountMaxQuantity>
			      <CurrentKernelVersion>rds_20170714</CurrentKernelVersion>
			      <DBInstanceCPU>2</DBInstanceCPU>
			      <ZoneId>cn-hangzhou-f</ZoneId>
			      <ReadOnlyDBInstanceIds></ReadOnlyDBInstanceIds>
			      <ConnectionMode>Standard</ConnectionMode>
			      <VSwitchId>vsw-bp1w9oueixxxxx</VSwitchId>
			      <VpcId>vpc-bp1opxu1zkhxxxxx</VpcId>
			      <Engine>MySQL</Engine>
			      <MaintainTime>18:00Z-22:00Z</MaintainTime>
			      <MaxConnections>4000</MaxConnections>
			      <DBInstanceType>Primary</DBInstanceType>
			      <DBInstanceMemory>4096</DBInstanceMemory>
			      <EngineVersion>5.7</EngineVersion>
			      <DBInstanceStorageType>cloud_ssd</DBInstanceStorageType>
			      <DBInstanceStatus>Running</DBInstanceStatus>
			      <SecurityIPMode>normal</SecurityIPMode>
			      <PayType>Prepaid</PayType>
			      <SupportUpgradeAccountType>No</SupportUpgradeAccountType>
			      <AccountType>Mix</AccountType>
			      <LockMode>Unlock</LockMode>
			      <DBInstanceNetType>Intranet</DBInstanceNetType>
			      <MaxIOPS>600</MaxIOPS>
			      <DBInstanceClass>mysql.n2.medium.1</DBInstanceClass>
			      <DBMaxQuantity>99999</DBMaxQuantity>
			      <ResourceGroupId>rg-acfmyxxxxx</ResourceGroupId>
			      <DBInstanceId>rm-bp176xxxxx</DBInstanceId>
			      <VpcCloudInstanceId>rm-bp176gz7xxxxx</VpcCloudInstanceId>
			      <DBInstanceClassType>x</DBInstanceClassType>
			      <LatestKernelVersion></LatestKernelVersion>
			      <InstanceNetworkType>VPC</InstanceNetworkType>
			      <DBInstanceStorage>20</DBInstanceStorage>
			      <SupportCreateSuperAccount>No</SupportCreateSuperAccount>
			      <CreationTime>2018-11-28T01:32:08Z</CreationTime>
			      <Category>Basic</Category>
			      <Port>3306</Port>
			      <InsId>1</InsId>
			      <ExpireTime>2018-12-28T16:00:00Z</ExpireTime>
			      <RegionId>cn-hangzhou</RegionId>
			      <AvailabilityValue>100.0%</AvailabilityValue>
			      <SecurityIPList>1.1.1.1</SecurityIPList>
		    </DBInstanceAttribute>
	  </Items>
	  <RequestId>CFE76192-2F85-4D18-975E-465B77C129C4</RequestId>
	</DescribeDBInstanceAttributeResponse>

JSON 格式

{
	"Items":{
		"DBInstanceAttribute":[
			{
				"AccountMaxQuantity":99999,
				"ConnectionString":"rm-uf6wjk5xxxxxxxxxx.mysql.rds.aliyuncs.com",
				"Extra":{
					"DBInstanceId":{
						"DBInstanceId":[]
					}
				},
				"CurrentKernelVersion":"rds_20170714",
				"DBInstanceCPU":"2",
				"ZoneId":"cn-hangzhou-f",
				"ConnectionMode":"Standard",
				"ReadOnlyDBInstanceIds":{
					"ReadOnlyDBInstanceId":[]
				},
				"VSwitchId":"vsw-bp1w9oueixxxxx",
				"Engine":"MySQL",
				"VpcId":"vpc-bp1opxu1zkhxxxxx",
				"MaintainTime":"18:00Z-22:00Z",
				"MaxConnections":4000,
				"DBInstanceType":"Primary",
				"DBInstanceMemory":4096,
				"EngineVersion":"5.7",
				"DBInstanceStorageType":"cloud_ssd",
				"DBInstanceStatus":"Running",
				"SecurityIPMode":"normal",
				"PayType":"Prepaid",
				"SupportUpgradeAccountType":"No",
				"AccountType":"Mix",
				"LockMode":"Unlock",
				"DBInstanceNetType":"Intranet",
				"MaxIOPS":600,
				"DBInstanceClass":"mysql.n2.medium.1",
				"DBMaxQuantity":99999,
				"DBInstanceId":"rm-bp176xxxxx",
				"ResourceGroupId":"rg-acfmyxxxxx",
				"VpcCloudInstanceId":"rm-bp176gz7xxxxx",
				"DBInstanceClassType":"x",
				"LatestKernelVersion":"",
				"InstanceNetworkType":"VPC",
				"DBInstanceStorage":20,
				"SupportCreateSuperAccount":"No",
				"CreationTime":"2018-11-28T01:32:08Z",
				"Port":"3306",
				"Category":"Basic",
				"InsId":1,
				"ExpireTime":"2018-12-28T16:00:00Z",
				"AvailabilityValue":"100.0%",
				"RegionId":"cn-hangzhou",
				"SecurityIPList":"1.1.1.1"
			}
		]
	},
	"RequestId":"CFE76192-2F85-4D18-975E-465B77C129C4"
}

錯誤碼

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