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

Consulta uma lista de workspaces do DataWorks do tenant ao qual sua conta pertence.

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

list

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Ids	array	Não	Os IDs dos workspaces do DataWorks.
	integer	Não	O ID do workspace do DataWorks. Você pode fazer logon no console do DataWorks e acessar a página Workspace para consultar o ID.	123456
Names	array	Não	Os nomes dos workspaces do DataWorks.
	string	Não	O nome do workspace do DataWorks. Você pode fazer logon no console do DataWorks e acessar a página Workspace para consultar o nome.	sora_finance
AliyunResourceGroupId	string	Não	O ID do grupo de recursos do Alibaba Cloud ao qual os workspaces pertencem. Você pode fazer logon no console de Gerenciamento de Recursos e acessar a página Grupo de Recursos para consultar o ID.\n\nEste parâmetro é usado para consultar as informações sobre workspaces que pertencem a um grupo de recursos específico.	rg-acfmzbn7pti3zff
Status	string	Não	O status dos workspaces. Valores válidos: Available (em execução normal), Initializing (inicializando), InitFailed (falha na inicialização), Forbidden (desativado manualmente), Deleting (sendo excluído), DeleteFailed (falha na exclusão), Frozen (congelado devido a pagamentos em atraso), Updating (sendo atualizado) e UpdateFailed (falha na atualização). Este parâmetro filtra os workspaces pelo status especificado.	Available
DevEnvironmentEnabled	boolean	Não	Especifica se o ambiente de desenvolvimento está ativado. Valores válidos:\n\n- true: O ambiente de desenvolvimento está ativado. Nesse caso, o ambiente de desenvolvimento é isolado do ambiente de produção em um workspace.\n\n- false: O ambiente de desenvolvimento está desativado. Nesse caso, apenas o ambiente de produção é usado em um workspace.	true
DevRoleDisabled	boolean	Não	Especifica se a função de desenvolvedor está desativada. Valores válidos: false (ativado, padrão) e true (desativado). Este parâmetro filtra os workspaces com base na ativação ou desativação da função de desenvolvedor.	false
PaiTaskEnabled	boolean	Não	Especifica se o agendamento de tarefas do Platform for AI (PAI) está ativado. Valores válidos:\n\n- true: O agendamento de tarefas do PAI está ativado. Nesse caso, você pode criar um nó do PAI em um workspace do DataWorks e configurar propriedades de agendamento para o nó para implementar o agendamento periódico de tarefas do PAI.\n\n- false: O agendamento de tarefas do PAI está desativado.	true
AliyunResourceTags	array<object>	Não	A lista de tags. Este parâmetro consulta workspaces que possuem qualquer um dos pares chave-valor de tag especificados.
	object	Não	A tag. Você pode fazer logon no console de Gerenciamento de Recursos e acessar a página Tags para consultar a chave e o valor da tag.
Key	string	Não	A chave da tag.	batch
Value	string	Não	O valor da tag.	blue
PageNumber	integer	Não	O número da página.	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.	6D24AD9A-652F-59E2-AC1F-05029300F8A4
PagingInfo	object	As informações de paginação.
PageSize	integer	O número de entradas por página.	1
PageNumber	integer	O número da página.	10
TotalCount	integer	O número total de entradas retornadas.	100
Projects	array<object>	Os workspaces.
	array<object>	O workspace.
Id	integer	O ID do workspace.	123456
Name	string	O nome do workspace.	sora_finance
DisplayName	string	O nome de exibição do workspace.	Sora financial analysis
Description	string	A descrição do workspace.	Financial analysis group project data development
Owner	string	O ID da conta do Alibaba Cloud à qual o workspace pertence.	123532153125
AliyunResourceGroupId	string	O ID do grupo de recursos do Alibaba Cloud ao qual o workspace pertence.	rg-acfmzbn7pti3zfa
Status	string	O status do workspace. Valores válidos: Available (em execução normal), Initializing (inicializando), InitFailed (falha na inicialização), Forbidden (desativado manualmente), Deleting (sendo excluído), DeleteFailed (falha na exclusão), Frozen (congelado devido a pagamentos em atraso), Updating (sendo atualizado) e UpdateFailed (falha na atualização).	Available
PaiTaskEnabled	boolean	Indica se o agendamento de tarefas do PAI está ativado. Valores válidos:\n\n- true: O agendamento de tarefas do PAI está ativado. Nesse caso, você pode criar um nó do PAI em um workspace do DataWorks e configurar propriedades de agendamento para o nó para implementar o agendamento periódico de tarefas do PAI.\n\n- false: O agendamento de tarefas do PAI está desativado.	true
DevEnvironmentEnabled	boolean	Indica se o ambiente de desenvolvimento está ativado. Valores válidos:\n\n- true: O ambiente de desenvolvimento está ativado. Nesse caso, o ambiente de desenvolvimento é isolado do ambiente de produção no workspace.\n\n- false: O ambiente de desenvolvimento está desativado. Nesse caso, apenas o ambiente de produção é usado no workspace.	true
DevRoleDisabled	boolean	Indica se a função de desenvolvedor está desativada. Valores válidos: false (ativado) e true (desativado).	false
AliyunResourceTags	array<object>	As tags.
	object	A tag.
Key	string	A chave da tag.	batch
Value	string	O valor da tag.	blue

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "6D24AD9A-652F-59E2-AC1F-05029300F8A4",
  "PagingInfo": {
    "PageSize": 1,
    "PageNumber": 10,
    "TotalCount": 100,
    "Projects": [
      {
        "Id": 123456,
        "Name": "sora_finance",
        "DisplayName": "Sora financial analysis\n",
        "Description": "Financial analysis group project data development",
        "Owner": "123532153125",
        "AliyunResourceGroupId": "rg-acfmzbn7pti3zfa",
        "Status": "Available",
        "PaiTaskEnabled": true,
        "DevEnvironmentEnabled": true,
        "DevRoleDisabled": false,
        "AliyunResourceTags": [
          {
            "Key": "batch",
            "Value": "blue"
          }
        ]
      }
    ]
  }
}

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.