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

Consulta as informações de um workspace do DataWorks.

Descrição da operação

Esta operação de API está disponível para todas as edições do DataWorks.

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

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Id	integer	Sim	O ID do workspace do DataWorks. Você pode fazer login no console do DataWorks e acessar a página Workspace para consultar o ID. Você deve configurar este parâmetro para especificar o workspace do DataWorks ao qual a operação de API é aplicada.	123456

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação. Você pode localizar logs e solucionar problemas com base no ID.	22C97E95-F023-56B5-8852-B1A77A1****
Project	object	As informações sobre o workspace.
Id	integer	O ID do workspace.	28477242
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 da Alibaba Cloud à qual o workspace pertence.	207947397706614299
AliyunResourceGroupId	string	O ID do grupo de recursos da Alibaba Cloud ao qual o workspace pertence.	rg-acfmzbn7pti3zfa
Status	string	O status do workspace. Valores válidos: Available Initializing InitFailed Forbidden Deleting DeleteFailed Frozen Updating UpdateFailed.	Available
PaiTaskEnabled	boolean	Indica se o agendamento de tarefas do PAI está ativado. Valores válidos: 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. false: O agendamento de tarefas do PAI está desativado.	true
DevEnvironmentEnabled	boolean	Indica se o ambiente de desenvolvimento está ativado. Valores válidos: true: O ambiente de desenvolvimento está ativado. Nesse caso, o ambiente de desenvolvimento é isolado do ambiente de produção no workspace. 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 Develop está desativada. Valores válidos: false true.	false
AliyunResourceTags	array<object>	As tags.
	object	A tag.
Key	string	The tag key.	batch
Value	string	The tag value.	blue

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A1****",
  "Project": {
    "Id": 28477242,
    "Name": "sora_finance",
    "DisplayName": "Sora financial analysis",
    "Description": "Financial analysis group project data development",
    "Owner": "207947397706614299",
    "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.