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

Consulta os detalhes das funções do workspace por paginação.

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

list

*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. Você pode fazer logon no console do DataWorks e acessar a página de gerenciamento do workspace para obter o ID.\n\nEste parâmetro especifica o workspace do DataWorks para a chamada de API atual.	21229
Codes	array	Não	A lista de códigos das funções do workspace.
	string	Não	O código da função do workspace. Valores válidos:\n- role_project_admin: Administrador do workspace.\n- role_project_dev: Desenvolvedor.\n- role_project_dg_admin: Administrador de governança de dados.\n- role_project_guest: Convidado.\n- role_project_security: Administrador de segurança.\n- role_project_deploy: Implantação.\n- role_project_owner: Proprietário do workspace.\n- role_project_data_analyst: Analista de dados.\n- role_project_pe: Engenheiro de O&M.\n- role_project_erd: Designer de modelos.	role_project_guest
Names	array	Não	A lista de nomes das funções do workspace.
	string	Não	O nome da função do workspace.	Visitors
Type	string	Não	O tipo da função do workspace. Valores válidos:\n- UserCustom: Função personalizada.\n- System: Função do sistema.	System
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.	61649187-0BCF-5E75-8D4B-64FDBEBBB447
PagingInfo	object	As informações de paginação.
PageSize	string	O número de entradas por página.	10
PageNumber	string	O número da página dos dados solicitados.	1
TotalCount	string	O número total de entradas que atendem às condições especificadas.	42
ProjectRoles	array<object>	A lista de funções do workspace.
	array<object>	Os detalhes da função do workspace.
ProjectId	integer	O ID do workspace do DataWorks.\n\nNota: Para as funções padrão do sistema do workspace, o valor de ProjectId é fixado em -1.	21229
Code	string	O código da função do workspace.	role_project_guest
Name	string	O nome da função do workspace.	Visitors
Type	string	O tipo da função do workspace.	System
ModulePermissions	array<object>	A lista de permissões de módulo de produto do DataWorks concedidas à função.
	object	A permissão de módulo de produto do DataWorks concedida à função.
ModuleId	integer	O ID do módulo do DataWorks.	2
ModuleName	string	O nome do módulo do DataWorks.	HoloStudio
PermissionType	string	O tipo da permissão.	Read

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "61649187-0BCF-5E75-8D4B-64FDBEBBB447",
  "PagingInfo": {
    "PageSize": "10",
    "PageNumber": "1",
    "TotalCount": "42",
    "ProjectRoles": [
      {
        "ProjectId": 21229,
        "Code": "role_project_guest\n",
        "Name": "Visitors",
        "Type": "System",
        "ModulePermissions": [
          {
            "ModuleId": 2,
            "ModuleName": "HoloStudio",
            "PermissionType": "Read"
          }
        ]
      }
    ]
  }
}

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.