ListObjects - ENS: Central de Documentação do Alibaba Cloud

Consulta as informações sobre todos os objetos em um bucket.

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

ens:ListObjects

list

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
BucketName	string	Sim	O nome do bucket.	test
EncodingType	string	Não	O tipo de codificação dos nomes dos objetos na resposta. Apenas a codificação de URL é suportada.	url
Marker	string	Não	A posição a partir da qual a operação de listagem começa. Se este parâmetro for especificado, os objetos cujos nomes são alfabeticamente maiores que o valor de Marker serão retornados. O parâmetro Marker é usado para listar os objetos retornados por página, e seu valor deve ser menor que 1.024 bytes de comprimento. Mesmo que o valor especificado para Marker não exista na lista durante uma consulta condicional, a listagem começa a partir do objeto cujo nome é alfabeticamente maior que o valor de Marker.	a
MaxKeys	integer	Não	O número máximo de objetos a serem retornados. Valores válidos: 0 a 1000. Valor padrão: 100.	100
Prefix	string	Não	O prefixo que deve ser incluído nos nomes dos objetos que você deseja listar. Se você especificar um prefixo para consultar objetos, os nomes dos objetos retornados conterão o prefixo. O valor do parâmetro deve ter menos de 1.000 bytes de comprimento.	b
ContinuationToken	string	Não	O token usado nesta operação de listagem. Se o número de objetos exceder o valor de MaxKeys, o NextContinuationToken será incluído na resposta como o token para a próxima operação de listagem.	test1.txt
StartAfter	string	Não	A posição a partir da qual a operação de listagem começa. Se este parâmetro for especificado, os objetos cujos nomes são alfabeticamente maiores que o valor de StartAfter serão retornados. O parâmetro StartAfter é usado para listar os objetos retornados por página, e seu valor deve ter menos de 1.000 bytes de comprimento. Mesmo que o valor especificado para StartAfter não exista na lista durante uma consulta condicional, a listagem começa a partir do objeto cujo nome é alfabeticamente maior que o valor de StartAfter.	b

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
CommonPrefixes	array	Se o parâmetro delimiter for especificado na solicitação, a resposta conterá CommonPrefixes. Os objetos cujos nomes contêm a mesma string do prefixo até a próxima ocorrência do delimitador são agrupados como um único elemento de resultado em CommonPrefixes.	Not applicable
	string	Se o parâmetro delimiter for especificado na solicitação, a resposta conterá CommonPrefixes. Os objetos cujos nomes contêm a mesma string do prefixo até a próxima ocorrência do delimitador são agrupados como um único elemento de resultado em CommonPrefixes.	不涉及
NextContinuationToken	string	O token usado na próxima operação de listagem.	CgJiYw--
ContinuationToken	string	O token usado nesta operação de listagem.	test1.txt
Delimiter	string	O caractere usado para agrupar objetos por nome.	/
EncodingType	string	O tipo de codificação dos nomes dos objetos na resposta.	Not applicable
Prefix	string	O prefixo contido nos nomes dos objetos retornados.	b
Marker	string	A posição a partir da qual a operação de listagem começa.	ceshi.txt1617853707991
BucketName	string	O nome do bucket.	test
Contents	array<object>	A lista de metadados dos objetos.
	object
Key	string	O nome do objeto.	ceshi.txt1617853706546
LastModified	string	A hora em que o objeto foi modificado pela última vez.	2021-04-08T03:48:47.488Z
ETag	string	A tag de entidade (ETag). Quando um objeto é criado, um ETag é criado para identificar o conteúdo do objeto. Para um objeto criado pela chamada da operação PutObject, o valor do ETag do objeto é o hash MD5 do conteúdo do objeto. Para um objeto não criado pela chamada da operação PutObject, o valor do ETag do objeto é o UUID do conteúdo do objeto. O ETag de um objeto pode ser usado para verificar se o conteúdo do objeto foi modificado. No entanto, recomendamos que você use o hash MD5 de um objeto em vez do valor do ETag do objeto para verificar a integridade dos dados.	5B3C1A2E053D763E1B002CC607C5****
Size	integer	O tamanho do objeto retornado. Unidade: bytes.	15
IsTruncated	boolean	Indica se os objetos listados estão truncados. Valores válidos: false true	true
KeyCount	integer	O número de chaves retornadas para esta solicitação.	10
NextMarker	string	A posição a partir da qual a próxima operação de listagem começa.	ceshi.txt1617853707991
MaxKeys	integer	O número máximo de objetos retornados.	10
RequestId	string	O ID da solicitação.	4833C4AC-9396-458C-8F25-1D701334E560

Exemplos

Resposta de sucesso

JSON formato

{
  "CommonPrefixes": [
    "不涉及"
  ],
  "NextContinuationToken": "CgJiYw--",
  "ContinuationToken": "test1.txt",
  "Delimiter": "/",
  "EncodingType": "Not applicable",
  "Prefix": "b",
  "Marker": "ceshi.txt1617853707991",
  "BucketName": "test",
  "Contents": [
    {
      "Key": "ceshi.txt1617853706546",
      "LastModified": "2021-04-08T03:48:47.488Z",
      "ETag": "5B3C1A2E053D763E1B002CC607C5****",
      "Size": 15
    }
  ],
  "IsTruncated": true,
  "KeyCount": 10,
  "NextMarker": "ceshi.txt1617853707991",
  "MaxKeys": 10,
  "RequestId": "4833C4AC-9396-458C-8F25-1D701334E560"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	Invalid%s	Specified parameter %s is not valid
400	InvalidBucketName	Specified parameter BucketName is not valid.	The specified BucketName parameter is invalid.
400	InvalidPrefix	Specified parameter Prefix is not valid.
400	InvalidStartAfter	Specified parameter StartAfter is not valid.
400	InvalidMarker	Specified parameter Marker is not valid.
400	InvalidDelimiter	Specified parameter Delimiter is not valid.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.
400	InvalidArgument	Specified parameter ContinuationToken is incorrect.	The ContinuationToken parameters set are incorrect.
500	InternalError	The request processing has failed due to some unknown error.
403	AccessDenied	auth is not valid
403	UserDisable	The user has been disabled due to arrears.	The user has been disabled due to arrears.
404	NoSuchBucket	The specified bucket does not exist.	The requested bucket does not exist.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.