ListProjectMembers - DataWorks: Central de Documentação do Alibaba Cloud

Obtém uma lista paginada dos detalhes dos membros do workspace.

Descrição da operação

Este recurso está disponível no DataWorks Basic Edition e em edições superiores.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

dataworks:ListProjectMembers

list

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ProjectId	integer	Sim	O ID do workspace do DataWorks. Para obter esse ID, faça login no Console do DataWorks e acesse a página de Gerenciamento de Workspace. Este parâmetro especifica o workspace do DataWorks para a chamada de API.	62136
UserIds	array	Não	Uma lista de IDs de usuário do DataWorks para filtrar os resultados. Você pode encontrar esses IDs na página Membros e Funções do Tenant no Centro de Gerenciamento.
	string	Não	Um ID de usuário do DataWorks.	123422344899
RoleCodes	array	Não	Uma lista de códigos de função do workspace para filtrar os resultados. Você pode chamar a operação ListProjectRoles para obter os códigos de função.
	string	Não	Um código de função do workspace.	role_project_guest
PageNumber	integer	Não	O número da página. As páginas começam a partir da página 1.	1
PageSize	integer	Não	O número de entradas por página. Valor padrão: 10. Valor máximo: 100.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O objeto de resposta.
RequestId	string	O ID exclusivo da solicitação, usado para rastrear logs e solucionar problemas.	9FBBBB1F-DD5E-5D8E-8F50-37F77460F056
PagingInfo	object	As informações de paginação.
PageSize	integer	O número de entradas a serem retornadas em cada página.	10
PageNumber	integer	O número da página.	1
TotalCount	integer	O número total de entradas correspondentes.	12
ProjectMembers	array<object>	A lista de membros do workspace.
	array<object>	Os detalhes de um único membro do workspace.
ProjectId	integer	The ID of the DataWorks Workspace.	62136
UserId	string	The ID of the DataWorks user.	123422344899
Status	string	The status of the Workspace member. `Normal`: The member is active. `Forbidden`: The member is disabled.	Normal
Roles	array<object>	The roles assigned to the Workspace member.
	object	The details of an assigned role.
Code	string	The code of the role.	role_project_guest
Name	string	The name of the role.	Visitors
Type	string	The type of the role. `UserCustom`: A user-defined role. `System`: A system role.	System
UserName	string	The name of the DataWorks user.

Exemplos

Resposta de sucesso

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 erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.