GetFolder - DataWorks - 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

dataworks:*

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ProjectId	integer	No	El ID del espacio de trabajo de DataWorks. Inicie sesión en la consola de DataWorks y vaya a la página Administración del espacio de trabajo para obtener el ID del espacio de trabajo. Para especificar el espacio de trabajo de DataWorks en la llamada a la API, debe establecer este parámetro o ProjectIdentifier.	1000011
ProjectIdentifier	string	No	El nombre del espacio de trabajo de DataWorks. Inicie sesión en la consola de DataWorks y vaya a la página Administración del espacio de trabajo para obtener el nombre del espacio de trabajo. Para especificar el espacio de trabajo de DataWorks en la llamada a la API, debe establecer este parámetro o ProjectId.	dw_project
FolderId	string	No	El ID de la carpeta. Debe establecer este parámetro o FolderPath. Puede llamar a la operación ListFolders para obtener el ID de la carpeta.	273****
FolderPath	string	No	La ruta de la carpeta. Debe establecer este parámetro o FolderId. Puede llamar a la operación ListFolders para obtener la ruta de la carpeta.	Business_process/my_first_business_process/MaxCompute/ods_layer

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
HttpStatusCode	integer	El código de estado HTTP.	200
ErrorMessage	string	El mensaje de error.	The connection does not exist.
RequestId	string	El ID de la solicitud. Utilice este ID para solucionar problemas si se produce un error.	0000-ABCD-EFG****
ErrorCode	string	El código de error.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indica si la llamada se realizó correctamente.	true
Data	object	Los detalles de la carpeta.
FolderPath	string	La ruta de la carpeta.	Business_process/my_first_business_process/MaxCompute/ods_layer
FolderId	string	El ID de la carpeta.	2735****

Ejemplos

Respuesta exitosa

JSON Formato

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist",
  "RequestId": "0000-ABCD-EFG****",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "FolderPath": "Business_process/my_first_business_process/MaxCompute/ods_layer",
    "FolderId": "2735****"
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

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.