DescribeDBInstances - ApsaraDB RDS - Centro de documentación de Alibaba Cloud

Consulta una lista de instancias de ApsaraDB RDS.

Descripción de la operación

Motores compatibles

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

rds:DescribeDBInstances

get

DBInstance.

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

rds:ResourceTag
rds:ResourceTag
rds:ResourceTag
rds:ResourceTag

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ClientToken	string	No	El token de cliente que se utiliza para garantizar la idempotencia de la solicitud. Puede utilizar el cliente para generar el token, pero debe asegurarse de que el token sea único entre diferentes solicitudes. El token solo puede contener caracteres ASCII y no puede exceder los 64 caracteres de longitud.	ETnLKlblzczshOTUbOCz****
proxyId	string	No	Un parámetro obsoleto. No necesita configurar este parámetro.	API
Engine	string	No	El motor de base de datos. Valores válidos: MySQL SQLServer PostgreSQL MariaDB De forma predeterminada, se devuelven instancias de todos los motores de base de datos.	MySQL
ZoneId	string	No	El ID de la zona.	cn-hangzhou-a
ResourceGroupId	string	No	El ID del grupo de recursos.	rg-acfmy****
DBInstanceStatus	string	No	El estado de la instancia. Para obtener más información, consulte Estados de las instancias.	Running
Expired	string	No	El estado de caducidad de la instancia. Valores válidos:	True
SearchKey	string	No	La palabra clave que se utiliza para la búsqueda aproximada por ID de instancia o descripción de instancia.	rm-uf6w
DBInstanceId	string	No	El ID de la instancia.	rm-uf6wjk5****
DBInstanceType	string	No	El tipo de instancia. Valores válidos:	Primary
RegionId	string	Sí	El ID de la región. Puede llamar a DescribeRegions para consultar las regiones disponibles.	cn-hangzhou
PageSize	integer	No	El número de entradas por página. Valores válidos: 1 a 100.	30
PageNumber	integer	No	El número de página. El valor debe ser un entero positivo que no exceda el valor máximo del tipo de datos Integer.	1
InstanceNetworkType	string	No	El tipo de red de la instancia. Valores válidos:	Classic
VpcId	string	No	ID de VPC.	vpc-uf6f7l4fg90****
VSwitchId	string	No	El ID del vSwitch.	vsw-uf6adz52c2p****
DBInstanceClass	string	No	El tipo de instancia. Para obtener más información, consulte Tipos de instancias.	rds.mys2.small
EngineVersion	string	No	La versión del motor de base de datos.	8.0
PayType	string	No	El método de facturación. Valores válidos:	Postpaid
ConnectionMode	string	No	El modo de acceso de la instancia. Valores válidos:	Standard
Tags	string	No	Las etiquetas vinculadas a la instancia. Cada etiqueta consta de una TagKey y una TagValue. Puede especificar hasta cinco pares de etiquetas a la vez. Formato: {"key1":"value1","key2":"value2"...}. Si alguna etiqueta especificada coincide, se devuelve la información de la instancia.	{"key1":"value1"}
DedicatedHostGroupId	string	No	El ID del clúster dedicado.	dhg-7a9****
DedicatedHostId	string	No	El ID del host en el clúster dedicado.	i-bp****
InstanceLevel	integer	No	Especifica si se debe devolver la información de la edición (Category) de la instancia. Valores válidos:	0
QueryAutoRenewal	boolean	No	Un parámetro reservado. No necesita configurar este parámetro.	test
ConnectionString	string	No	El endpoint de la instancia. Este parámetro se utiliza para consultar la instancia que utiliza el endpoint especificado.	rm-uf6wjk5****.mysql.rds.aliyuncs.com
NextToken	string	No	El token de paginación. Establezca este parámetro en el valor de NextToken devuelto en la última llamada a la operación DescribeDBInstances. Si los resultados abarcan varias páginas, puede utilizar este token para recuperar la siguiente página.	o7PORW5o2TJg****
MaxResults	integer	No	El número de entradas por página. Valores válidos: 1 a 100. Valor predeterminado: 30. Nota Si especifica este parámetro, los parámetros PageSize y PageNumber no estarán disponibles.	30
Filter	string	No	La cadena JSON que consiste en condiciones de filtro de instancias y sus valores.	{"babelfishEnabled":"true"}
Category	string	No	La edición de la instancia. Valores válidos:	cluster

Esta operación admite los siguientes dos métodos para ver los datos devueltos:

Método 1: Establezca el parámetro MaxResults para especificar el número de registros por página y utilice el parámetro NextToken para configurar el token de paginación que muestra la siguiente página. Establezca NextToken en el valor de NextToken devuelto por la llamada anterior a la operación DescribeDBInstances.

