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

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

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 Resource

*

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. Valores válidos: 1 a 30. Valor padrão: 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	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	1AFAE64E-D1BE-432B-A9****
Data	object	Os resultados retornados.
PageNumber	integer	O número da página.	1
PageSize	integer	O número de entradas por página.	10
TotalCount	integer	O número total de entradas retornadas.	3
ProjectMemberList	array<object>	As informações sobre os membros no workspace do DataWorks.
	array<object>
Status	string	The status of the member. Valid values: 0: NORMAL, which indicates that the member is in a normal state. 1: FORBIDDEN, which indicates that the member is disabled. 2: DELETED, which indicates that the member is deleted.	0
ProjectMemberId	string	The member ID.	121
Nick	string	The nickname of the member.	zhangsan
ProjectMemberName	string	The name of the member.	John Doe
ProjectMemberType	string	The type of the member. Valid values: 1: USER_ALIYUN, which indicates that the member is an Alibaba Cloud account. 5: USER_UBACCOUNT, which indicates that the member is a RAM user. 6: USER_STS_ROLE, which indicates that the member is a RAM role.	1
ProjectRoleList	array<object>	The roles that are assigned to the member.
	object
ProjectRoleId	integer	The role ID.	1
ProjectRoleType	string	The type of the role. Valid values: 0: SYSTEM, which indicates that the role is a built-in role. 2: USER_CUSTOM, which indicates that the role is a custom role.	0
ProjectRoleName	string	The name of the role. DataWorks provides built-in roles and allows you to create custom roles based on your business requirements. For more information about roles, see Overview of users, roles, and permissions.	Visitor
ProjectRoleCode	string	The code of the role. DataWorks provides built-in roles and allows you to create custom roles based on your business requirements. For more information about roles, see Overview of users, roles, and permissions.	role_project_guest

Exemplos

Resposta de sucesso

JSON formato

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

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.	The connection does not exist.
400	Invalid.Tenant.ProjectNotExists	The project does not exist.	The project does not exist.
400	Invalid.Tenant.UserNotInProject	The user is not in the project.	The user is not in the project.
403	Invalid.Tenant.UserIsNotProjectOwnerOrAdmin	The user is not a project administrator or owner.	The user is not a project administrator or owner.
403	Invalid.Tenant.UserNotInTenant	The user is not in tenant.	The user is not in tenant.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.