GetDatabase - DataWorks - Centro de documentación de Alibaba Cloud

Descripción de la operación

Se requiere DataWorks Basic Edition o una edición superior.

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

dataworks:GetDatabase

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Id	string	Sí	El ID de la entidad de la base de datos. Puede consultar la respuesta de la operación ListDatabases y Conceptos relacionados con entidades de metadatos. El formato: `${EntityType}:${Instance ID or escaped URL}:${Catalog identifier}:${Database name}`. Utilice cadenas vacías como marcadores de posición para los niveles que no existen. Nota Para StarRocks, el identificador de catálogo es el nombre del catálogo. Para DLF, el identificador de catálogo es el ID del catálogo. Para otros tipos, no se admite la jerarquía de nivel de catálogo y se puede usar una cadena vacía como marcador de posición. Ejemplos de formatos comunes de ID `dlf-database::catalog_id:database_name` `holo-database:instance_id::database_name` `mysql-database:(instance_id\|encoded_jdbc_url)::database_name` Nota `catalog_id`: El ID del catálogo de DLF. `instance_id`: El ID de la instancia, que es obligatorio cuando el origen de datos se registra en modo de instancia. `encoded_jdbc_url`: La cadena de conexión JDBC codificada, que es obligatoria cuando el origen de datos se registra en modo de cadena de conexión. `database_name`: El nombre de la base de datos.	dlf-database::catalog_id:database_name

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La respuesta.
RequestId	string	El ID de la solicitud.	1AFAE64E-D1BE-432B-A9****
Success	boolean	Indica si la solicitud se realizó correctamente.	true
Database	Database	Los detalles de la base de datos.

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "1AFAE64E-D1BE-432B-A9****",
  "Success": true,
  "Database": {
    "Id": "holo-database:h-xxxx::test_db",
    "Name": "test_db",
    "Comment": "test comment",
    "LocationUri": "oss://test-bucket/test_db",
    "ParentMetaEntityId": "holo:h-xxxx",
    "CreateTime": 1736852168000,
    "ModifyTime": 1736852168000
  }
}

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.