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

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 login 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 login 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 da Alibaba Cloud ao qual os workspaces pertencem. Você pode fazer login no console do Resource Management e acessar a página Grupo de Recursos para consultar o ID. Este parâmetro é usado para consultar as informações sobre workspaces que pertencem a um grupo de recursos específico.	rg-acfmzbn****
Status	string	Não	O status dos workspaces. Valores válidos: Available Initializing InitFailed Forbidden Deleting DeleteFailed Frozen Updating UpdateFailed.	Available
DevEnvironmentEnabled	boolean	Não	Especifica se o ambiente de desenvolvimento está ativado. Valores válidos: true: O ambiente de desenvolvimento está ativado. Neste caso, o ambiente de desenvolvimento é isolado do ambiente de produção em um workspace. false: O ambiente de desenvolvimento está desativado. Neste caso, apenas o ambiente de produção é usado em um workspace.	true
DevRoleDisabled	boolean	Não	Especifica se o papel Develop está desativado. Valores válidos: false (padrão) true.	false
PaiTaskEnabled	boolean	Não	Especifica se o agendamento de tarefas do Platform for AI (PAI) está ativado. Valores válidos: true: O agendamento de tarefas do PAI está ativado. Neste caso, você pode criar um nó PAI em um workspace do DataWorks e configurar propriedades de agendamento para o nó para implementar o agendamento periódico de tarefas do PAI. false: O agendamento de tarefas do PAI está desativado.	true
AliyunResourceTags	array<object>	Não	As tags.
	object	Não	A tag. Você pode fazer login no console do Resource Management e acessar a página Tag 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	The workspace ID.	123456
Name	string	The name of the workspace.	sora_finance
DisplayName	string	The display name of the workspace.	Sora financial analysis
Description	string	The description of the workspace.	Financial analysis group project data development
Owner	string	The ID of the Alibaba Cloud account to which the workspace belongs.	123532153125
AliyunResourceGroupId	string	The ID of the Alibaba Cloud resource group to which the workspace belongs.	rg-acfmzbn7pti3zfa
Status	string	The status of the workspace. Valid values: Available Initializing InitFailed Forbidden Deleting DeleteFailed Frozen Updating UpdateFailed	Available
PaiTaskEnabled	boolean	Indicates whether scheduling of PAI tasks is enabled. Valid values: true: Scheduling of PAI tasks is enabled. In this case, you can create a PAI node in a DataWorks workspace and configure scheduling properties for the node to implement periodic scheduling of PAI tasks. false: Scheduling of PAI tasks is disabled.	true
DevEnvironmentEnabled	boolean	Indicates whether the development environment is enabled. Valid values: true: The development environment is enabled. In this case, the development environment is isolated from the production environment in the workspace. false: The development environment is disabled. In this case, only the production environment is used in the workspace.	true
DevRoleDisabled	boolean	Indicates whether the Develop role is disabled. Valid values: false (default) true	false
AliyunResourceTags	array<object>	The tags.
	object	The tag.
Key	string	The tag key.	batch
Value	string	The tag value.	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.