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

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

Nota

Esta API foi descontinuada. Recomendamos migrar para dataworks-public(2020-05-18) - GetProject para funcionalidade aprimorada e suporte contínuo. Embora a API descontinuada permaneça temporariamente acessível, nenhuma atualização ou correção de bugs será fornecida.

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

Projeto.

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
Data	object	A descrição do workspace.
DefaultDiResourceGroupIdentifier	string	O identificador do grupo de recursos de integração de dados padrão para nós.	group_280749521****
DevelopmentType	integer	O tipo de desenvolvimento do projeto. O valor é 4.	4
DisableDevelopment	boolean	Indica se a função de desenvolvimento está desativada. Valores válidos:\n - false (padrão): A função de desenvolvimento está ativada.\n - true: A função de desenvolvimento está desativada.	true
EnvTypes	array	Os ambientes contidos no workspace. Um workspace no modo básico contém apenas o ambiente de produção (PROD). Um workspace no modo padrão contém o ambiente de desenvolvimento (DEV) e o ambiente de produção (PROD).
	string	Os ambientes contidos no workspace. Um workspace no modo básico contém apenas o ambiente de produção (PROD). Um workspace no modo padrão contém o ambiente de desenvolvimento (DEV) e o ambiente de produção (PROD).	["PROD"]
GmtCreate	string	O horário em que o workspace foi criado.	Oct 10, 2019 3:42:53 PM
GmtModified	string	O horário em que o workspace foi modificado pela última vez.	Dec 3, 2019 9:12:20 PM
IsAllowDownload	integer	Indica se os downloads são permitidos.	1
IsDefault	integer	Indica se o workspace é o workspace padrão. Valores válidos:\n- 1: Sim.\n- 0: Não.	1
ProjectDescription	string	A descrição do workspace.	abc
ProjectId	integer	O ID do workspace.	27
ProjectIdentifier	string	O identificador do workspace.	abc
ProjectMode	integer	O modo do workspace. O valor 2 indica o modo básico. O valor 3 indica o modo padrão.	1
ProjectName	string	O nome de exibição do workspace.	abc
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.	1
ResidentArea	string	O tipo do workspace. O valor private indica uma zona privada. O valor swap indica uma zona de swap.	private
ResourceManagerResourceGroupId	string	O ID do grupo de recursos.	rg-acfmzbn7pti3zfa
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.	120000
Status	integer	O status do workspace.	0
TablePrivacyMode	integer	A visibilidade das tabelas do MaxCompute. Valores válidos:\n- 0: As tabelas do MaxCompute não são visíveis para os usuários do locatário.\n- 1: As tabelas do MaxCompute são visíveis para os usuários do locatário.	1
Tags	array<object>	As informações de tag.
	object	As informações de tag.
Key	string	A chave da tag.	Env
Value	string	O valor da tag.	Teste
TenantId	integer	O ID do locatário.	280749521950784
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.	0bc1411515937635973****
Success	boolean	Indica se as informações do workspace foram consultadas com sucesso.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "Data": {
    "DefaultDiResourceGroupIdentifier": "group_280749521****",
    "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,
    "ProjectDescription": "abc",
    "ProjectId": 27,
    "ProjectIdentifier": "abc",
    "ProjectMode": 1,
    "ProjectName": "abc",
    "ProjectOwnerBaseId": "18229311****",
    "ProtectedMode": 1,
    "ResidentArea": "private",
    "ResourceManagerResourceGroupId": "rg-acfmzbn7pti3zfa",
    "SchedulerMaxRetryTimes": 3,
    "SchedulerRetryInterval": 120000,
    "Status": 0,
    "TablePrivacyMode": 1,
    "Tags": [
      {
        "Key": "Env",
        "Value": "Test"
      }
    ],
    "TenantId": 280749521950784,
    "UseProxyOdpsAccount": true
  },
  "HttpStatusCode": 200,
  "RequestId": "0bc1411515937635973****",
  "Success": true
}

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.	A origem de dados não existe.
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.