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

Lista os projetos do 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:ListProjects

list

Projeto.

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

Nenhuma

Sintaxe da solicitação

GET /api/v1/projects HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
tenantId	string	Não	O ID do locatário. Você pode visualizar o ID do locatário fazendo login no console do MaxCompute e escolhendo Gerenciamento de Locatários > Propriedades do Locatário no painel de navegação à esquerda.	5495****3697
region	string	Não	O ID da região.	cn-beijing
quotaNickName	string	Não	O apelido da cota. Você pode visualizar o apelido da cota fazendo login no console do MaxCompute e escolhendo Workspace > Gerenciamento de Cotas no painel de navegação à esquerda.	os_PayAsYouGoQuota
quotaName	string	Não	O nome da cota. O nome é gerado automaticamente pelo sistema. Você pode visualizar o nome da cota fazendo login no console do MaxCompute e escolhendo Workspace > Gerenciamento de Cotas no painel de navegação à esquerda.	aliyun_5495***3697
prefix	string	Não	O prefixo usado para filtrar os nomes dos recursos retornados. Os nomes dos recursos retornados devem começar com o prefixo especificado. Por exemplo, se o prefixo for a, todos os nomes dos recursos retornados começarão com a.	a
marker	string	Não	O marcador usado para especificar o ponto inicial dos resultados retornados. Os resultados são classificados em ordem alfabética e retornados a partir do primeiro item após o marcador.	cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==
maxItem	integer	Não	O número máximo de resultados a serem retornados por página. Valor padrão: 10.	10
saleTags	string	Não	O ID da instância e o método de faturamento da cota de computação padrão.	{ "resourceId": "b7afb7d1-**--**-c393669c307b", "resourceType": "PayAsYouGo" }
type	string	Não	O tipo de projeto. Valores válidos: managed: projeto interno external: projeto externo	managed
sortBy	string	Não	O campo usado para ordenar os resultados. Atualmente, apenas createdTime é suportado. Valores válidos: createdTime : createdTime.	createdTime
sortOrder	string	Não	A ordem de classificação. Este parâmetro entra em vigor apenas quando sortBy é especificado. Valores válidos: ASC e DESC. Os valores não diferenciam maiúsculas de minúsculas. Valores válidos: ASC : Ordem crescente. DESC : Ordem decrescente.	DESC
listSystemCatalog	boolean	Não	Especifica se deve listar o projeto integrado SYSTEM_CATALOG. Este projeto fornece informações como metadados do projeto e histórico de uso. Para obter mais informações, consulte o recurso Information Schema. Valores válidos: false : Não listar. true : Listar.	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
requestId	string	O ID da solicitação.	0b16399216671970335563173e2340
data	object	Os resultados retornados.
projects	array<object>	A lista de projetos.
	array<object>	As informações do projeto.
