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

Consulta os detalhes de um workspace do DataWorks.

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: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 de gerenciamento de workspaces para obter o ID. Este parâmetro especifica o workspace do DataWorks para esta chamada de API.	123456

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
RequestId	string	O ID da solicitação, usado para localizar logs e solucionar problemas.	22C97E95-F023-56B5-8852-B1A77A1****
Project	object	Os detalhes do 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.	Análise financeira Sora
Description	string	A descrição do workspace.	Desenvolvimento de dados do projeto do grupo de análise financeira
Owner	string	O ID de usuário do proprietário do workspace, que corresponde ao ID da conta Alibaba Cloud.	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: O workspace está funcionando normalmente. Initializing: O workspace está sendo inicializado. InitFailed: Falha na inicialização do workspace. Forbidden: O workspace foi desativado manualmente. Deleting: O workspace está sendo excluído. DeleteFailed: Falha na exclusão do workspace. Frozen: O workspace está congelado devido a pagamento em atraso. Updating: O workspace está sendo atualizado. UpdateFailed: Falha na atualização do workspace.	Available
PaiTaskEnabled	boolean	Indica se o agendamento de tarefas do PAI está ativado. Valores válidos: true: Você pode criar nós do Machine Learning Platform for AI (PAI) no workspace do DataWorks e executá-los em um cronograma periódico com base nas configurações dos nós. 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 para o workspace, o que suporta isolamento entre os ambientes de desenvolvimento e produção. false: Apenas o ambiente de produção é utilizado.	true
DevRoleDisabled	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.	false
AliyunResourceTags	array<object>	As tags.
	object	Os detalhes da tag.
Key	string	A chave da tag.	batch
Value	string	O valor da tag.	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.