GetDatabase - Data Management - Centro de documentación de Alibaba Cloud

Obtiene los detalles de una base de datos especificada.

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

dms:GetDatabase

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Tid	integer	No	El ID del inquilino. Puede llamar a la API GetUserActiveTenant para obtener este ID.	-1
Host	string	Sí	El endpoint de la base de datos.	192.168.XX.XX
Port	integer	Sí	El puerto de conexión de la base de datos.	3306
Sid	string	No	El SID de la base de datos. Nota El SID de la base de datos es el identificador único para una base de datos Oracle.	test_sid
SchemaName	string	Sí	El nombre de la base de datos.	mysql
RealLoginUserUid	string	No	Ninguna.

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	3CDB8601-AD74-4A47-8114-08E08CD6****
Database	object	Los detalles de la base de datos.
DatabaseId	string	El ID de la base de datos.	984****
Host	string	El endpoint de la base de datos.	192.168.XX.XX
CatalogName	string	El nombre del catálogo de la base de datos.	def
DbaName	string	El apodo del DBA.	dba_name
State	string	El estado de la base de datos. Valores válidos: NORMAL: La base de datos está en ejecución. DISABLED: La base de datos está deshabilitada. OFFLINE: La base de datos está sin conexión. NOT_EXIST: La base de datos no existe.	NORMAL
DbaId	string	El ID de usuario del DBA.	27****
SchemaName	string	El nombre del esquema.	mysql
InstanceId	string	El ID de la instancia.	149****
Port	integer	El puerto utilizado para conectarse a la base de datos.	3306
EnvType	string	El tipo de entorno de la base de datos. Valores válidos: product: producción dev: desarrollo pre: prelanzamiento test: prueba sit: prueba de integración del sistema (SIT) uat: prueba de aceptación del usuario (UAT) pet: prueba de rendimiento stag: staging	product
Sid	string	El SID de la base de datos. Nota Este parámetro se devuelve solo para bases de datos Oracle.	test_sid
OwnerIdList	object	Los ID de los propietarios de la base de datos.
OwnerIds	array	Una lista de ID de usuario del propietario de la base de datos.
	string	El ID de usuario de un propietario de la base de datos.	27****
Encoding	string	El conjunto de caracteres.	utf8mb4
DbType	string	El tipo de motor de base de datos. Para obtener más información, consulte la descripción del parámetro DbType.	mysql
OwnerNameList	object	Los apodos de los propietarios de la base de datos.
OwnerNames	array	Lista de apodos de los propietarios de la base de datos.
	string	El apodo de un propietario de la base de datos.	test
SearchName	string	El nombre que se utiliza para buscar la base de datos.	mysql@192.168.XX.XX:3306
InstanceAlias	string	El alias de la instancia.	test
ErrorCode	string	El código de error.	UnknownError
ErrorMessage	string	El mensaje de error.	Ocurrió un error desconocido
Success	boolean	Indica si la solicitud fue exitosa. Valores válidos: true: La solicitud fue exitosa. false: La solicitud falló.	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "3CDB8601-AD74-4A47-8114-08E08CD6****",
  "Database": {
    "DatabaseId": "984****",
    "Host": "192.168.XX.XX",
    "CatalogName": "def",
    "DbaName": "dba_name",
    "State": "NORMAL",
    "DbaId": "27****",
    "SchemaName": "mysql",
    "InstanceId": "149****",
    "Port": 3306,
    "EnvType": "product",
    "Sid": "test_sid",
    "OwnerIdList": {
      "OwnerIds": [
        "27****"
      ]
    },
    "Encoding": "utf8mb4",
    "DbType": "mysql",
    "OwnerNameList": {
      "OwnerNames": [
        "test"
      ]
    },
    "SearchName": "mysql@192.168.XX.XX:3306",
    "InstanceAlias": "test"
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "An unknown error occurred.",
  "Success": true
}

Códigos de error

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.