Consulta de detalles de una instancia - - Centro de documentación de Alibaba Cloud

Puede llamar a la operación DescribeDBInstanceAttribute para consultar los detalles de una instancia.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos que llame a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	DescribeDBInstanceAttribute	La operación que desea ejecutar. Establezca el valor en DescribeDBInstanceAttribute.
DBInstanceId	String	Sí	rm-uf6wjk5*****	El ID de la instancia. Puede especificar hasta 30 ID de instancia en una sola solicitud. Si especifica varios ID de instancia, sepárelos con comas (,).
Expired	String	No	False	Especifica si la instancia ha caducado. Valores válidos: True: La instancia ha caducado. False: La instancia no ha caducado.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
RequestId	String	1AD222E9-E606-4A42-BF6D-8A4442913CEF	El ID de la solicitud.
Items	Array of DBInstanceAttribute		Una matriz que contiene los detalles de la instancia.
DBInstanceAttribute
VpcId	String	vpc-*****	El ID de la nube privada virtual (VPC).
CreationTime	String	2011-05-30T12:11:04Z	La hora en que se creó la instancia. La hora sigue el estándar ISO 8601 con el formato aaaa-MM-ddTHH:mm:ssZ y se muestra en UTC.
IncrementSourceDBInstanceId	String	rm-uf6wjk5*****	El ID de la instancia de origen de los datos incrementales. Los datos incrementales de una instancia de recuperación ante desastres o de solo lectura provienen de su instancia principal. Si este parámetro no se devuelve, significa que la instancia es principal.
MaintainTime	String	00:00Z-02:00Z	La ventana de mantenimiento de la instancia. La hora se muestra en UTC. Tenga en cuenta que la ventana de mantenimiento mostrada en la consola de ApsaraDB RDS equivale al valor de este parámetro más 8 horas.
PayType	String	Postpaid	El método de facturación de la instancia. Valores válidos: Postpaid: pay-as-you-go Prepaid: suscripción
AvailabilityValue	String	100.0%	El estado de disponibilidad de la instancia en porcentaje.
EngineVersion	String	5.5	La versión del motor de base de datos de la instancia.
DedicatedHostGroupId	String	dhg-7a9*****	El ID del clúster dedicado al que pertenece la instancia.
ConnectionString	String	rm-uf6wjk5*****.mysql.rds.aliyuncs.com	El endpoint interno de la instancia.
SuperPermissionMode	String	Disabled	Indica si la instancia admite cuentas de superusuario, como la cuenta de administrador del sistema (SA), la cuenta de Active Directory (AD) y la cuenta de host. Enable: Se admiten cuentas de superusuario. Disabled: No se admiten cuentas de superusuario.
InstanceNetworkType	String	Classic	El tipo de red de la instancia. Valores válidos: Classic: red clásica VPC: VPC
MasterInstanceId	String	rm-uf6wjk5*****	El ID de la instancia principal. Nota Si este parámetro no se devuelve, significa que la instancia es principal.
AutoUpgradeMinorVersion	String	Auto	El método utilizado para actualizar la versión menor del motor de la instancia. Valores válidos: Auto: actualización automática. Manual: actualización manual. ApsaraDB RDS actualiza automáticamente la versión menor actual del motor de la instancia solo cuando dicha versión queda obsoleta.
ExpireTime	String	2019-03-27T16:00:00Z	La hora en que caduca la instancia. La hora sigue el estándar ISO 8601 con el formato aaaa-MM-ddTHH:mm:ssZ y se muestra en UTC. Nota Las instancias pay-as-you-go nunca caducan.
AccountMaxQuantity	Integer	50	El número máximo de cuentas que se pueden crear en la instancia.
MasterZone	String	5454284	El ID de zona de la instancia principal.
GuardDBInstanceId	String	rm-uf64zsu*****	El ID de la instancia de recuperación ante desastres asociada a la instancia.
DBInstanceStorage	Integer	10	La capacidad de almacenamiento de la instancia. Unidad: GB.
TimeZone	String	Central Standard Time	La zona horaria de la instancia.
LatestKernelVersion	String	rds_20201031	La versión menor más reciente del motor compatible con la instancia.
TipsLevel	Integer	1	El nivel de gravedad de la excepción detectada en la instancia. Este parámetro se devuelve solo cuando la instancia se crea en un clúster de ApsaraDB MyBase que ejecuta MySQL en Standard Edition. Valores válidos: 1: La instancia funciona con normalidad. 2: Las especificaciones de las instancias de solo lectura no coinciden con las de la instancia principal. Debe ajustar las especificaciones de estas instancias según sus necesidades empresariales.
ZoneId	String	cn-hangzhou-a	El ID de zona de la instancia.
MaxConnections	Integer	60	El número máximo de conexiones simultáneas permitidas por la instancia.
DBInstanceId	String	rm-uf6wjk5*****	El ID de la instancia.
TempDBInstanceId	String	rm-uf64zsu*****	El ID de la instancia temporal asociada a la instancia.
AdvancedFeatures	String	LinkedServer	Las funciones avanzadas habilitadas para la instancia. Si hay varias funciones avanzadas habilitadas, estas se separan con comas (,). Este parámetro solo está disponible para instancias que ejecutan SQL Server. Valores válidos: LinkedServer DistributeTransaction
DBInstanceStorageType	String	local_ssd	El tipo de almacenamiento de la instancia. Valores válidos: local_ssd y ephemeral_ssd: SSD local cloud_ssd: SSD estándar cloud_essd: SSD mejorado
DBInstanceMemory	Long	4,096	La capacidad de memoria de la instancia. Unidad: MB.
IPType	String	IPv4	El tipo de dirección IP. Solo se admiten direcciones IPv4.
ConsoleVersion	String	2	El tipo de proxy utilizado por la instancia. Valores válidos: 1: proxy compartido 2: proxy dedicado Nota Se recomienda utilizar el parámetro ProxyType en lugar de este parámetro.
ConnectionMode	String	Standard	El modo de conexión de la instancia. Valores válidos: Standard: modo estándar Safe: modo proxy
Port	String	3306	El número de puerto interno utilizado para conectarse a la instancia.
LockMode	String	Unlock	El modo de bloqueo de la instancia. Valores válidos: Unlock: La instancia no está bloqueada. ManualLock: La instancia está bloqueada manualmente. LockByExpiration: La instancia se bloqueó automáticamente debido a su caducidad. LockByRestoration: La instancia se bloqueó automáticamente debido a una restauración. LockByDiskQuota: La instancia se bloqueó automáticamente porque se agotó el almacenamiento. LockReadInstanceByDiskQuota: La instancia es una instancia de solo lectura que se bloqueó automáticamente al llenarse el espacio en disco.
GeneralGroupName	String	TestGroup	El nombre del clúster dedicado al que pertenece la instancia. Este parámetro se devuelve solo cuando la instancia se crea en un clúster de ApsaraDB MyBase que ejecuta MySQL en Standard Edition.
VpcCloudInstanceId	String	vpc-23rsxdf*****	El ID de VPC de la instancia. Este parámetro se devuelve solo cuando la instancia reside en una VPC.
Collation	String	Chinese_PRC_CI_AS	La intercalación del conjunto de caracteres de la instancia.
MaxIOPS	Integer	150	El número máximo de solicitudes de E/S que la instancia puede procesar por segundo.
MaxIOMBPS	Integer	0MB/s	El rendimiento máximo de E/S. Unidad: MB/s.
Tips	String	Everything is fine.	La información sobre la excepción detectada en la instancia. Este parámetro se devuelve solo cuando la instancia se crea en un clúster de ApsaraDB MyBase que ejecuta MySQL en Standard Edition.
SecurityIPList	String	192.168.XX.XX/24	Las direcciones IP en la lista blanca de direcciones IP.
SecurityIPMode	String	normal	El modo de lista blanca de la instancia. Valores válidos: normal: modo de lista blanca estándar safety: modo de lista blanca mejorado
DBInstanceClassType	String	s	La familia de instancias a la que pertenece la instancia. Valores válidos: s: familia de instancias compartidas x: familia de instancias de propósito general d: familia de instancias dedicadas h: familia de instancias de host dedicado
ProxyType	Integer	1	El tipo de proxy compatible con la instancia. Valores válidos: 0: La instancia no admite proxies de base de datos. 1: La instancia admite proxies compartidos, con los cuales se ejecuta en modo multiinquilino. 2: La instancia admite proxies dedicados, con los cuales se ejecuta en modo de inquilino único.
CurrentKernelVersion	String	rds_20181010	La versión menor del motor de la instancia.
DBInstanceDescription	String	Test database	La descripción de la instancia.
DBInstanceCPU	String	2	El número de núcleos configurados para la instancia.
DBInstanceNetType	String	Internet	El tipo de red mediante la cual se conecta la instancia. Valores válidos: Internet: Internet Intranet: red interna
DBInstanceType	String	Primary	El tipo de la instancia. Valores válidos: Primary: instancia principal Readonly: instancia de solo lectura Guard: instancia de recuperación ante desastres Temp: instancia temporal
LockReason	String	instance_expired	El motivo por el que la instancia está bloqueada.
DBInstanceStatus	String	Running	El estado de la instancia. Para obtener más información, consulte Tabla de estados de instancia.
DBMaxQuantity	Integer	200	El número máximo de bases de datos que se pueden crear en la instancia.
RegionId	String	cn-hangzhou	El ID de región de la instancia.
ReadonlyInstanceSQLDelayedTime	String	30	La latencia con la que el sistema replica datos a las instancias de solo lectura. El sistema replica datos de la instancia principal a las instancias de solo lectura con la latencia especificada por el parámetro ReadonlyInstanceSQLDelayedTime. Unidad: segundos.
VSwitchId	String	vsw-*****	El ID del vSwitch.
ResourceGroupId	String	rg-acfmy*****	El ID del resource group.
Category	String	Basic	La edición de RDS de la instancia. 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	El tipo de la instancia. Para obtener más información, consulte Tipos de instancias principales de ApsaraDB RDS.
Engine	String	MySQL	El motor de base de datos de la instancia. Valores válidos: MySQL PostgreSQL SQLServer MariaDB
SlaveZones	Array of SlaveZone		Una matriz que contiene los detalles de las zonas secundarias.
SlaveZone
ZoneId	String	cn-hangzhou-a	El ID de la zona.
ReadOnlyDBInstanceIds	Array of ReadOnlyDBInstanceId		Una matriz que contiene los ID de las instancias de solo lectura asociadas a la instancia principal.
ReadOnlyDBInstanceId
DBInstanceId	String	rm-bp*****	El ID de la instancia de RDS de solo lectura.
Extra	Object		La información extendida de la instancia.
DBInstanceIds	Array of String	rm-uf6wjk5*****	El ID de la instancia.
DeletionProtection	Boolean	true	Indica si la función de protección contra liberación está habilitada. Valores válidos: true: La función está habilitada. false: La función está deshabilitada.
ServerlessConfig	Object		La configuración de la instancia serverless.
ScaleMin	double	0.5	El número mínimo de Unidades de Capacidad de RDS (RCU).
ScaleMax	double	8	El número máximo de RCU.
AutoPause	Boolean	true	Indica si la función de inicio y detención automáticos está habilitada para la instancia serverless. Valores válidos: true: La función está habilitada. false: La función está deshabilitada. Este es el valor predeterminado. Nota Una vez habilitada la función de inicio y detención, si no se establecen conexiones a la instancia en un lapso de 10 minutos, la instancia se suspende. Cuando se establece una conexión a la instancia, esta se reanuda automáticamente.
SwitchForce	Boolean	false	Indica si la función de escalado forzado está habilitada para la instancia serverless. true: La función está habilitada. false: La función está deshabilitada. Este es el valor predeterminado. Nota En la mayoría de los casos, ApsaraDB RDS escala horizontal o verticalmente las RCU de una instancia serverless de forma automática según las necesidades empresariales en tiempo real. En algunos casos, el escalado no surte efecto en tiempo real. Puede habilitar la función de escalado forzado para escalar horizontal o verticalmente las RCU de la instancia de manera forzosa.
BabelfishConfig	Object		La configuración de Babelfish para la instancia. Nota Este parámetro solo es adecuado para instancias de ApsaraDB RDS for PostgreSQL con Babelfish habilitado. Para obtener más información, consulte Introducción a Babelfish.
BabelfishEnabled	String	true	El modificador para habilitar o deshabilitar Babelfish. Nota Si Babelfish está habilitado al adquirir una instancia de ApsaraDB RDS for PostgreSQL, este parámetro se fija en true.
MigrationMode	String	single-db	El modo de migración para Babelfish. Valores válidos: single-db multi-db Nota Para obtener más información sobre los modos de migración de Babelfish, consulte Modos de migración.
kindCode	String	None	Un parámetro interno. Esta operación no devuelve un valor para este parámetro.
InstructionSetArch	String	x86	El tipo de arquitectura de la instancia. Valores válidos: x86 arm
DBClusterNodes	Array of DBClusterNode		La información sobre el nodo en el clúster.
DBClusterNode
NodeRegionId	String	cn-beijing	El ID de la región.
NodeZoneId	String	cn-beijing-h	El ID de zona de la instancia.
NodeId	String	rn-****	El ID del nodo.
NodeRole	String	primary	El rol del nodo. Valores válidos: primary: nodo principal secondary: nodo secundario
ClassCode	String	mysql.n2.medium.xc	El tipo del nodo.

Ejemplos

Solicitudes de ejemplo

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

Respuestas exitosas de ejemplo

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 error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	ConnectTimeoutRetryLater	Connect timeout retry later.	El mensaje de error devuelto porque la conexión a la instancia agotó el tiempo de espera. Inténtelo de nuevo más tarde.
400	DataNotExist	Data not exist.	El mensaje de error devuelto porque no hay datos disponibles.

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.