Todos os produtos
Search
Central de documentação

:Consultar detalhes de uma instância

Última atualização: Jul 03, 2026

Chame a operação DescribeDBInstanceAttribute para consultar detalhes de uma instância.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro Tipo Obrigatório Exemplo Descrição
Action String Sim DescribeDBInstanceAttribute

A operação a ser executada. Defina o valor como DescribeDBInstanceAttribute.

DBInstanceId String Sim rm-uf6wjk5*****

O ID da instância. É possível especificar até 30 IDs de instância em uma única solicitação. Se você especificar vários IDs de instância, separe-os com vírgulas (,).

Expired String Não False

Indica se a instância expirou. Valores válidos:

  • True: A instância expirou.
  • False: A instância não expirou.

Parâmetros de resposta

Parâmetro Tipo Exemplo Descrição
RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

O ID da solicitação.

Items Array of DBInstanceAttribute

Uma matriz composta pelos detalhes da instância.

DBInstanceAttribute
VpcId String vpc-*****

O ID da Virtual Private Cloud (VPC).

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

O horário de criação da instância. O horário segue o padrão ISO 8601 no formato aaaa-MM-ddTHH:mm:ssZ e é exibido em UTC.

IncrementSourceDBInstanceId String rm-uf6wjk5*****

O ID da instância de origem dos dados incrementais. Os dados incrementais de uma instância de recuperação de desastres ou somente leitura provêm de sua instância primária. Se este parâmetro não for retornado, a instância é primária.

MaintainTime String 00:00Z-02:00Z

A janela de manutenção da instância. O horário é exibido em UTC. Observe que a janela de manutenção exibida no console do ApsaraDB RDS corresponde ao valor deste parâmetro mais 8 horas.

PayType String Postpaid

O método de faturamento da instância. Valores válidos:

  • Postpaid: pagamento conforme o uso
  • Prepaid: assinatura
AvailabilityValue String 100.0%

O status de disponibilidade da instância em porcentagem.

EngineVersion String 5.5

A versão do mecanismo de banco de dados da instância.

DedicatedHostGroupId String dhg-7a9*****

O ID do cluster dedicado ao qual a instância pertence.

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

O endpoint interno da instância.

SuperPermissionMode String Disabled

Indica se a instância oferece suporte a contas de superusuário, como a conta de administrador do sistema (SA), a conta do Active Directory (AD) e a conta de host.

  • Enable: Há suporte para contas de superusuário.
  • Disabled: Não há suporte para contas de superusuário.
InstanceNetworkType String Classic

O tipo de rede da instância. Valores válidos:

  • Classic: rede clássica
  • VPC: VPC
MasterInstanceId String rm-uf6wjk5*****

O ID da instância primária.

Nota Se este parâmetro não for retornado, a instância é a primária.
AutoUpgradeMinorVersion String Auto

O método usado para atualizar a versão secundária do mecanismo da instância. Valores válidos:

  • Auto: atualização automática.
  • Manual: atualização manual. O ApsaraDB RDS atualiza automaticamente a versão secundária atual do mecanismo da instância apenas quando essa versão for descontinuada.
ExpireTime String 2019-03-27T16:00:00Z

O horário de expiração da instância. O horário segue o padrão ISO 8601 no formato aaaa-MM-ddTHH:mm:ssZ e é exibido em UTC.

Nota Instâncias com pagamento conforme o uso nunca expiram.
AccountMaxQuantity Integer 50

O número máximo de contas que podem ser criadas na instância.

MasterZone String 5454284

O ID da zona da instância primária.

GuardDBInstanceId String rm-uf64zsu*****

O ID da instância de recuperação de desastres anexada à instância.

DBInstanceStorage Integer 10

A capacidade de armazenamento da instância. Unidade: GB.

TimeZone String Central Standard Time

O fuso horário da instância.

LatestKernelVersion String rds_20201031

A versão secundária mais recente do mecanismo suportada pela instância.

TipsLevel Integer 1

O nível de gravidade da exceção detectada na instância. Este parâmetro é retornado apenas quando a instância é criada em um cluster ApsaraDB MyBase que executa MySQL na Standard Edition. Valores válidos:

  • 1: A instância está normal.
  • 2: As especificações das instâncias somente leitura não correspondem às da instância primária. Ajuste as especificações dessas instâncias conforme os requisitos do seu negócio.
ZoneId String cn-hangzhou-a

O ID da zona da instância.

MaxConnections Integer 60

O número máximo de conexões simultâneas permitidas pela instância.

DBInstanceId String rm-uf6wjk5*****

O ID da instância.

TempDBInstanceId String rm-uf64zsu*****

O ID da instância temporária anexada à instância.

AdvancedFeatures String LinkedServer

