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

Consulta uma lista de workspaces do DataWorks no tenant ao qual o usuário pertence.

Descrição da operação

Antes de começar: o DataWorks está ativado e as permissões do RAM necessárias para chamar operações da OpenAPI estão configuradas para a conta chamadora. Se as permissões ou o serviço não estiverem prontos, um erro 403 Forbidden.Access poderá ser retornado.

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

get

*Project

acs:dataworks:{#regionId}:{#accountId}:workspace/*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PageNumber	integer	Não	O número da página. Valor mínimo: 1. Valor máximo: 100.	1
PageSize	integer	Não	O número de entradas por página. Valor padrão: 10. Valor máximo: 100.	10
ResourceManagerResourceGroupId	string	Não	O ID do grupo de recursos.	rg-acfmzbn7pt****
Tags	array<object>	Não	A lista de tags vinculadas ao workspace.
	object	Não	As informações da tag.
Key	string	Não	A chave da tag.	key
Value	string	Não	O valor da tag.	value

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
PageResult	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. Valor padrão: 10. Valor máximo: 100.	10
ProjectList	array<object>	A lista de workspaces do DataWorks.
	array<object>	Os detalhes do workspace.
DisableDevelopment	boolean	Indica se a função de desenvolvimento está desativada. Valores válidos: false: A função de desenvolvimento está ativada. true: A função de desenvolvimento está desativada.	true
IsDefault	integer	Indica se o workspace é o workspace padrão. Valores válidos: 1: Sim. 0: Não.	1
ProjectDescription	string	A descrição detalhada do workspace.	test_describe
ProjectId	integer	O ID do workspace.	466230
ProjectIdentifier	string	O nome do workspace.	test_project
ProjectName	string	O nome de exibição do workspace.	test_project
ProjectOwnerBaseId	string	O ID de usuário do proprietário do workspace.	13969939245****
ProjectStatus	integer	O status do workspace. Valores válidos: AVAILABLE: 0. O workspace está normal. DELETED: 1. O workspace foi excluído. INITIALIZING: 2. O workspace está sendo inicializado. INIT_FAILED: 3. Falha ao inicializar o workspace. FORBIDDEN: 4. O workspace foi desativado manualmente. DELETING: 5. O workspace está sendo excluído. DEL_FAILED: 6. Falha ao excluir o workspace. FROZEN: 7. O workspace está congelado devido a um pagamento em atraso. UPDATING: 8. O workspace está sendo atualizado com a adição e inicialização de um mecanismo de computação. UPDATE_FAILED: 9. Falha ao atualizar o workspace com a adição e inicialização de um mecanismo de computação.	0
ProjectStatusCode	string	O código de status do workspace. Valores válidos: AVAILABLE: 0. O workspace está normal. DELETED: 1. O workspace foi excluído. INITIALIZING: 2. O workspace está sendo inicializado. INIT_FAILED: 3. Falha ao inicializar o workspace. FORBIDDEN: 4. O workspace foi desativado manualmente. DELETING: 5. O workspace está sendo excluído. DEL_FAILED: 6. Falha ao excluir o workspace. FROZEN: 7. O workspace está congelado devido a um pagamento em atraso. UPDATING: 8. O workspace está sendo atualizado com a adição e inicialização de um mecanismo de computação. UPDATE_FAILED: 9. Falha ao atualizar o workspace com a adição e inicialização de um mecanismo de computação.	AVAILABLE
ResourceManagerResourceGroupId	string	O ID do grupo de recursos.	rg-acfmzbn7****
TablePrivacyMode	integer	As permissões de visibilidade das tabelas do MaxCompute. Valores válidos: 0: As tabelas do MaxCompute são invisíveis para os usuários no tenant. 1: As tabelas do MaxCompute são visíveis para os usuários no tenant.	1
Tags	array<object>	A lista de tags vinculadas ao workspace.
	object	As informações da tag.
Key	string	A chave da tag.	key
Value	string	O valor da tag.	value
UseProxyOdpsAccount	boolean	Indica se uma conta proxy é usada para acessar o engine do MaxCompute. Valores válidos: false: Uma conta proxy não é usada. true: Uma conta proxy é usada.	true
TotalCount	integer	O número total de entradas retornadas.	68
RequestId	string	O ID da solicitação.	20658801****

Exemplos

Resposta de sucesso

JSON formato

{
  "PageResult": {
    "PageNumber": 1,
    "PageSize": 10,
    "ProjectList": [
      {
        "DisableDevelopment": true,
        "IsDefault": 1,
        "ProjectDescription": "test_describe",
        "ProjectId": 466230,
        "ProjectIdentifier": "test_project",
        "ProjectName": "test_project",
        "ProjectOwnerBaseId": "13969939245****",
        "ProjectStatus": 0,
        "ProjectStatusCode": "AVAILABLE",
        "ResourceManagerResourceGroupId": "rg-acfmzbn7****",
        "TablePrivacyMode": 1,
        "Tags": [
          {
            "Key": "key",
            "Value": "value"
          }
        ],
        "UseProxyOdpsAccount": true
      }
    ],
    "TotalCount": 68
  },
  "RequestId": "20658801****"
}

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.UserAlreadyInProject	The user already exists in the project.	O usuário a ser adicionado já existe no workspace.
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.