:Query details about an instance

Request parameters

Response parameters

Examples

Sample requests

http(s)://rds.aliyuncs.com/?Action=DescribeDBInstanceAttribute
&DBInstanceId=rm-uf6wjk5*****
&Expired=False
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBInstanceAttributeResponse>
    <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
    <Items>
        <VpcId>vpc-*****</VpcId>
        <CreationTime>2011-05-30T12:11:04Z</CreationTime>
        <IncrementSourceDBInstanceId>rm-uf6wjk5*****</IncrementSourceDBInstanceId>
        <MaintainTime>00:00Z-02:00Z</MaintainTime>
        <PayType>Postpaid</PayType>
        <AvailabilityValue>100.0%</AvailabilityValue>
        <EngineVersion>5.5</EngineVersion>
        <DedicatedHostGroupId>dhg-7a9*****</DedicatedHostGroupId>
        <ConnectionString>rm-uf6wjk5*****.mysql.rds.aliyuncs.com</ConnectionString>
        <SuperPermissionMode>Disabled</SuperPermissionMode>
        <InstanceNetworkType>Classic</InstanceNetworkType>
        <MasterInstanceId>rm-uf6wjk5*****</MasterInstanceId>
        <AutoUpgradeMinorVersion>Auto</AutoUpgradeMinorVersion>
        <ExpireTime>2019-03-27T16:00:00Z</ExpireTime>
        <AccountMaxQuantity>50</AccountMaxQuantity>
        <MasterZone>5454284</MasterZone>
        <GuardDBInstanceId>rm-uf64zsu*****</GuardDBInstanceId>
        <DBInstanceStorage>10</DBInstanceStorage>
        <TimeZone>Central Standard Time</TimeZone>
        <LatestKernelVersion>rds_20201031</LatestKernelVersion>
        <TipsLevel>1</TipsLevel>
        <ZoneId>cn-hangzhou-a</ZoneId>
        <MaxConnections>60</MaxConnections>
        <DBInstanceId>rm-uf6wjk5*****</DBInstanceId>
        <TempDBInstanceId>rm-uf64zsu*****</TempDBInstanceId>
        <AdvancedFeatures>LinkedServer</AdvancedFeatures>
        <DBInstanceStorageType>local_ssd</DBInstanceStorageType>
        <DBInstanceMemory>4096</DBInstanceMemory>
        <IPType>IPv4</IPType>
        <ConsoleVersion>2</ConsoleVersion>
        <ConnectionMode>Standard</ConnectionMode>
        <Port>3306</Port>
        <LockMode>Unlock</LockMode>
        <GeneralGroupName>TestGroup</GeneralGroupName>
        <VpcCloudInstanceId>vpc-23rsxdf*****</VpcCloudInstanceId>
        <Collation>Chinese_PRC_CI_AS</Collation>
        <MaxIOPS>150</MaxIOPS>
        <Tips>Run as normal</Tips>
        <SecurityIPList>192.168.XX.XX/24</SecurityIPList>
        <SecurityIPMode>normal</SecurityIPMode>
        <DBInstanceClassType>s</DBInstanceClassType>
        <ProxyType>1</ProxyType>
        <CurrentKernelVersion>rds_20181010</CurrentKernelVersion>
        <DBInstanceDescription>Test database</DBInstanceDescription>
        <DBInstanceCPU>2</DBInstanceCPU>
        <DBInstanceNetType>Internet</DBInstanceNetType>
        <DBInstanceType>Primary</DBInstanceType>
        <LockReason>instance_expired</LockReason>
        <DBInstanceStatus>Running</DBInstanceStatus>
        <DBMaxQuantity>200</DBMaxQuantity>
        <RegionId>cn-hangzhou </RegionId>
        <ReadonlyInstanceSQLDelayedTime>30</ReadonlyInstanceSQLDelayedTime>
        <VSwitchId>vsw-*****</VSwitchId>
        <ResourceGroupId>rg-acfmy*****</ResourceGroupId>
        <Category>Basic</Category>
        <DBInstanceClass>rds.mys2.small</DBInstanceClass>
        <Engine>MySQL</Engine>
        <SlaveZones>
            <ZoneId>cn-hangzhou-a</ZoneId>
        </SlaveZones>
        <ReadOnlyDBInstanceIds>
            <DBInstanceId>rm-bp*****</DBInstanceId>
        </ReadOnlyDBInstanceIds>
        <Extra>
            <DBInstanceIds>rm-uf6wjk5*****</DBInstanceIds>
        </Extra>
        <DeletionProtection>true</DeletionProtection>
        <ServerlessConfig>
            <ScaleMin>0.5</ScaleMin>
            <ScaleMax>8</ScaleMax>
            <AutoPause>true</AutoPause>
            <SwitchForce>false</SwitchForce>
        </ServerlessConfig>
        <BabelfishConfig>
            <BabelfishEnabled>true</BabelfishEnabled>
            <MigrationMode>single-db</MigrationMode>
        </BabelfishConfig>
        <kindCode>None</kindCode>
        <InstructionSetArch>x86</InstructionSetArch>
        <DBClusterNodes>
            <NodeRegionId>cn-beijing</NodeRegionId>
            <NodeZoneId>cn-beijing-h</NodeZoneId>
            <NodeId>rn-****</NodeId>
            <NodeRole>primary</NodeRole>
            <ClassCode>mysql.n2.medium.xc</ClassCode>
        </DBClusterNodes>
    </Items>
</DescribeDBInstanceAttributeResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Items" : [ {
    "VpcId" : "vpc-*****",
    "CreationTime" : "2011-05-30T12:11:04Z",
    "IncrementSourceDBInstanceId" : "rm-uf6wjk5*****",
    "MaintainTime" : "00:00Z-02:00Z",
    "PayType" : "Postpaid",
    "AvailabilityValue" : "100.0%",
    "EngineVersion" : "5.5",
    "DedicatedHostGroupId" : "dhg-7a9*****",
    "ConnectionString" : "rm-uf6wjk5*****.mysql.rds.aliyuncs.com",
    "SuperPermissionMode" : "Disabled",
    "InstanceNetworkType" : "Classic",
    "MasterInstanceId" : "rm-uf6wjk5*****",
    "AutoUpgradeMinorVersion" : "Auto",
    "ExpireTime" : "2019-03-27T16:00:00Z",
    "AccountMaxQuantity" : 50,
    "MasterZone" : "5454284",
    "GuardDBInstanceId" : "rm-uf64zsu*****",
    "DBInstanceStorage" : 10,
    "TimeZone" : "Central Standard Time",
    "LatestKernelVersion" : "rds_20201031",
    "TipsLevel" : 1,
    "ZoneId" : "cn-hangzhou-a",
    "MaxConnections" : 60,
    "DBInstanceId" : "rm-uf6wjk5*****",
    "TempDBInstanceId" : "rm-uf64zsu*****",
    "AdvancedFeatures" : "LinkedServer",
    "DBInstanceStorageType" : "local_ssd",
    "DBInstanceMemory" : 4096,
    "IPType" : "IPv4",
    "ConsoleVersion" : "2",
    "ConnectionMode" : "Standard",
    "Port" : "3306",
    "LockMode" : "Unlock",
    "GeneralGroupName" : "TestGroup",
    "VpcCloudInstanceId" : "vpc-23rsxdf*****",
    "Collation" : "Chinese_PRC_CI_AS",
    "MaxIOPS" : 150,
    "Tips" : "Run as normal",
    "SecurityIPList" : "192.168.XX.XX/24",
    "SecurityIPMode" : "normal",
    "DBInstanceClassType" : "s",
    "ProxyType" : 1,
    "CurrentKernelVersion" : "rds_20181010",
    "DBInstanceDescription": "Test database",
    "DBInstanceCPU" : "2",
    "DBInstanceNetType" : "Internet",
    "DBInstanceType" : "Primary",
    "LockReason" : "instance_expired",
    "DBInstanceStatus" : "Running",
    "DBMaxQuantity" : 200,
    "RegionId" : "cn-hangzhou ",
    "ReadonlyInstanceSQLDelayedTime" : "30",
    "VSwitchId" : "vsw-*****",
    "ResourceGroupId" : "rg-acfmy*****",
    "Category" : "Basic",
    "DBInstanceClass" : "rds.mys2.small",
    "Engine" : "MySQL",
    "SlaveZones" : [ {
      "ZoneId" : "cn-hangzhou-a"
    } ],
    "ReadOnlyDBInstanceIds" : [ {
      "DBInstanceId" : "rm-bp*****"
    } ],
    "Extra" : {
      "DBInstanceIds" : [ "rm-uf6wjk5*****" ]
    },
    "DeletionProtection" : true,
    "ServerlessConfig" : {
      "ScaleMin" : 0.5,
      "ScaleMax" : 8,
      "AutoPause" : true,
      "SwitchForce" : false
    },
    "BabelfishConfig" : {
      "BabelfishEnabled" : "true",
      "MigrationMode" : "single-db"
    },
    "kindCode" : "None",
    "InstructionSetArch" : "x86",
    "DBClusterNodes" : [ {
      "NodeRegionId" : "cn-beijing",
      "NodeZoneId" : "cn-beijing-h",
      "NodeId" : "rn-****",
      "NodeRole" : "primary",
      "ClassCode" : "mysql.n2.medium.xc"
    } ]
  } ]
}

Error codes

For a list of error codes, see Service error codes.