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

Consulta os detalhes de um workspace 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

Projeto.

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ProjectId	integer	Não	O ID do workspace do DataWorks. Você pode chamar a operação ListProjects para obter o ID do workspace.	466230
ProjectIdentifier	string	Não	O nome do workspace do DataWorks. Você pode chamar a operação ListProjects para obter o nome do workspace.	test_project

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
Data	object	Os detalhes do workspace.
Appkey	string	Este parâmetro foi descontinuado.	0
BaseProject	boolean	Este parâmetro foi descontinuado.	false
DefaultDiResourceGroupIdentifier	string	O identificador do grupo de recursos padrão que é atribuído automaticamente quando você compra um grupo de recursos exclusivo do MaxCompute.	group_280749521****
Destination	integer	Este parâmetro foi descontinuado.	0
DevStorageQuota	string	Este parâmetro foi descontinuado.	0
DevelopmentType	integer	Este parâmetro foi descontinuado.	4
DisableDevelopment	boolean	Indica se a função de desenvolvimento está desativada. Valores válidos: false (padrão): A função de desenvolvimento está ativada. true: A função de desenvolvimento está desativada.	true
EnvTypes	array	O contexto de ambiente do workspace.
	string	Os ambientes do workspace: O modo básico contém apenas o ambiente de produção (PROD). O modo padrão contém o ambiente de desenvolvimento (DEV) e o ambiente de produção (PROD).	["PROD"]
GmtCreate	string	A hora em que o workspace foi criado. Exemplo: `Dec 3, 2019 9:12:20 PM`.	Oct 10, 2019 3:42:53 PM
GmtModified	string	A hora em que o workspace foi modificado pela última vez. Exemplo: `Dec 3, 2019 9:12:20 PM`.	Dec 3, 2019 9:12:20 PM
IsAllowDownload	integer	Indica se o download de resultados de consulta do IDE é permitido. Valores válidos: 1: O download é permitido. 0: O download não é permitido.	1
IsDefault	integer	Indica se o workspace é o workspace padrão. Valores válidos: 1: Sim. 0: Não.	1
MaxFlowNode	integer	Este parâmetro foi descontinuado.	1
ProdStorageQuota	string	Este parâmetro foi descontinuado.	1
ProjectDescription	string	A descrição do workspace.	test_describe
ProjectId	integer	O ID do workspace.	466230
ProjectIdentifier	string	O nome do workspace.	test_project
ProjectMode	integer	O modo do workspace. Valores válidos: 2: modo básico. 3: modo padrão.	2
ProjectName	string	O nome de exibição do workspace.	test_project
ProjectOwnerBaseId	string	O ID da Alibaba Cloud do proprietário do workspace.	18229311****
ProtectedMode	integer	Indica se o modo protegido está ativado para o workspace. Valores válidos: 1: O modo protegido está ativado. 0: O modo protegido não está ativado.	1
ResidentArea	string	O tipo do workspace. Valores válidos: private: zona privada. swap: zona de swap.	private
ResourceManagerResourceGroupId	string	O ID do grupo de recursos.	rg-acfmzbn7****
SchedulerMaxRetryTimes	integer	O número máximo padrão de reexecuções automáticas em caso de erro.	3
SchedulerRetryInterval	integer	O intervalo padrão entre reexecuções automáticas em caso de erro. Unidade: ms. O valor máximo é de 30 minutos. Observe a conversão de unidade.	120000
Status	integer	O status do workspace. Valores válidos: 0: AVAILABLE. O workspace está em execução normal. 1: DELETED. O workspace foi excluído. 2: INITIALIZING. O workspace está sendo inicializado. 3: INIT_FAILED. Falha ao inicializar o workspace. 4: FORBIDDEN. O workspace foi desativado manualmente. 5: DELETING. O workspace está sendo excluído. 6: DEL_FAILED. Falha ao excluir o workspace. 7: FROZEN. O workspace está congelado devido a pagamento em atraso. 8: UPDATING. O workspace está sendo atualizado (um mecanismo de computação está sendo adicionado e inicializado). 9: UPDATE_FAILED. Falha ao atualizar o workspace (falha ao adicionar e inicializar um mecanismo de computação).	0
TablePrivacyMode	integer	A visibilidade das tabelas do MaxCompute. Valores válidos: 0: As tabelas do MaxCompute não ficam visíveis para os usuários dentro do tenant. 1: As tabelas do MaxCompute ficam visíveis para os usuários dentro do tenant.	1
Tags	array<object>	A lista de tags vinculadas ao workspace.
	object	Os detalhes da tag.
Key	string	A chave da tag.	key
Value	string	O valor da tag.	value
TenantId	integer	O ID do tenant.	280749521
UseProxyOdpsAccount	boolean	Indica se uma conta de proxy é usada para acessar o mecanismo do MaxCompute.	true
HttpStatusCode	integer	O código de status HTTP.	200
RequestId	string	O ID da solicitação.	1AFAE64E-D1BE-432B-A9****
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "Data": {
    "Appkey": "0",
    "BaseProject": false,
    "DefaultDiResourceGroupIdentifier": "group_280749521****",
    "Destination": 0,
    "DevStorageQuota": "0",
    "DevelopmentType": 4,
    "DisableDevelopment": true,
    "EnvTypes": [
      "[\"PROD\"]"
    ],
    "GmtCreate": "Oct 10, 2019 3:42:53 PM",
    "GmtModified": "Dec 3, 2019 9:12:20 PM",
    "IsAllowDownload": 1,
    "IsDefault": 1,
    "MaxFlowNode": 1,
    "ProdStorageQuota": " 1",
    "ProjectDescription": "test_describe",
    "ProjectId": 466230,
    "ProjectIdentifier": "test_project",
    "ProjectMode": 2,
    "ProjectName": "test_project",
    "ProjectOwnerBaseId": "18229311****",
    "ProtectedMode": 1,
    "ResidentArea": "private",
    "ResourceManagerResourceGroupId": "rg-acfmzbn7****",
    "SchedulerMaxRetryTimes": 3,
    "SchedulerRetryInterval": 120000,
    "Status": 0,
    "TablePrivacyMode": 1,
    "Tags": [
      {
        "Key": "key",
        "Value": "value"
      }
    ],
    "TenantId": 280749521,
    "UseProxyOdpsAccount": true
  },
  "HttpStatusCode": 200,
  "RequestId": "1AFAE64E-D1BE-432B-A9****",
  "Success": true
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	Invalid.Tenant.ProjectNotExists	The project does not exist.	O projeto não existe.
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.