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

Retorna uma lista paginada de funções em um 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:ListProjectRoles

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. Você pode encontrar o ID na página Gerenciamento de Workspace no console do DataWorks. Este parâmetro especifica o workspace do DataWorks para o qual você deseja listar funções.	21229
Codes	array	Não	Um array de códigos de funções do workspace.
	string	Não	O código de uma função do workspace. `role_project_admin`: Administrador do Workspace `role_project_dev`: Desenvolvedor `role_project_dg_admin`: Administrador de Governança de Dados `role_project_guest`: Convidado `role_project_security`: Administrador de Segurança `role_project_deploy`: Deployer `role_project_owner`: Proprietário do Workspace `role_project_data_analyst`: Analista de Dados `role_project_pe`: O&M `role_project_erd`: Designer de Modelos.	role_project_guest
Names	array	Não	Um array de nomes de funções do workspace.
	string	Não	O nome de uma função do workspace.	Visitors
Type	string	Não	O tipo da função do workspace. `UserCustom`: Função Personalizada `System`: Função do Sistema.	System
PageNumber	integer	Não	O número da página a ser retornada.	1
PageSize	integer	Não	O número de entradas a serem retornadas por página. Valor padrão: 10. Valor máximo: 100.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O esquema da resposta.
RequestId	string	O ID da solicitação. Use este 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 retornada.	1
TotalCount	string	O número total de entradas correspondentes.	42
ProjectRoles	array<object>	Uma lista de funções do workspace.
	array<object>	Detalhes de uma função do workspace.
ProjectId	integer	The ID of the DataWorks workspace. Note: For system-defined roles, this parameter returns -1.	21229
Code	string	The code of the workspace role.	role_project_guest
Name	string	The name of the workspace role.	Visitors
Type	string	The type of the workspace role.	System
ModulePermissions	array<object>
	object
ModuleId	integer		2
ModuleName	string		HoloStudio
PermissionType	string		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.