name	string	Os nomes dos projetos.	odps_project
owner	string	As informações da conta do proprietário do projeto.	ALIYUN$odps****@aliyunid.com
type	string	O tipo de projeto. Valores válidos: managed: projeto interno external: projeto externo	managed
comment	string	A descrição do projeto.	BI_Analysis
defaultQuota	string	A cota de computação padrão. Isso é usado para alocar recursos de computação. Se nenhuma cota de computação for especificada, os jobs iniciados no projeto consumirão recursos da cota padrão. Para obter mais informações sobre como usar recursos de computação, consulte Uso de recursos de computação.	os_PayAsYouGoQuota
status	string	O status do projeto. Valores válidos: AVAILABLE: normal READONLY: somente leitura FROZEN: congelado DELETING: excluindo	AVAILABLE
costStorage	string	O tamanho total de armazenamento. Este valor indica o tamanho de armazenamento atual do projeto e é consistente com a métrica de faturamento. Ele representa o tamanho de armazenamento lógico após a compactação de dados no nível do projeto.	16489027
regionId	string	O ID da região.	cn-beijing
createdTime	integer	A hora de criação. O horário é um carimbo de data/hora UNIX em milissegundos.	1704380838000
properties	object	As propriedades básicas do projeto.
timezone	string	O fuso horário do projeto, que é a propriedade odps.sql.timezone.	Asia/Shanghai
retentionDays	integer	O período de retenção dos dados de backup em dias. 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
allowFullScan	boolean	Especifica se deve permitir varreduras completas de tabelas no projeto. As varreduras completas de tabelas consomem uma grande quantidade de recursos. Para melhorar a eficiência do processamento, esse recurso é desativado por padrão.	false
typeSystem	string	A edição do tipo de dados. Valores válidos: 1: Edição do tipo de dados do MaxCompute V1.0 2: Edição do tipo de dados do MaxCompute V2.0 hive: Edição do tipo de dados compatível com Hive Para obter mais informações sobre as diferenças entre as três edições de tipos de dados, consulte Edições de tipos de dados.	2
enableDecimal2	boolean	Especifica se deve ativar o tipo de dados DECIMAL do MaxCompute V2.0 para o projeto.	true
sqlMeteringMax	string	O limite máximo para o consumo de uma única instrução SQL. Unidade: volume de dados verificados (GB) × complexidade.	1500
tableLifecycle	object	As propriedades de ciclo de vida das tabelas.
type	string	O tipo de ciclo de vida. Valores válidos: mandatory: A cláusula LIFECYCLE é obrigatória. Você deve especificar um ciclo de vida para a tabela. optional: A cláusula LIFECYCLE é opcional ao criar uma tabela. Se você não especificar um ciclo de vida para a tabela, ela nunca expirará. inherit: Se você não especificar um ciclo de vida para uma tabela ao criá-la, o ciclo de vida da tabela será o valor do parâmetro 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
encryption	object	As propriedades de criptografia de armazenamento.
enable	boolean	Especifica se deve ativar a criptografia de dados para o projeto. Para obter mais informações sobre criptografia de dados, consulte Criptografia de armazenamento.	true
algorithm	string	O algoritmo de criptografia de dados. Os algoritmos de criptografia suportados pela chave incluem AES256, AESCTR e RC4.	AES256
key	string	O tipo de chave usada para criptografia de dados. Os valores válidos incluem a chave padrão (MaxCompute Default Key) e Bring Your Own Key (BYOK). A chave padrão é uma chave padrão criada internamente pelo MaxCompute.	dafault
tunnelQuota	string	O grupo de recursos EPS do serviço de transferência de dados vinculado ao projeto. Padrão (grupo de recursos EPS compartilhado para o serviço de transferência de dados): O projeto não tem permissão para usar o grupo de recursos EPS por assinatura para o serviço de transferência de dados. Independentemente da configuração do grupo de recursos EPS padrão, as tarefas de transferência de dados enviadas por padrão neste projeto usam automaticamente o grupo de recursos EPS padrão. Grupo de recursos EPS por assinatura para o serviço de transferência de dados: O projeto tem permissão para usar o grupo de recursos EPS por assinatura para o serviço de transferência de dados.	Default
enableTunnelQuotaRoute	boolean	Especifica se deve ativar o roteamento do grupo de recursos EPS para o serviço de transferência de dados. true: As tarefas de transferência de dados enviadas por padrão no projeto usam o grupo de recursos EPS vinculado para o serviço de transferência de dados. false: As tarefas de transferência de dados enviadas por padrão no projeto usam o grupo de recursos EPS compartilhado para o serviço de transferência de dados.	true
externalProjectProperties	object	As propriedades do projeto externo.
isExternalCatalogBound	string	Especifica se o projeto é um projeto externo da Solução Data Lakehouse 2.0.	true
securityProperties	object	As propriedades de segurança.
usingAcl	boolean	Especifica se deve usar o recurso de controle de acesso baseado em ACL. Por padrão, esse recurso está ativado.	true
usingPolicy	boolean	Especifica se deve usar o recurso de controle de acesso baseado em política. Por padrão, esse recurso está ativado.	true
objectCreatorHasAccessPermission	boolean	Especifica se deve permitir que os criadores de objetos tenham permissões de acesso aos objetos. Por padrão, isso é permitido.	true
objectCreatorHasGrantPermission	boolean	Especifica se deve permitir que os criadores de objetos tenham permissões de autorização sobre os objetos. Por padrão, isso é permitido.	true
labelSecurity	boolean	Especifica se deve usar o recurso de controle de acesso baseado em rótulos. Por padrão, esse recurso está desativado.	false
enableDownloadPrivilege	boolean	Especifica se deve usar o recurso de controle de download. Por padrão, esse recurso está desativado.	false
projectProtection	object	As propriedades do mecanismo de proteção de dados.
protected	boolean	Especifica se deve ativar o mecanismo de proteção de dados para o projeto, a fim de proibir ou permitir o fluxo de dados para fora do projeto. O status de ativação padrão é desativado.	true
exceptionPolicy	string	Se você ativar a proteção de dados para o projeto, poderá configurar exceções ou projetos confiáveis para permitir que usuários especificados transfiram dados de objetos especificados para projetos especificados. Todos os cenários descritos na política de exceção podem contornar o mecanismo de proteção de dados.	{ "Version": "1", "Statement": [ { "Effect": "Allow", "Principal": "", "Action": [ "odps:[, , ...]" ], "Resource": "acs:odps:*:", "Condition": { "StringEquals": { "odps:TaskType": [ "" ] } } } ] }
ipWhiteList	object	A lista de permissões de endereços IP.
ipList	string	A lista de permissões de endereços IP para a rede de interconexão de Internet e serviços em nuvem. Nota Se você configurar apenas a lista de permissões de endereços IP para a rede de interconexão de Internet e serviços em nuvem, 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 a partir de VPCs será proibido.	10.88.111.3
vpcIpList	string	A lista de permissões de endereços IP para VPCs. Nota Se você configurar apenas a lista de permissões de endereços IP para VPCs, o acesso a partir de VPCs 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
saleTag	object	O ID da instância e o método de faturamento 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 método de faturamento da cota de computação padrão.	PayAsYouGo
threeTierModel	boolean	Especifica se deve suportar armazenamento baseado em esquemas. O MaxCompute suporta esquemas, que estão localizados sob os projetos e são usados para classificar objetos como tabelas, recursos e UDFs. Um projeto pode conter vários esquemas. Para obter mais informações, consulte Operações relacionadas a esquemas. Valores válidos: false : Não suportado. true : Suportado.	true
marker	string	O marcador usado para especificar o ponto inicial dos resultados retornados. Os resultados são classificados em ordem alfabética e retornados a partir do primeiro item após o marcador.	cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==
maxItem	integer	O número máximo de resultados a serem retornados por página.	10
NextToken	string	O token de paginação. A operação atual suporta apenas paginação sequencial. Um valor nextToken não vazio indica que há mais dados disponíveis. Você pode usar o valor nextToken como um parâmetro para consultar a próxima página.	AAAAAV3MpHK1AP0pfERHZN5pu6kvikyUl3ChyRxN+qLPvtOb

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "0b16399216671970335563173e2340",
  "data": {
    "projects": [
      {
        "name": "odps_project",
        "owner": "ALIYUN$odps****@aliyunid.com\n",
        "type": "managed",
        "comment": "BI_Analysis",
        "defaultQuota": "os_PayAsYouGoQuota\n",
        "status": "AVAILABLE",
        "costStorage": "16489027",
        "regionId": "cn-beijing",
        "createdTime": 1704380838000,
        "properties": {
          "timezone": "Asia/Shanghai\n",
          "retentionDays": 1,
          "allowFullScan": false,
          "typeSystem": "2",
          "enableDecimal2": true,
          "sqlMeteringMax": "1500",
          "tableLifecycle": {
            "type": "optional",
            "value": "37231\n"
          },
          "encryption": {
            "enable": true,
            "algorithm": "AES256",
            "key": "dafault"
          },
          "tunnelQuota": "Default",
          "enableTunnelQuotaRoute": true,
          "externalProjectProperties": {
            "isExternalCatalogBound": "true"
          }
        },
        "securityProperties": {
          "usingAcl": true,
          "usingPolicy": true,
          "objectCreatorHasAccessPermission": true,
          "objectCreatorHasGrantPermission": true,
          "labelSecurity": false,
          "enableDownloadPrivilege": false,
          "projectProtection": {
            "protected": true,
            "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}"
          }
        },
        "ipWhiteList": {
          "ipList": "10.88.111.3",
          "vpcIpList": "10.88.111.3"
        },
        "saleTag": {
          "resourceId": "b7afb7d1-****-****-****-c393669c307b\n",
          "resourceType": "PayAsYouGo\n"
        },
        "threeTierModel": true
      }
    ],
    "marker": "cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==",
    "maxItem": 10,
    "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6kvikyUl3ChyRxN+qLPvtOb"
  }
}

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.