Nota

Cuando llame a esta operación por primera vez para realizar una consulta paginada, configure únicamente MaxResults. La operación devuelve la primera página de datos y el valor de NextToken.

Método 2: Establezca el parámetro PageSize para especificar el número de registros por página y utilice el parámetro PageNumber para navegar entre páginas.

Nota

Solo puede utilizar uno de los métodos anteriores. Cuando se devuelve una gran cantidad de registros, se recomienda el Método 1 para obtener un rendimiento de consulta más rápido.

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
Items	object
DBInstance	array<object>	La lista de instancias.
	array<object>	Los detalles de la instancia.
BpeEnabled	string	Parámetro obsoleto.	0
BurstingEnabled	boolean	Indica si el burst de E/S está habilitado. Valores válidos:	false
Category	string	La edición de la instancia. Valores válidos: Basic: Edición básica HighAvailability: Edición de alta disponibilidad Finance: Edición empresarial de RDS Nota Este parámetro se devuelve solo cuando InstanceLevel se establece en 1.	Basic
IsAnalyticReadOnlyIns	boolean	Indica si la instancia es una instancia analítica basada en MySQL DuckDB. Valores válidos:	false
ConnectionMode	string	El modo de acceso de la instancia. Valores válidos:	Standard
ConnectionString	string	El endpoint de la instancia.	rm-uf6wjk5****.mysql.rds.aliyuncs.com
CreateTime	string	La hora de creación. Formato: yyyy-MM-ddTHH:mm:ssZ (UTC).	2018-11-05T11:26:02Z
DBInstanceCPU	string	El número de CPU de la instancia.	2
DBInstanceClass	string	El tipo de instancia. Para obtener más información, consulte Tipos de instancias.	rds.mys2.small
DBInstanceDescription	string	La descripción de la instancia.	testdb
DBInstanceId	string	El ID de la instancia.	rm-uf6wjk5****
DBInstanceMemory	integer	El tamaño de memoria del nodo. Unidad: MB.	4096
DBInstanceNetType	string	El tipo de conectividad de red de la instancia. Valores válidos:	Internet
DBInstanceStatus	string	El estado de la instancia. Para obtener más información, consulte Estados de las instancias.	Running
DBInstanceStorageType	string	El tipo de almacenamiento de la instancia.	ModuleList.4.ModuleCode
DBInstanceType	string	El tipo de instancia. Valores válidos:	Primary
DedicatedHostGroupId	string	El ID del clúster dedicado.	dhg-7a9****
DedicatedHostGroupName	string	El nombre del clúster dedicado.	testhostgroup
DedicatedHostIdForLog	string	El ID del host en el que reside el nodo de registro.	dh-bp****
DedicatedHostIdForMaster	string	El ID del host en el que reside el nodo maestro.	dh-bp****
DedicatedHostIdForSlave	string	El ID del host en el que reside el nodo secundario.	dh-bp****
DedicatedHostNameForLog	string	El nombre del host en el que reside el nodo de registro.	testlog
DedicatedHostNameForMaster	string	El nombre del host en el que reside el nodo maestro.	testmaster
DedicatedHostNameForSlave	string	El nombre del host en el que reside el nodo secundario.	testslave
DedicatedHostZoneIdForLog	string	El ID de zona del host en el que reside el nodo de registro.	cn-hangzhou-b
DedicatedHostZoneIdForMaster	string	El ID de zona activa del host en el que reside el nodo maestro.	cn-hangzhou-c
DedicatedHostZoneIdForSlave	string	El ID de zona del host en el que reside el nodo secundario.	cn-hangzhou-d
DeletionProtection	boolean	Indica si la función de protección contra liberación está habilitada. Valores válidos:	false
DestroyTime	string	La hora de destrucción. Formato: yyyy-MM-ddTHH:mm:ssZ (UTC).	2018-11-05T11:26:02Z
Engine	string	El tipo de motor de base de datos.	MySQL
EngineVersion	string	La versión del motor de base de datos.	5.7
ExpireTime	string	La hora de caducidad. Formato: yyyy-MM-ddTHH:mm:ssZ (UTC). Nota Las instancias de pago por uso no tienen hora de caducidad.	2019-02-27T16:00:00Z
GeneralGroupName	string	El nombre del grupo al que pertenece la instancia MySQL de propósito general del clúster dedicado.	TestGroup
GuardDBInstanceId	string	El ID de la instancia de recuperación ante desastres. Este parámetro se devuelve si la instancia principal tiene una instancia de recuperación ante desastres.	rm-uf64zsu****
InstanceNetworkType	string	El tipo de red de la instancia. Valores válidos:	Classic
IoAccelerationEnabled	string	Indica si la aceleración de E/S está habilitada. Valores válidos:	0
LockMode	string	El estado de bloqueo de la instancia. Valores válidos:	Unlock
LockReason	string	El motivo por el que la instancia está bloqueada.	instance_expired
MasterInstanceId	string	El ID de la instancia principal. Si este parámetro no se devuelve (null), la instancia es una instancia principal.	rm-uf6wjk5****
MutriORsignle	boolean	Indica si la instancia está desplegada en una combinación de zonas múltiples. Valores válidos: true false Nota Una combinación de zonas múltiples se refiere a una zona que contiene "MAZ" en su nombre. Ejemplo: `cn-hangzhou-MAZ10(h,i)`.	true
PayType	string	El método de facturación de la instancia. Valores válidos: Postpaid: pago por uso Prepaid: suscripción	Postpaid
ReadOnlyDBInstanceIds	object
ReadOnlyDBInstanceId	array<object>	La lista de ID de instancias de solo lectura asociadas con la instancia principal.
	object	Los detalles de la instancia de solo lectura.
