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

Obtiene una lista paginada de los detalles de los miembros del espacio de trabajo.

Descripción de la operación

Esta función está disponible en DataWorks Basic Edition y versiones superiores.

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

list

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ProjectId	integer	Sí	El ID del espacio de trabajo de DataWorks. Para obtener este ID, inicie sesión en la Consola de DataWorks y vaya a la página Gestión de espacios de trabajo. Este parámetro especifica el espacio de trabajo de DataWorks para la llamada a la API.	62136
UserIds	array	No	Una lista de ID de usuarios de DataWorks para filtrar los resultados. Puede encontrar estos ID en la página Miembros y roles del inquilino en el Centro de gestión.
	string	No	Un ID de usuario de DataWorks.	123422344899
RoleCodes	array	No	Una lista de códigos de rol del espacio de trabajo para filtrar los resultados. Puede llamar a la operación ListProjectRoles para obtener los códigos de rol.
	string	No	Un código de rol del espacio de trabajo.	role_project_guest
PageNumber	integer	No	El número de página. Las páginas comienzan desde la página 1.	1
PageSize	integer	No	El número de entradas por página. Valor predeterminado: 10. Valor máximo: 100.	10

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El objeto de respuesta.
RequestId	string	El ID único de la solicitud, utilizado para rastrear registros y solucionar problemas.	9FBBBB1F-DD5E-5D8E-8F50-37F77460F056
PagingInfo	object	La información de paginación.
PageSize	integer	El número de entradas que se devuelven en cada página.	10
PageNumber	integer	El número de página.	1
TotalCount	integer	El número total de entradas coincidentes.	12
ProjectMembers	array<object>	La lista de miembros del espacio de trabajo.
	array<object>	Los detalles de un solo miembro del espacio de trabajo.
ProjectId	integer	El ID del espacio de trabajo de DataWorks.	62136
UserId	string	El ID del usuario de DataWorks.	123422344899
Status	string	El estado del miembro del espacio de trabajo. `Normal`: El miembro está activo. `Forbidden`: El miembro está deshabilitado.	Normal
Roles	array<object>	Los roles asignados al miembro del espacio de trabajo.
	object	Los detalles de un rol asignado.
Code	string	El código del rol.	role_project_guest
Name	string	El nombre del rol.	Visitors
Type	string	El tipo de rol. `UserCustom`: Un rol definido por el usuario. `System`: Un rol del sistema.	System
UserName	string	The name of the DataWorks user.

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "9FBBBB1F-DD5E-5D8E-8F50-37F77460F056",
  "PagingInfo": {
    "PageSize": 10,
    "PageNumber": 1,
    "TotalCount": 12,
    "ProjectMembers": [
      {
        "ProjectId": 62136,
        "UserId": "123422344899",
        "Status": "Normal",
        "Roles": [
          {
            "Code": "role_project_guest",
            "Name": "Visitors",
            "Type": "System"
          }
        ],
        "UserName": ""
      }
    ]
  }
}

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.