Os recursos avançados ativados para a instância. Se houver vários recursos avançados ativados, eles serão separados por vírgulas (,). Este parâmetro está disponível apenas para instâncias que executam o SQL Server. Valores válidos:

  • LinkedServer
  • DistributeTransaction
DBInstanceStorageType String local_ssd

O tipo de armazenamento da instância. Valores válidos:

  • local_ssd e ephemeral_ssd: SSD local
  • cloud_ssd: SSD padrão
  • cloud_essd: SSD aprimorado
DBInstanceMemory Long 4096

A capacidade de memória da instância. Unidade: MB.

IPType String IPv4

O tipo de endereço IP. Apenas endereços IPv4 são suportados.

ConsoleVersion String 2

O tipo de proxy usado pela instância. Valores válidos:

  • 1: proxy compartilhado
  • 2: proxy dedicado
Nota Recomendamos usar o parâmetro ProxyType em vez deste parâmetro.
ConnectionMode String Standard

O modo de conexão da instância. Valores válidos:

  • Standard: modo padrão
  • Safe: modo proxy
Port String 3306

O número da porta interna usada para conectar-se à instância.

LockMode String Unlock

O modo de bloqueio da instância. Valores válidos:

  • Unlock: A instância não está bloqueada.
  • ManualLock: A instância foi bloqueada manualmente.
  • LockByExpiration: A instância foi bloqueada automaticamente devido à expiração.
  • LockByRestoration: A instância foi bloqueada automaticamente devido à restauração.
  • LockByDiskQuota: A instância foi bloqueada automaticamente devido ao esgotamento do armazenamento.
  • LockReadInstanceByDiskQuota: A instância é somente leitura e foi bloqueada automaticamente quando o espaço em disco ficou cheio.
GeneralGroupName String TestGroup

O nome do cluster dedicado ao qual a instância pertence. Este parâmetro é retornado apenas quando a instância é criada em um cluster ApsaraDB MyBase que executa MySQL na Standard Edition.

VpcCloudInstanceId String vpc-23rsxdf*****

O ID da VPC da instância. Este parâmetro é retornado apenas quando a instância reside em uma VPC.

Collation String Chinese_PRC_CI_AS

A ordenação do conjunto de caracteres da instância.

MaxIOPS Integer 150

O número máximo de solicitações de E/S que a instância pode processar por segundo.

MaxIOMBPS Integer 0MB/s

O throughput máximo de E/S. Unidade: MB/s.

Tips String Everything is fine.

As informações sobre a exceção detectada na instância. Este parâmetro é retornado apenas quando a instância é criada em um cluster ApsaraDB MyBase que executa MySQL na Standard Edition.

SecurityIPList String 192.168.XX.XX/24

Os endereços IP na lista de permissões de endereços IP.

SecurityIPMode String normal

O modo da lista de permissões da instância. Valores válidos:

  • normal: modo de lista de permissões padrão
  • safety: modo de lista de permissões aprimorado
DBInstanceClassType String s

A família de instâncias à qual a instância pertence. Valores válidos:

  • s: família de instâncias compartilhadas
  • x: família de instâncias de uso geral
  • d: família de instâncias dedicadas
  • h: família de instâncias de host dedicado
ProxyType Integer 1

O tipo de proxy suportado pela instância. Valores válidos:

  • 0: A instância não oferece suporte a proxies de banco de dados.
  • 1: A instância oferece suporte a proxies compartilhados, operando em modo multilocatário.
  • 2: A instância oferece suporte a proxies dedicados, operando em modo de locatário único.
CurrentKernelVersion String rds_20181010

A versão secundária do mecanismo da instância.

DBInstanceDescription String Test database

A descrição da instância.

DBInstanceCPU String 2

O número de núcleos configurados para a instância.

DBInstanceNetType String Internet

O tipo de rede pela qual a instância está conectada. Valores válidos:

  • Internet: Internet
  • Intranet: rede interna
DBInstanceType String Primary

O tipo da instância. Valores válidos:

  • Primary: instância primária
  • Readonly: instância somente leitura
  • Guard: instância de recuperação de desastres
  • Temp: instância temporária
LockReason String instance_expired

O motivo pelo qual a instância está bloqueada.

DBInstanceStatus String Running

O status da instância. Para obter mais informações, consulte Tabela de estados da instância.

DBMaxQuantity Integer 200

O número máximo de bancos de dados que podem ser criados na instância.

RegionId String cn-hangzhou

O ID da região da instância.

ReadonlyInstanceSQLDelayedTime String 30

A latência com a qual o sistema replica dados para instâncias somente leitura. O sistema replica dados da instância primária para as instâncias somente leitura com a latência especificada pelo parâmetro ReadonlyInstanceSQLDelayedTime. Unidade: segundos.