DBInstanceId	string	El ID de la instancia de solo lectura.	rr-uf6wjk5****
RegionId	string	El ID de la región.	cn-hangzhou
ResourceGroupId	string	El ID del grupo de recursos.	rg-acfmy****
SwitchWeight	integer	Indica si la instancia de propósito general de ApsaraDB RDS for MySQL en el clúster dedicado admite el cambio de peso de alta disponibilidad. Valores válidos: 100: Admitido. 0: No admitido.	100
TempDBInstanceId	string	El ID de la instancia temporal. Este parámetro se devuelve si la instancia principal tiene una instancia temporal.	rm-uf64zsu****
Tips	string	La información de alerta de excepción para la instancia MySQL de propósito general del clúster dedicado.	normal
TipsLevel	integer	El nivel de alerta de excepción de la instancia de ApsaraDB RDS for MySQL en un clúster dedicado con especificaciones de propósito general. Valores válidos: 1: Normal. 2: Las especificaciones de la instancia de solo lectura y la instancia principal no están alineadas, lo que puede afectar la disponibilidad. Ajuste las especificaciones de la instancia según sea necesario.	1
VSwitchId	string	El ID del vSwitch.	vsw-uf6adz52c2p****
VpcCloudInstanceId	string	El ID de la instancia de VPC.	rm-uf6wjk5****
VpcId	string	ID de VPC.	vpc-uf6f7l4fg90****
VpcName	string	El nombre de la VPC.	test-huadong
ZoneId	string	El ID de la zona.	cn-hangzhou-a
BlueGreenDeploymentName	string	Un parámetro reservado. No necesita configurar este parámetro.	test
BlueInstanceName	string	Un parámetro reservado. No necesita configurar este parámetro.	test
GreenInstanceName	string	Un parámetro reservado. No necesita configurar este parámetro.	test
AutoRenewal	boolean	Indica si la renovación automática está habilitada para la instancia. Valores válidos: true: La renovación automática está habilitada. false: La renovación automática no está habilitada. Nota Este parámetro se devuelve solo cuando PayType se establece en Prepaid (suscripción).	false
ColdDataEnabled	boolean	Parámetro reservado.	false
IsAnalyticIns	string
NextToken	string	El token de paginación. Si los resultados se muestran en varias páginas, pase este valor en el parámetro NextToken en la siguiente solicitud para mostrar la siguiente página de resultados.	o7PORW5o2TJg****
PageNumber	integer	El número de página. Nota Si especificó MaxResults o NextToken, este parámetro devuelve solo 1 y se puede ignorar.	1
PageRecordCount	integer	El número de instancias en la página actual.	10
RequestId	string	El ID de la solicitud.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
TotalRecordCount	integer	El número total de registros. Nota Si especifica MaxResults o NextToken, este valor muestra solo el número de registros en la página actual. Puede ignorar este valor.	100

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	Invalid.NextToken	The parameter NextToken is invalid.
400	InvalidDBInstanceType.ValueNotSupport	The specified parameter DBInstanceType is not valid.
400	InvalidParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.
400	TimeoutRetryLater	Timeout, Please retry later.
400	InvalidExpired.Format	The instance expiration status parameter is incorrect.
400	Abs.InvalidAccount.NotFound	account is not found.
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.
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.
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.
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.
400	Pay.NoCreditCard	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.
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.
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.
403	InvalidUserOperatorPermission	The user permission does not support this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
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.
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.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.