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

Consulta a lista de membros existentes em um workspace do DataWorks.

Descrição da operação

Antes de começar: o DataWorks está ativado, a conta invocadora tem as permissões de acesso ao workspace de destino e as permissões do RAM necessárias para invocar operações da OpenAPI estão configuradas.

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

get

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ProjectId	integer	Sim	O ID do workspace do DataWorks.	27
PageNumber	integer	Não	O número da página. Valor padrão: 1. Valor mínimo: 1. Valor máximo: 30.	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	A estrutura da resposta.
Data	object	O resultado da consulta.
PageNumber	integer	O número da página atual.	1
PageSize	integer	O número de entradas por página.	10
ProjectMemberList	array<object>	A lista de membros no workspace.
	array<object>	Os detalhes do membro.
Nick	string	O apelido do membro do workspace.	zhangsan
ProjectMemberId	string	O ID de usuário do membro.	121
ProjectMemberName	string	O nome do membro.	Zhang San
ProjectMemberType	string	O tipo do membro. Valores válidos: 1: Conta Alibaba Cloud (USER_ALIYUN). 5: Usuário RAM (USER_UBACCOUNT). 6: Função RAM (USER_STS_ROLE).	1
ProjectRoleList	array<object>	A lista de funções atribuídas ao membro.
	object	A estrutura da resposta.
ProjectRoleCode	string	O código da função. O DataWorks fornece funções predefinidas. Você também pode criar funções personalizadas com base nos seus requisitos de negócios. Para mais informações sobre funções, consulte Visão geral de usuários, funções e permissões.	role_project_guest
ProjectRoleId	integer	O ID da função.	1
ProjectRoleName	string	O nome da função. O DataWorks fornece funções predefinidas. Você também pode criar funções personalizadas com base nos seus requisitos de negócios. Para mais informações sobre funções, consulte Visão geral de usuários, funções e permissões.	Visitor
ProjectRoleType	string	O tipo da função. Valores válidos: SYSTEM (0): Função do sistema. USER_CUSTOM (2): Função personalizada.	0
Status	string	O status. Valores válidos: 0: Normal (NORMAL). 1: Desativado (FORBIDDEN). 2: Excluído (DELETED).	0
TotalCount	integer	O número total de entradas.	3
RequestId	string	O ID da solicitação.	1AFAE64E-D1BE-432B-A9****

Exemplos

Resposta de sucesso

JSON formato

{
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "ProjectMemberList": [
      {
        "Nick": "zhangsan",
        "ProjectMemberId": "121",
        "ProjectMemberName": "John Doe",
        "ProjectMemberType": "1",
        "ProjectRoleList": [
          {
            "ProjectRoleCode": "role_project_guest",
            "ProjectRoleId": 1,
            "ProjectRoleName": "Visitor",
            "ProjectRoleType": "0"
          }
        ],
        "Status": "0"
      }
    ],
    "TotalCount": 3
  },
  "RequestId": "1AFAE64E-D1BE-432B-A9****"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	Invalid.Tenant.ConnectionNotExists	The connection does not exist.	A origem de dados não existe.
400	Invalid.Tenant.ProjectNotExists	The project does not exist.	O projeto não existe.
400	Invalid.Tenant.UserNotInProject	The user is not in the project.	O usuário não existe no projeto.
403	Invalid.Tenant.UserIsNotProjectOwnerOrAdmin	The user is not a project administrator or owner.	O usuário não é o proprietário nem o administrador do projeto.
403	Invalid.Tenant.UserNotInTenant	The user is not in tenant.	O membro a ser adicionado não existe no locatário.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.