VSwitchId String vsw-*****

O ID do vSwitch.

ResourceGroupId String rg-acfmy*****

O ID do grupo de recursos.

Category String Basic

A edição do RDS da instância. Valores válidos:

  • Basic: RDS Basic Edition
  • HighAvailability: RDS High-availability Edition

  • AlwaysOn: RDS Cluster Edition para SQL Server
  • Finance: RDS Enterprise Edition
  • Serverless_basic: RDS Serverless Basic Edition
DBInstanceClass String rds.mys2.small

O tipo da instância. Para obter mais informações, consulte Tipos de instância primária do ApsaraDB RDS.

Engine String MySQL

O mecanismo de banco de dados da instância. Valores válidos:

  • MySQL
  • PostgreSQL
  • SQLServer
  • MariaDB
SlaveZones Array of SlaveZone

Uma matriz composta pelos detalhes das zonas secundárias.

SlaveZone
ZoneId String cn-hangzhou-a

O ID da zona.

ReadOnlyDBInstanceIds Array of ReadOnlyDBInstanceId

Uma matriz composta pelos IDs das instâncias somente leitura anexadas à instância primária.

ReadOnlyDBInstanceId
DBInstanceId String rm-bp*****

O ID da instância RDS somente leitura.

Extra Object

As informações estendidas da instância.

DBInstanceIds Array of String rm-uf6wjk5*****

O ID da instância.

DeletionProtection Boolean true

Indica se o recurso de proteção contra liberação está ativado. Valores válidos:

  • true: O recurso está ativado.
  • false: O recurso está desativado.
ServerlessConfig Object

As configurações da instância serverless.

ScaleMin double 0.5

O número mínimo de Unidades de Capacidade do RDS (RCUs).

ScaleMax double 8

O número máximo de RCUs.

AutoPause Boolean true

Indica se o recurso de início e parada automáticos está ativado para a instância serverless. Valores válidos:

  • true: O recurso está ativado.
  • false: O recurso está desativado. Este é o valor padrão.
Nota Após ativar o recurso de início e parada, se nenhuma conexão for estabelecida com a instância dentro de 10 minutos, ela será suspensa. Quando uma conexão for estabelecida, a instância será retomada automaticamente.
SwitchForce Boolean false

Indica se o recurso de dimensionamento forçado está ativado para a instância serverless.

  • true: O recurso está ativado.
  • false: O recurso está desativado. Este é o valor padrão.
Nota Na maioria dos casos, o ApsaraDB RDS dimensiona automaticamente as RCUs de uma instância serverless com base nos requisitos de negócios em tempo real. Em alguns casos, o dimensionamento não entra em vigor imediatamente. Ative o recurso de dimensionamento forçado para ajustar as RCUs da instância de forma imediata.
BabelfishConfig Object

A configuração do Babelfish para a instância.

Nota Este parâmetro é adequado apenas para instâncias do ApsaraDB RDS for PostgreSQL com o Babelfish ativado. Para obter mais informações, consulte Introdução ao Babelfish.
BabelfishEnabled String true

A chave para ativar ou desativar o Babelfish.

Nota Se o Babelfish estiver ativado quando você adquirir uma instância do ApsaraDB RDS for PostgreSQL, este parâmetro será fixado como true.
MigrationMode String single-db

O modo de migração para o Babelfish. Valores válidos:

  • single-db
  • multi-db
Nota Para obter mais informações sobre os modos de migração do Babelfish, consulte Modos de migração.
kindCode String None

Um parâmetro interno. Esta operação não retorna um valor para este parâmetro.

InstructionSetArch String x86

O tipo de arquitetura da instância. Valores válidos:

  • x86
  • arm
DBClusterNodes Array of DBClusterNode

As informações sobre o nó no cluster.

DBClusterNode
NodeRegionId String cn-beijing

O ID da região.

NodeZoneId String cn-beijing-h

O ID da zona da instância.

NodeId String rn-****

O ID do nó.

NodeRole String primary

A função do nó. Valores válidos:

  • primary: nó primário
  • secondary: nó secundário
ClassCode String mysql.n2.medium.xc

O tipo do nó.

Exemplos

Solicitações de exemplo

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

Respostas de sucesso de exemplo

Formato XML

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>

Formato JSON

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

Códigos de erro

Código de status HTTP

Código de erro

Mensagem de erro

Descrição

400

ConnectTimeoutRetryLater

Connect timeout retry later.

A mensagem de erro retornada porque a conexão com a instância atingiu o tempo limite. Tente novamente mais tarde.

400

DataNotExist

Data not exist.

A mensagem de erro retornada porque não há dados disponíveis.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.