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

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:ListDataLakeDatabase

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
DataRegion	string	Sí	La región donde reside el lago de datos.	cn-hangzhou
CatalogName	string	Sí	El nombre del catálogo de datos. Puede ver el nombre del catálogo de datos en la consola de DLF.	hive
SearchKey	string	No	La palabra clave que se utiliza para buscar bases de datos.	default
Tid	integer	No	El ID del inquilino. Nota Para ver el ID del inquilino, vaya a la consola de Data Management (DMS) y pase el puntero sobre la foto de perfil en la esquina superior derecha. Para obtener más información, consulte la sección Ver información sobre el inquilino actual del tema "Administrar inquilinos de DMS".	3****
NextToken	string	No	El token de paginación que se utiliza en la siguiente solicitud para recuperar una nueva página de resultados. Valores válidos: Si NextToken está vacío, no existe una página siguiente. Si se devuelve un valor de NextToken, el valor indica el token que se utiliza para la siguiente consulta.	f056501ada12c1cc
MaxResults	integer	No	El número de entradas por página. Valores válidos: de 1 a 100.	20
WorkspaceId	integer	No	El ID del espacio de trabajo.	12****

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de respuesta.
RequestId	string	El ID de la solicitud. Puede utilizar el ID para localizar registros y solucionar problemas.	4E1D2B4D-3E53-4ABC-999D-1D2520B3471A
Success	boolean	Indica si la solicitud se realizó correctamente. Valores válidos: true: La solicitud se realizó correctamente. false: La solicitud falló.	true
ErrorCode	string	El código de error devuelto si la llamada falló.	400
ErrorMessage	string	El mensaje de error que se devuelve si la solicitud falló.	UnknownError
DatabaseList	array	La lista de bases de datos.
	DLDatabase	La información sobre la base de datos.
NextToken	string	El token de paginación que se utiliza en la siguiente solicitud para recuperar una nueva página de resultados. Si NextToken está vacío, no existe una página siguiente. Establezca este parámetro en el valor de NextToken obtenido de la consulta anterior.	NesLoKLEdIZrKhDT7I2gSw==
MaxResults	integer	El número máximo de entradas que se devolverán en una solicitud. Puede utilizar este parámetro y NextToken para implementar la paginación.	20

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "4E1D2B4D-3E53-4ABC-999D-1D2520B3471A",
  "Success": true,
  "ErrorCode": "400",
  "ErrorMessage": "UnknownError",
  "DatabaseList": [
    {
      "Description": "Default database for catalog hive",
      "Parameters": {
        "test": "test",
        "test2": 1
      },
      "DbId": 19,
      "CatalogName": "hive",
      "Name": "default",
      "Location": "oss://xxx"
    }
  ],
  "NextToken": "NesLoKLEdIZrKhDT7I2gSw==",
  "MaxResults": 20
}

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.