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

Consulta as informações 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:GetProjectDetail

get

Project

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ProjectId	integer	Sim	O ID do workspace do DataWorks.	27

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
HttpStatusCode	integer	O código de status HTTP.	200
RequestId	string	O ID da solicitação.	0bc1411515937635973****
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
Data	object	As informações do workspace.
Status	integer	O status do workspace.	0
ResidentArea	string	O tipo do workspace. Valores válidos: private e swap.	private
ProjectId	integer	O ID do workspace.	27
ProjectIdentifier	string	O identificador exclusivo do workspace.	abc
ProjectName	string	O nome de exibição do workspace.	abc
IsAllowDownload	integer	Indica se a operação de download é permitida.	1
ProjectMode	integer	O modo do workspace. O valor 2 indica que o workspace está no modo básico. O valor 3 indica que o workspace está no modo padrão.	1
ProjectDescription	string	A descrição do workspace.	abc
GmtModified	string	A hora em que o workspace foi modificado pela última vez.	Dec 3, 2019 9:12:20 PM
ProjectOwnerBaseId	string	O ID da conta Alibaba Cloud usada pelo proprietário do workspace.	18229311****
DevelopmentType	integer	O tipo de desenvolvimento do workspace. O valor é fixo em 4.	4
DefaultDiResourceGroupIdentifier	string	O identificador do grupo de recursos compartilhado para Data Integration no qual os nós são executados.	group_280749521****
GmtCreate	string	A hora em que o workspace foi criado.	Oct 10, 2019 3:42:53 PM
SchedulerMaxRetryTimes	integer	O número máximo padrão de reexecuções automáticas permitidas após a ocorrência de um erro.	3
ProtectedMode	integer	Indica se o recurso de proteção do workspace está ativado.	1
TenantId	integer	O ID do tenant.	280749521950784
SchedulerRetryInterval	integer	O intervalo entre reexecuções automáticas após a ocorrência de um erro.	120000
EnvTypes	array	Os ambientes de workspaces em diferentes modos. Workspaces no modo básico fornecem apenas o ambiente de produção. Workspaces no modo padrão fornecem tanto o ambiente de desenvolvimento quanto o ambiente de produção.
	string	O ambiente do workspace em um modo diferente. Workspaces no modo básico fornecem apenas o ambiente de produção. Workspaces no modo padrão fornecem tanto o ambiente de desenvolvimento quanto o ambiente de produção.	["PROD"]
ResourceManagerResourceGroupId	string	O ID do grupo de recursos.	rg-acfmzbn7pti3zfa
Tags	array<object>	As informações de tag.
	object
Key	string	The tag key.	Env
Value	string	The tag value.	Test
DisableDevelopment	boolean	Indica se a função Develop está desativada. Valores válidos: false (padrão) true	true
UseProxyOdpsAccount	boolean	Indica se uma conta proxy é usada para acessar o mecanismo de computação do MaxCompute.	true
TablePrivacyMode	integer	Indica se as tabelas do MaxCompute no workspace estão visíveis para os usuários dentro de um tenant. Valores válidos: 0: As tabelas do MaxCompute no workspace não estão visíveis para os usuários dentro de um tenant. 1: As tabelas do MaxCompute no workspace estão visíveis para os usuários dentro de um tenant.	1
IsDefault	integer	Indica se o workspace é um workspace padrão. Valores válidos: 1: O workspace é um workspace padrão. 0: O workspace não é um workspace padrão.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "RequestId": "0bc1411515937635973****",
  "Success": true,
  "Data": {
    "Status": 0,
    "ResidentArea": "private",
    "ProjectId": 27,
    "ProjectIdentifier": "abc",
    "ProjectName": "abc",
    "IsAllowDownload": 1,
    "ProjectMode": 1,
    "ProjectDescription": "abc",
    "GmtModified": "Dec 3, 2019 9:12:20 PM",
    "ProjectOwnerBaseId": "18229311****",
    "DevelopmentType": 4,
    "DefaultDiResourceGroupIdentifier": "group_280749521****",
    "GmtCreate": "Oct 10, 2019 3:42:53 PM",
    "SchedulerMaxRetryTimes": 3,
    "ProtectedMode": 1,
    "TenantId": 280749521950784,
    "SchedulerRetryInterval": 120000,
    "EnvTypes": [
      "[\"PROD\"]"
    ],
    "ResourceManagerResourceGroupId": "rg-acfmzbn7pti3zfa",
    "Tags": [
      {
        "Key": "Env",
        "Value": "Test"
      }
    ],
    "DisableDevelopment": true,
    "UseProxyOdpsAccount": true,
    "TablePrivacyMode": 1,
    "IsDefault": 1
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	Invalid.Tenant.ConnectionNotExists	The connection does not exist.	The connection does not exist.
400	Invalid.Tenant.ProjectNotExists	The project does not exist.	The project does not exist.
400	Invalid.Tenant.UserNotInProject	The user is not in the project.	The user is not in the project.
403	Invalid.Tenant.UserIsNotProjectOwnerOrAdmin	The user is not a project administrator or owner.	The user is not a project administrator or owner.
403	Invalid.Tenant.UserNotInTenant	The user is not in tenant.	The user is not in tenant.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.