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

Consulta una lista de espacios de trabajo de DataWorks en el inquilino al que pertenece el usuario.

Descripción de la operación

Antes de comenzar: DataWorks está activado y los permisos de RAM necesarios para invocar las operaciones de OpenAPI están configurados para la cuenta que realiza la llamada. Si los permisos o el servicio no están listos, es posible que se devuelva un error 403 Forbidden.Access.

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

get

*Project

acs:dataworks:{#regionId}:{#accountId}:workspace/*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
PageNumber	integer	No	El número de página. Valor mínimo: 1. Valor máximo: 100.	1
PageSize	integer	No	El número de entradas por página. Valor predeterminado: 10. Valor máximo: 100.	10
ResourceManagerResourceGroupId	string	No	El ID del grupo de recursos.	rg-acfmzbn7pt****
Tags	array<object>	No	La lista de etiquetas vinculadas al espacio de trabajo.
	object	No	La información de la etiqueta.
Key	string	No	La clave de la etiqueta.	key
Value	string	No	El valor de la etiqueta.	value

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La respuesta.
PageResult	object	El resultado de la consulta.
PageNumber	integer	El número de página actual.	1
PageSize	integer	El número de entradas por página. Valor predeterminado: 10. Valor máximo: 100.	10
ProjectList	array<object>	La lista de espacios de trabajo de DataWorks.
	array<object>	Los detalles del espacio de trabajo.
DisableDevelopment	boolean	Indica si el rol de desarrollo está deshabilitado. Valores válidos: false: El rol de desarrollo está habilitado. true: El rol de desarrollo está deshabilitado.	true
IsDefault	integer	Indica si el espacio de trabajo es el espacio de trabajo predeterminado. Valores válidos: 1: Sí. 0: No.	1
ProjectDescription	string	La descripción detallada del espacio de trabajo.	test_describe
ProjectId	integer	El ID del espacio de trabajo.	466230
ProjectIdentifier	string	El nombre del espacio de trabajo.	test_project
ProjectName	string	El nombre para mostrar del espacio de trabajo.	test_project
ProjectOwnerBaseId	string	El ID de usuario del propietario del espacio de trabajo.	13969939245****
ProjectStatus	integer	El estado del espacio de trabajo. Valores válidos: AVAILABLE: 0. El espacio de trabajo es normal. DELETED: 1. El espacio de trabajo está eliminado. INITIALIZING: 2. El espacio de trabajo se está inicializando. INIT_FAILED: 3. No se pudo inicializar el espacio de trabajo. FORBIDDEN: 4. El espacio de trabajo está deshabilitado manualmente. DELETING: 5. El espacio de trabajo se está eliminando. DEL_FAILED: 6. No se pudo eliminar el espacio de trabajo. FROZEN: 7. El espacio de trabajo está congelado debido a un pago vencido. UPDATING: 8. El espacio de trabajo se está actualizando al agregar e inicializar un motor de cómputo. UPDATE_FAILED: 9. No se pudo actualizar el espacio de trabajo al agregar e inicializar un motor de cómputo.	0
ProjectStatusCode	string	El código de estado del espacio de trabajo. Valores válidos: AVAILABLE: 0. El espacio de trabajo es normal. DELETED: 1. El espacio de trabajo está eliminado. INITIALIZING: 2. El espacio de trabajo se está inicializando. INIT_FAILED: 3. No se pudo inicializar el espacio de trabajo. FORBIDDEN: 4. El espacio de trabajo está deshabilitado manualmente. DELETING: 5. El espacio de trabajo se está eliminando. DEL_FAILED: 6. No se pudo eliminar el espacio de trabajo. FROZEN: 7. El espacio de trabajo está congelado debido a un pago vencido. UPDATING: 8. El espacio de trabajo se está actualizando al agregar e inicializar un motor de cómputo. UPDATE_FAILED: 9. No se pudo actualizar el espacio de trabajo al agregar e inicializar un motor de cómputo.	AVAILABLE
ResourceManagerResourceGroupId	string	El ID del grupo de recursos.	rg-acfmzbn7****
TablePrivacyMode	integer	Los permisos de visibilidad de las tablas de MaxCompute. Valores válidos: 0: Las tablas de MaxCompute son invisibles para los usuarios del inquilino. 1: Las tablas de MaxCompute son visibles para los usuarios del inquilino.	1
Tags	array<object>	La lista de etiquetas vinculadas al espacio de trabajo.
	object	La información de la etiqueta.
Key	string	La clave de la etiqueta.	key
Value	string	El valor de la etiqueta.	value
UseProxyOdpsAccount	boolean	Indica si se utiliza una cuenta de proxy para acceder al motor de MaxCompute. Valores válidos: false: No se utiliza una cuenta de proxy. true: Se utiliza una cuenta de proxy.	true
TotalCount	integer	El número total de entradas devueltas.	68
RequestId	string	El ID de la solicitud.	20658801****

Ejemplos

Respuesta exitosa

JSON Formato

{
  "PageResult": {
    "PageNumber": 1,
    "PageSize": 10,
    "ProjectList": [
      {
        "DisableDevelopment": true,
        "IsDefault": 1,
        "ProjectDescription": "test_describe",
        "ProjectId": 466230,
        "ProjectIdentifier": "test_project",
        "ProjectName": "test_project",
        "ProjectOwnerBaseId": "13969939245****",
        "ProjectStatus": 0,
        "ProjectStatusCode": "AVAILABLE",
        "ResourceManagerResourceGroupId": "rg-acfmzbn7****",
        "TablePrivacyMode": 1,
        "Tags": [
          {
            "Key": "key",
            "Value": "value"
          }
        ],
        "UseProxyOdpsAccount": true
      }
    ],
    "TotalCount": 68
  },
  "RequestId": "20658801****"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	Invalid.Tenant.ConnectionNotExists	The connection does not exist.	El origen de datos no existe.
400	Invalid.Tenant.ProjectNotExists	The project does not exist.	El proyecto no existe.
400	Invalid.Tenant.UserAlreadyInProject	The user already exists in the project.	El usuario que se va a agregar ya existe en el espacio de trabajo.
400	Invalid.Tenant.UserNotInProject	The user is not in the project.	El usuario no existe en el proyecto.
403	Invalid.Tenant.UserIsNotProjectOwnerOrAdmin	The user is not a project administrator or owner.	El usuario no es el propietario ni el administrador del proyecto.
403	Invalid.Tenant.UserNotInTenant	The user is not in tenant.	El miembro que se va a agregar no existe en el inquilino.

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.