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

Consulta as informações básicas de um projeto MaxCompute.

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

odps:GetProject

get

*Projeto.

acs:odps:{#regionId}:{#accountId}:projects/{#ProjectName}

Nenhuma

Sintaxe da solicitação

GET /api/v1/projects/{projectName} HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
projectName	string	Sim	O nome do projeto.	odps_project

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
verbose	boolean	Não	Especifica se devem ser incluídas informações adicionais (securityProperties, superAdmins).	true
withStorageTierInfo	boolean	Não	Especifica se devem ser incluídas informações adicionais (properties.storageTierInfo).	true
withQuotaProductType	boolean	Não	Especifica se devem ser incluídas informações adicionais (productType).	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
data	object	Os dados de resposta.
comment	string	A descrição do projeto.	BI_Analysis
costStorage	string	O tamanho total de armazenamento. Exibe o tamanho de armazenamento atual do projeto. Este tamanho de armazenamento é consistente com o padrão de medição, que corresponde ao tamanho de armazenamento lógico após a coleta e compactação dos dados no nível do projeto.	16489027
createdTime	integer	A hora de criação.	1704380838000
defaultQuota	string	A cota de computação padrão. Usada para alocação de recursos de computação. Se nenhuma cota de computação for especificada, os jobs iniciados por este projeto consumirão recursos da cota padrão. Para obter mais informações sobre o uso de recursos de computação, consulte Recursos de computação - Uso de cotas.	os_PayAsYouGoQuota
ipWhiteList	object	A lista de permissões de IP.
ipList	string	A lista de permissões de IP para a rede de interconexão de Internet e serviços em nuvem. Nota Se apenas a lista de permissões de IP da rede de interconexão de Internet e serviços em nuvem estiver configurada, o acesso a partir da Internet e da rede de interconexão de serviços em nuvem será restrito pela configuração, e todo o acesso à rede VPC será proibido.	10.88.111.3
vpcIpList	string	A lista de permissões de IP para redes VPC. Nota Se apenas a lista de permissões de IP da rede VPC estiver configurada, o acesso à rede VPC será restrito pela configuração, e todo o acesso a partir da Internet e da rede de interconexão de serviços em nuvem será proibido.	10.88.111.3
name	string	O nome do projeto.	odps_project
owner	string	As informações da conta do proprietário do projeto.	ALIYUN$odps****@aliyunid.com
productType	string	O método de cobrança da cota de computação padrão.	PayAsYouGo
properties	object	As propriedades básicas do projeto.
allowFullScan	boolean	Especifica se as varreduras completas de tabela são permitidas no projeto. As varreduras completas de tabela consomem uma grande quantidade de recursos. Para melhorar a eficiência do processamento, esse recurso é desativado por padrão.	false
autoMvQuotaGb	integer
elderTunnelQuota	string	O grupo pai do grupo de recursos EPS de transferência de dados anexado ao projeto. Você pode ignorar este parâmetro.	Default_p
enableAutoMv	boolean
enableDataMasking	boolean
enableDecimal2	boolean	Especifica se o tipo de dados Decimal do MaxCompute 2.0 está ativado para o projeto.	true
enableDr	boolean
enableFdcCacheForce	boolean	Especifica se o cache de tabelas externas deve ser ativado de forma forçada.	true
enableTieredStorage	boolean	Especifica se o armazenamento em camadas está ativado.	true
enableTunnelQuotaRoute	boolean	Especifica se o roteamento do grupo de recursos EPS de transferência de dados está ativado. true: As tarefas de transferência de dados enviadas por este projeto usam o grupo de recursos EPS de transferência de dados vinculado por padrão. false: As tarefas de transferência de dados enviadas por este projeto usam o grupo de recursos EPS de transferência de dados compartilhado por padrão.	true
encryption	object	As propriedades de criptografia de armazenamento.
algorithm	string	O algoritmo de criptografia de dados. Os algoritmos de criptografia suportados incluem AES256, AESCTR e RC4.	AES256
enable	boolean	Especifica se a criptografia de dados está ativada para o projeto. Para obter mais informações sobre a criptografia de dados, consulte Criptografia de armazenamento.	true
key	string	O tipo de chave usada para criptografia de dados, incluindo a chave padrão (MaxCompute Default Key) e Bring Your Own Key (BYOK). A chave padrão (MaxCompute Default Key) é uma chave padrão criada internamente pelo MaxCompute.	dafault
externalProjectProperties	object	As propriedades do projeto externo.
externalCatalogId	string
foreignServerName	string
foreignServerType	string
isExternalCatalogBound	string	Indica se este é um projeto externo da Solução Data Lakehouse 2.0.	true
tableFormat	string
warehouse	string
fdcQuota	string	A cota de cache de tabelas externas.	fdc_quota
retentionDays	integer	O número de dias em que os dados de backup são retidos. Durante esse período, você pode restaurar a versão atual para qualquer versão de dados com backup. Valores válidos: 0 a 30. Valor padrão: 1. Um valor de 0 indica que o recurso de backup está desativado.	1
sqlMeteringMax	string	O limite máximo para uma única instrução SQL. Unidade: volume de varredura (GB) × complexidade.	1500
storageTierInfo	object	As informações de armazenamento em camadas.
projectBackupSize	integer	O tamanho de armazenamento de backup.	86672917
projectTotalSize	integer	O uso total de armazenamento.	56066037
storageTierSize	object	As informações de armazenamento em camadas.
longTermSize	integer	O uso de armazenamento de longo prazo.	21764917
lowFrequencySize	integer	O uso de armazenamento de baixa frequência.	767693
standardSize	integer	O uso de armazenamento padrão.	27649172
tableLifecycle	object	As propriedades de ciclo de vida da tabela.
type	string	O tipo de ciclo de vida. Valores válidos: mandatory: A cláusula Lifecycle é obrigatória. Você deve definir o ciclo de vida da tabela. optional: A cláusula Lifecycle é opcional ao criar uma tabela. Se o ciclo de vida não for definido, a tabela será permanentemente válida. inherit: Se o ciclo de vida não for definido ao criar uma tabela, o ciclo de vida da tabela será o valor de odps.table.lifecycle.value.	optional
value	string	O ciclo de vida da tabela. Unidade: dias. Valores válidos: 1 a 37231. Valor padrão: 37231.	37231
tableLifecycleConfig	object	As propriedades das regras de ciclo de vida do armazenamento em camadas. Após a configuração, o sistema aciona automaticamente a conversão de camada de armazenamento com base nessas regras.
TierToLongterm	object	O identificador de armazenamento de longo prazo.
DaysAfterLastAccessGreaterThan	integer	O número de dias após a hora do último acesso aos dados antes que a configuração seja aplicada automaticamente. Isso corresponde ao LastAccessTime da tabela ou partição. Nota Se o LastAccessTime da tabela ou partição estiver vazio: Para tabelas ou partições criadas antes de 1 de outubro de 2023, o cálculo usa como padrão 2023.10.01 00:00:00 no fuso horário UTC+0. Para tabelas ou partições criadas após 1 de outubro de 2023, se os dados não tiverem sido acessados, o cálculo será baseado no CreateTime.	180
DaysAfterLastModificationGreaterThan	integer	O número de dias após a hora da última modificação dos dados antes que a configuração seja aplicada automaticamente. Isso corresponde ao LastModifiedTime da tabela ou partição.	180
DaysAfterLastTierModificationGreaterThan	integer	O número de dias desde a última conversão de camada de armazenamento.	1
TierToLowFrequency	object	O identificador de armazenamento de baixa frequência.
DaysAfterLastAccessGreaterThan	integer	O número de dias após a hora do último acesso aos dados antes que a configuração seja aplicada automaticamente. Isso corresponde ao LastAccessTime da tabela ou partição. Nota Se o LastAccessTime da tabela ou partição estiver vazio: Para tabelas ou partições criadas antes de 1 de outubro de 2023, o cálculo usa como padrão 2023.10.01 00:00:00 no fuso horário UTC+0. Para tabelas ou partições criadas após 1 de outubro de 2023, se os dados não tiverem sido acessados, o cálculo será baseado no CreateTime.	30
DaysAfterLastModificationGreaterThan	integer	O número de dias após a hora da última modificação dos dados antes que a configuração seja aplicada automaticamente. Isso corresponde ao LastModifiedTime da tabela ou partição.	30
DaysAfterLastTierModificationGreaterThan	integer	O número de dias desde a última conversão de camada de armazenamento.	1
timezone	string	O fuso horário do projeto, que é a propriedade odps.sql.timezone.	Asia/Shanghai
tunnelQuota	string	O grupo de recursos do serviço de transferência de dados vinculado ao projeto. Default (grupo de recursos EPS de transferência de dados compartilhado): O projeto não tem permissão para usar um grupo de recursos do serviço de transferência de dados (assinatura). Independentemente da configuração padrão do grupo de recursos EPS de transferência de dados, as tarefas de transferência de dados enviadas por este projeto usam automaticamente o grupo de recursos Default. Grupo de recursos do serviço de transferência de dados (assinatura): O projeto tem permissão para usar um grupo de recursos do serviço de transferência de dados (assinatura).	Default
typeSystem	string	A versão do tipo de dados. Valores válidos: 1: versão 1.0 2: versão 2.0 hive: tipo compatível com Hive Para obter as diferenças entre as três versões de tipo de dados, consulte Edições de tipo de dados.	2.0
regionId	string	O ID da região.	cn-beijing
saleTag	object	O ID da instância e o tipo de cobrança da cota de computação padrão.
resourceId	string	O ID da instância da cota de computação padrão.	b7afb7d1-**--**-c393669c307b
resourceType	string	O tipo de cobrança da cota de computação padrão.	PayAsYouGo
securityProperties	object	As propriedades de segurança.
enableDownloadPrivilege	boolean	Especifica se o recurso de controle de permissão de download está ativado. Este recurso é desativado por padrão.	false
enableNamespacePrivilege	boolean	Especifica se as permissões IAM devem ser ativadas.
labelSecurity	boolean	Especifica se o recurso de controle de acesso baseado em rótulos está ativado. Este recurso é desativado por padrão.	false
objectCreatorHasAccessPermission	boolean	Especifica se os criadores de objetos têm permissão para ter permissões de acesso aos objetos que criam. Isso é ativado por padrão.	true
objectCreatorHasGrantPermission	boolean	Especifica se os criadores de objetos têm permissão para ter permissões de concessão nos objetos que criam. Isso é ativado por padrão.	true
projectProtection	object	As propriedades de proteção de dados.
exceptionPolicy	string	Se a proteção de dados do projeto estiver ativada, você pode definir exceções ou projetos confiáveis para permitir que usuários especificados exportem dados de objetos especificados para projetos especificados. Todos os cenários descritos na política de exceção podem substituir o mecanismo de proteção de dados.	{ "Version": "1", "Statement": [ { "Effect": "Allow", "Principal": "", "Action": [ "odps:[, , ...]" ], "Resource": "acs:odps:*:", "Condition": { "StringEquals": { "odps:TaskType": [ "" ] } } } ] }
protected	boolean	Indica o status de ativação do mecanismo de proteção de dados para o projeto, que proíbe ou permite que o fluxo de dados saia do projeto. Isso é desativado por padrão.	true
usingAcl	boolean	Especifica se o recurso de controle de acesso baseado em ACL está ativado. Este recurso é ativado por padrão.	true
usingPolicy	boolean	Especifica se o recurso de controle de acesso baseado em políticas está ativado. Este recurso é ativado por padrão.	true
status	string	O status do projeto. Valores válidos: AVAILABLE: Normal. READONLY: Somente leitura. FROZEN: Congelado. DELETING: Sendo excluído.	AVAILABLE
superAdmins	array	A lista de membros com a função Super_Administrator no projeto.
	string	As informações da conta das contas de membros com a função Super_Administrator no projeto.	RAM$odps****@aliyunid.com:RAM_USER
threeTierModel	boolean	Indica se o armazenamento baseado em schema é suportado. O MaxCompute suporta schemas, que são objetos sob um projeto e acima de tabelas, recursos e UDFs, usados para categorizar tabelas, recursos e UDFs. Um projeto pode conter vários schemas. Para obter mais informações, consulte Operações de schema.	true
type	string	O tipo de projeto. Valores válidos: managed: Projeto interno. external: Projeto externo.	managed
errorCode	string	O código de erro.	OBJECT_NOT_EXIST
errorMsg	string	A mensagem de erro.	This object does not exist.
httpCode	integer	O código de status HTTP. 1xx: Resposta informativa - A solicitação foi recebida e está sendo processada. 2xx: Sucesso - A solicitação foi recebida, compreendida e aceita com sucesso pelo servidor. 3xx: Redirecionamento - A solicitação foi redirecionada. Uma ação adicional é necessária para concluir a solicitação. 4xx: Erro do cliente - A solicitação contém parâmetros inválidos, erros de sintaxe ou condições de solicitação específicas que não podem ser atendidas. 5xx: Erro do servidor - O servidor não pode atender à solicitação devido a outros motivos.	200
requestId	string	O ID da solicitação.	0b87b7b316643495896551555e855b

Exemplos

Resposta de sucesso

JSON formato

{
  "data": {
    "comment": "BI_Analysis",
    "costStorage": "16489027",
    "createdTime": 1704380838000,
    "defaultQuota": "os_PayAsYouGoQuota",
    "ipWhiteList": {
      "ipList": "10.88.111.3",
      "vpcIpList": "10.88.111.3"
    },
    "name": "odps_project",
    "owner": "ALIYUN$odps****@aliyunid.com",
    "productType": "PayAsYouGo",
    "properties": {
      "allowFullScan": false,
      "autoMvQuotaGb": 0,
      "elderTunnelQuota": "Default_p",
      "enableAutoMv": false,
      "enableDataMasking": false,
      "enableDecimal2": true,
      "enableDr": false,
      "enableFdcCacheForce": true,
      "enableTieredStorage": true,
      "enableTunnelQuotaRoute": true,
      "encryption": {
        "algorithm": "AES256",
        "enable": true,
        "key": "dafault"
      },
      "externalProjectProperties": {
        "externalCatalogId": "",
        "foreignServerName": "",
        "foreignServerType": "",
        "isExternalCatalogBound": "true",
        "tableFormat": "",
        "warehouse": ""
      },
      "fdcQuota": "fdc_quota",
      "retentionDays": 1,
      "sqlMeteringMax": "1500",
      "storageTierInfo": {
        "projectBackupSize": 86672917,
        "projectTotalSize": 56066037,
        "storageTierSize": {
          "longTermSize": 21764917,
          "lowFrequencySize": 767693,
          "standardSize": 27649172
        }
      },
      "tableLifecycle": {
        "type": "optional",
        "value": "37231"
      },
      "tableLifecycleConfig": {
        "TierToLongterm": {
          "DaysAfterLastAccessGreaterThan": 180,
          "DaysAfterLastModificationGreaterThan": 180,
          "DaysAfterLastTierModificationGreaterThan": 1
        },
        "TierToLowFrequency": {
          "DaysAfterLastAccessGreaterThan": 30,
          "DaysAfterLastModificationGreaterThan": 30,
          "DaysAfterLastTierModificationGreaterThan": 1
        }
      },
      "timezone": "Asia/Shanghai",
      "tunnelQuota": "Default",
      "typeSystem": "2.0"
    },
    "regionId": "cn-beijing",
    "saleTag": {
      "resourceId": "b7afb7d1-****-****-****-c393669c307b",
      "resourceType": "PayAsYouGo"
    },
    "securityProperties": {
      "enableDownloadPrivilege": false,
      "enableNamespacePrivilege": false,
      "labelSecurity": false,
      "objectCreatorHasAccessPermission": true,
      "objectCreatorHasGrantPermission": true,
      "projectProtection": {
        "exceptionPolicy": "{\n      \"Version\": \"1\",\n      \"Statement\": [\n            {\n                  \"Effect\": \"Allow\",\n                  \"Principal\": \"\",\n                  \"Action\": [\n                        \"odps:[, , ...]\"\n                  ],\n                  \"Resource\": \"acs:odps:*:\",\n                  \"Condition\": {\n                        \"StringEquals\": {\n                              \"odps:TaskType\": [\n                                    \"\"\n                              ]\n                        }\n                  }\n            }\n      ]\n}",
        "protected": true
      },
      "usingAcl": true,
      "usingPolicy": true
    },
    "status": "AVAILABLE",
    "superAdmins": [
      "RAM$odps****@aliyunid.com:RAM_USER"
    ],
    "threeTierModel": true,
    "type": "managed"
  },
  "errorCode": "OBJECT_NOT_EXIST",
  "errorMsg": "Este objeto não existe",
  "httpCode": 200,
  "requestId": "0b87b7b316643495896551555e855b"
}

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.