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

Realiza uma consulta paginada dos detalhes dos membros do espaço de trabalho.

Descrição da operação

Você deve adquirir o DataWorks Basic Edition ou uma edição superior para usar esta operação.

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 resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ProjectId	integer	Sim	O ID do espaço de trabalho do DataWorks. Você pode fazer login no console do DataWorks e acessar a página de gerenciamento de espaço de trabalho para obter o ID. Este parâmetro especifica o espaço de trabalho do DataWorks usado ao invocar esta operação de API.	62136
UserIds	array	Não	A lista de IDs de conta do DataWorks. Você pode fazer login no console do DataWorks - Administração, selecionar o espaço de trabalho que deseja gerenciar, acessar a página de Administração e, em seguida, acessar a página de Membros e Funções do Locatário para visualizar os IDs de conta.
	string	Não	O ID da conta do DataWorks.	123422344899
RoleCodes	array	Não	A lista de códigos de função do espaço de trabalho. Você pode chamar a operação ListProjectRoles para obter os códigos de função.
	string	Não	O código da função do espaço de trabalho.	role_project_guest
PageNumber	integer	Não	O número da página dos dados solicitados.	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	Esquema da resposta.
RequestId	string	O ID da solicitação. Você pode usar o ID para localizar logs e solucionar problemas.	9FBBBB1F-DD5E-5D8E-8F50-37F77460F056
PagingInfo	object	As informações de paginação.
PageSize	integer	O número de entradas por página.	10
PageNumber	integer	O número da página dos dados solicitados.	1
TotalCount	integer	O número total de entradas que atendem às condições.	12
ProjectMembers	array<object>	A lista de membros do espaço de trabalho.
	array<object>	Os detalhes do membro do espaço de trabalho.
ProjectId	integer	O ID do espaço de trabalho do DataWorks.	62136
UserId	string	O ID da conta do DataWorks.	123422344899
Status	string	O status do membro do espaço de trabalho. Valores válidos: Normal: Normal. Forbidden: Desativado.	Normal
Roles	array<object>	A lista de funções do espaço de trabalho atribuídas ao membro do espaço de trabalho.
	object	Os detalhes da função do espaço de trabalho atribuída.
Code	string	O código da função do espaço de trabalho.	role_project_guest
Name	string	O nome da função do espaço de trabalho.	Visitors
Type	string	O tipo da função do espaço de trabalho. Valores válidos: UserCustom: Função personalizada. System: Função do sistema.	System
UserName	string	O nome da conta na nuvem do membro.	liusan

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": "liusan"
      }
    ]
  }
}

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.