Referência de API do OSS | Operações listadas por função - Object Storage Service: Central de Documentação do Alibaba Cloud

Lista todas as operações de API do OSS organizadas por tipo de recurso. Para cargas de trabalho de produção, use os SDKs do OSS, que gerenciam assinatura, tentativas e concorrência. Esta referência é destinada a desenvolvedores que precisam de acesso direto à API REST.

Antes de começar:

Todas as chamadas de API devem estar em conformidade com os Limites.
Entenda os métodos de faturamento antes de chamar qualquer API. Preços do OSS.

Início rápido: faça sua primeira chamada de API

Este exemplo cria um bucket usando PutBucket para demonstrar o fluxo completo de solicitação.

1. Preparativos

Reúna os seguintes itens:

Par de AccessKey: as solicitações de API do OSS exigem autenticação de assinatura baseada em HMAC (exceto acesso anônimo). Calcule a assinatura a partir do seu AccessKey ID e secret, e inclua-a no Authorization cabeçalho. Signature V4 (recomendado).
Endpoint: cada região possui um endpoint exclusivo. Envie solicitações para o endpoint da região onde seu bucket está localizado. Regiões e endpoints.

2. Construa e envie uma solicitação

PUT / HTTP/1.1
Host: oss-example.oss-cn-hangzhou.aliyuncs.com
Date: Thu, 17 Apr 2025 03:15:40 GMT
x-oss-acl: private
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e
<?xml version="1.0" encoding="UTF-8"?>
<CreateBucketConfiguration>
    <StorageClass>Standard</StorageClass>
    <DataRedundancyType>LRS</DataRedundancyType>    
</CreateBucketConfiguration>

3. Entenda a resposta

Resposta bem-sucedida: uma solicitação bem-sucedida retorna um código de status 2xx . Para operações que retornam dados, o corpo da resposta está em formato XML.

HTTP/1.1 200 OK
x-oss-request-id: 534B371674E88A4D8906****
Date: Fri, 24 Feb 2017 03:15:40 GMT
Content-Length: 0
Connection: keep-alive
Server: AliyunOSS
Location: /oss-example

Tratamento de erros: solicitações com falha retornam um código de status 4xx ou 5xx com um corpo XML contendo um Code e Message. Códigos de erro.

Lista de APIs

Operações de serviço

API	Descrição
ListBuckets (GetService)	Retorna todos os buckets pertencentes ao solicitante.
ListUserDataRedundancyTransition	Lista todas as tarefas de transição de redundância de dados do solicitante.

Operações de região

API	Descrição
DescribeRegions	Consulta os endpoints de todas as regiões compatíveis ou de uma região especificada.

Operações de bucket

Classificação	API	Descrição
Operações básicas	PutBucket	Cria um bucket.
	DeleteBucket	Exclui um bucket.
	ListObjects (GetBucket)	Lista informações sobre todos os objetos em um bucket.
	ListObjectsV2 (GetBucketV2)	Lista informações sobre todos os objetos em um bucket.
	GetBucketInfo	Consulta informações do bucket.
	GetBucketLocation	Consulta a localização de um bucket.
	GetBucketStat	Consulta o uso de armazenamento e o número de objetos em um bucket.
Política de retenção	InitiateBucketWorm	Cria uma política de retenção.
	AbortBucketWorm	Exclui uma política de retenção desbloqueada.
	CompleteBucketWorm	Bloqueia uma política de retenção.
	ExtendBucketWorm	Estende o período de retenção de objetos em um bucket cuja política de retenção está bloqueada.
	GetBucketWorm	Consulta a política de retenção de um bucket.
Controle de acesso	PutBucketAcl	Define as permissões de acesso de um bucket.
Controle de acesso	GetBucketAcl	Consulta as permissões de acesso de um bucket.
Ciclo de vida	PutBucketLifecycle	Define regras de ciclo de vida para objetos em um bucket.
	GetBucketLifecycle	Consulta as regras de ciclo de vida para objetos em um bucket.
	DeleteBucketLifecycle	Exclui as regras de ciclo de vida para objetos em um bucket.
Aceleração de transferência	PutBucketTransferAcceleration	Configura a aceleração de transferência para um bucket.
Aceleração de transferência	GetBucketTransferAcceleration	Consulta a configuração de aceleração de transferência de um bucket.
Versionamento	PutBucketVersioning	Define o estado de versionamento de um bucket.
	GetBucketVersioning	Consulta o estado de versionamento de um bucket.
	ListObjectVersions (GetBucketVersions)	Lista as versões de todos os objetos em um bucket.
Replicação entre regiões	PutBucketReplication	Define regras de replicação de dados para um bucket.
	PutBucketRTC	Ativa ou desativa o controle de tempo de replicação (RTC) para regras existentes de replicação entre regiões.
	GetBucketReplication	Consulta as regras de replicação de dados definidas para um bucket.
	GetBucketReplicationLocation	Consulta as regiões de destino para as quais os dados podem ser replicados.
	GetBucketReplicationProgress	Consulta o progresso da replicação de dados de um bucket.
	DeleteBucketReplication	Interrompe tarefas de replicação de dados e exclui a configuração de replicação de um bucket.
Política de autorização	PutBucketPolicy	Define uma política de bucket.
	GetBucketPolicy	Consulta uma política de bucket.
	GetBucketPolicyStatus	Verifica se a política atual do bucket permite acesso público.
	DeleteBucketPolicy	Exclui uma política de bucket.
Inventário	PutBucketInventory	Define uma regra de inventário para um bucket.
	GetBucketInventory	Consulta uma tarefa de inventário especificada em um bucket.
	ListBucketInventory	Consulta todas as tarefas de inventário em um bucket.
	DeleteBucketInventory	Exclui uma tarefa de inventário especificada de um bucket.
Gerenciamento de log	PutBucketLogging	Ativa o recurso de registro de log de acesso para um bucket.
	GetBucketLogging	Consulta a configuração de log de acesso de um bucket.
	DeleteBucketLogging	Desativa o recurso de registro de log de acesso para um bucket.
	PutUserDefinedLogFieldsConfig	Configura o campo `user_defined_log_fields` nos logs em tempo real de um bucket.
	GetUserDefinedLogFieldsConfig	Consulta a configuração do campo `user_defined_log_fields` nos logs em tempo real de um bucket.
	DeleteUserDefinedLogFieldsConfig	Exclui a configuração do campo `user_defined_log_fields` nos logs em tempo real de um bucket.
Site estático	PutBucketWebsite	Define um bucket para o modo de hospedagem de site estático.
	GetBucketWebsite	Consulta o status de hospedagem de site estático de um bucket.
	DeleteBucketWebsite	Desativa o modo de hospedagem de site estático para um bucket.
Proteção contra hotlink	PutBucketReferer	Define uma regra de proteção contra hotlink para um bucket.
Proteção contra hotlink	GetBucketReferer	Consulta a regra de proteção contra hotlink de um bucket.
Tags	PutBucketTags	Adiciona ou modifica tags de bucket.
	GetBucketTags	Consulta tags de bucket.
	DeleteBucketTags	Exclui tags de bucket.
Criptografia	PutBucketEncryption	Configura regras de criptografia para um bucket.
	GetBucketEncryption	Consulta as regras de criptografia de um bucket.
	DeleteBucketEncryption	Exclui as regras de criptografia de um bucket.
Pagamento pelo solicitante	PutBucketRequestPayment	Define um bucket para o modo de pagamento pelo solicitante.
Pagamento pelo solicitante	GetBucketRequestPayment	Consulta a configuração de pagamento pelo solicitante de um bucket.
Compartilhamento de recursos entre origens	PutBucketCors	Define regras de compartilhamento de recursos entre origens (CORS) para um bucket especificado.
	GetBucketCors	Consulta as regras CORS atuais de um bucket especificado.
	DeleteBucketCors	Desativa o recurso CORS e limpa todas as regras CORS de um bucket especificado.
	Options	Envia uma solicitação de preflight (OPTIONS) que contém a origem, o método HTTP e os cabeçalhos para o OSS, a fim de determinar se o navegador tem permissão para enviar a solicitação real entre origens.
Rastreamento de acesso	PutBucketAccessMonitor	Configura o estado de rastreamento de acesso de um bucket.
Rastreamento de acesso	GetBucketAccessMonitor	Consulta o estado de rastreamento de acesso de um bucket.
Indexação de dados	OpenMetaQuery	Ativa o recurso de gerenciamento de metadados para um bucket.
	GetMetaQueryStatus	Consulta a biblioteca de índice de metadados de um bucket especificado.
	DoMetaQuery	Consulta objetos que correspondem a condições especificadas e retorna resultados ordenados por campos e métodos de classificação definidos.
	CloseMetaQuery	Desativa o recurso de gerenciamento de metadados para um bucket.
Proteção contra DDoS	InitUserAntiDDosInfo	Cria uma instância Anti-DDoS para o OSS.
	UpdateUserAntiDDosInfo	Altera o status de uma instância Anti-DDoS para o OSS.
	GetUserAntiDDosInfo	Consulta instâncias Anti-DDoS para o OSS que pertencem a uma conta especificada.
	InitBucketAntiDDosInfo	Inicializa a proteção para um bucket.
	UpdateBucketAntiDDosInfo	Atualiza o status de proteção de um bucket.
	ListBucketAntiDDosInfo	Consulta informações de proteção do bucket.
Grupo de recursos	PutBucketResourceGroup	Configura um grupo de recursos para um bucket.
Grupo de recursos	GetBucketResourceGroup	Consulta o ID do grupo de recursos ao qual um bucket pertence.
Nome de domínio personalizado	CreateCnameToken	Cria um token CNAME necessário para verificar a propriedade de um nome de domínio.
	GetCnameToken	Consulta um token CNAME criado.
	PutCname	Vincula um registro CNAME a um bucket.
	ListCname	Lista todos os registros CNAME vinculados a um bucket.
	DeleteCname	Exclui um registro CNAME vinculado.
Estilo de imagem	PutStyle	Adiciona um estilo de imagem.
	GetStyle	Consulta informações sobre um estilo de imagem especificado em um bucket.
	ListStyle	Consulta todos os estilos de imagem criados em um bucket.
	DeleteStyle	Exclui um estilo de imagem especificado de um bucket.
Segurança da camada de transporte	PutBucketHttpsConfig	Ativa ou desativa configurações de versão TLS para um bucket.
Segurança da camada de transporte	GetBucketHttpsConfig	Consulta as configurações de versão TLS de um bucket.
Transição de redundância	CreateBucketDataRedundancyTransition	Cria uma tarefa de transição de redundância de dados.
	GetBucketDataRedundancyTransition	Consulta uma tarefa de transição de redundância de dados.
	DeleteBucketDataRedundancyTransition	Exclui uma tarefa de transição de redundância de dados.
	ListUserDataRedundancyTransition	Lista todas as tarefas de transição de redundância de dados do solicitante.
	ListBucketDataRedundancyTransition	Lista todas as tarefas de transição de redundância de dados em um bucket.
Ponto de acesso	CreateAccessPoint	Cria um ponto de acesso.
	GetAccessPoint	Consulta as informações sobre um ponto de acesso.
	DeleteAccessPoint	Exclui um ponto de acesso.
	ListAccessPoints	Consulta as informações sobre pontos de acesso em nível de usuário ou de bucket.
	PutAccessPointPolicy	Configura uma política de ponto de acesso.
	GetAccessPointPolicy	Consulta a configuração de uma política de ponto de acesso.
	DeleteAccessPointPolicy	Exclui uma política de ponto de acesso.
Ponto de acesso Object FC	CreateAccessPointForObjectProcess	Cria um ponto de acesso Object FC.
	GetAccessPointForObjectProcess	Consulta informações básicas sobre um ponto de acesso Object FC.
	DeleteAccessPointForObjectProcess	Exclui um ponto de acesso Object FC.
	ListAccessPointsForObjectProcess	Consulta informações sobre pontos de acesso Object FC em nível de usuário.
	PutAccessPointConfigForObjectProcess	Modifica a configuração de um ponto de acesso Object FC.
	GetAccessPointConfigForObjectProcess	Consulta a configuração de um ponto de acesso Object FC.
	PutAccessPointPolicyForObjectProcess	Configura uma política de acesso para um ponto de acesso Object FC.
	GetAccessPointPolicyForObjectProcess	Consulta a configuração de política de acesso de um ponto de acesso Object FC.
	DeleteAccessPointPolicyForObjectProcess	Exclui a política de acesso de um ponto de acesso Object FC.
	WriteGetObjectResponse	Personaliza dados retornados e cabeçalhos de resposta.
Bloqueio de acesso público	PutPublicAccessBlock	Ativa globalmente o Bloqueio de Acesso Público para o OSS.
	GetPublicAccessBlock	Consulta a configuração global de Bloqueio de Acesso Público para o OSS.
	DeletePublicAccessBlock	Exclui a configuração global de Bloqueio de Acesso Público para o OSS.
	PutBucketPublicAccessBlock	Ativa o Bloqueio de Acesso Público para um bucket.
	GetBucketPublicAccessBlock	Consulta a configuração de Bloqueio de Acesso Público de um bucket especificado.
	DeleteBucketPublicAccessBlock	Exclui a configuração de Bloqueio de Acesso Público de um bucket especificado.
	PutAccessPointPublicAccessBlock	Ativa o Bloqueio de Acesso Público para um ponto de acesso.
	GetAccessPointPublicAccessBlock	Consulta a configuração de Bloqueio de Acesso Público de um ponto de acesso especificado.
	DeleteAccessPointPublicAccessBlock	Exclui a configuração de Bloqueio de Acesso Público de um ponto de acesso especificado.
Acesso em tempo real a objetos Archive	PutBucketArchiveDirectRead	Ativa ou desativa o acesso em tempo real a objetos Archive.
Acesso em tempo real a objetos Archive	GetBucketArchiveDirectRead	Consulta se o acesso em tempo real a objetos Archive está ativado.
Acelerador OSS	PutBucketDataAccelerator	Cria um acelerador OSS ou modifica sua configuração.
	GetBucketDataAccelerator	Consulta as informações sobre um acelerador OSS.
	DeleteBucketDataAccelerator	Exclui um acelerador OSS.

Operações de objeto

Classificação	API	Descrição
Operações básicas	PutObject	Faz upload de um objeto.
	GetObject	Consulta um objeto.
	CopyObject	Copia um objeto.
	AppendObject	Faz upload de um objeto usando upload por append.
	SealAppendObject	Impede que dados sejam adicionados a um objeto Appendable.
	DeleteObject	Exclui um único objeto.
	DeleteMultipleObjects	Exclui múltiplos objetos.
	HeadObject	Retorna apenas metadados do objeto sem o conteúdo do objeto.
	GetObjectMeta	Retorna metadados básicos do objeto (ETag, tamanho, hora da última modificação) sem o conteúdo do objeto.
	PostObject	Faz upload de um objeto usando um formulário HTML.
	Callback	Você pode implementar um callback incluindo os parâmetros de callback em uma solicitação enviada ao OSS.
	RestoreObject	Restaura um objeto Archive Storage, Cold Archive ou Deep Cold Archive.
	CleanRestoredObject	Encerra antecipadamente o estado restaurado de um objeto.
	SelectObject	Executa uma instrução SQL em um arquivo de objeto e retorna o resultado da execução.
	CreateSelectObjectMeta	Consulta a contagem de linhas, contagem de colunas (CSV) e contagem de divisões de um arquivo de objeto.
Gerenciamento de pasta	CreateDirectory	Cria uma pasta.
	Rename	Renomeia uma pasta ou um objeto.
	DeleteDirectory	Exclui uma pasta.
Upload multipart	InitiateMultipartUpload	Inicia um evento de upload multipart.
	UploadPart	Faz upload de uma parte por nome de objeto e ID de upload.
	UploadPartCopy	Copia dados de um objeto existente para fazer upload de uma parte adicionando o cabeçalho de solicitação x-oss-copy-source a uma solicitação UploadPart.
	CompleteMultipartUpload	Conclui um upload multipart montando todas as partes enviadas.
	AbortMultipartUpload	Cancela um evento de upload multipart e exclui as partes enviadas.
	ListMultipartUploads	Lista todos os uploads multipart em andamento (iniciados, mas não concluídos ou cancelados).
	ListParts	Lista todas as partes enviadas com sucesso que pertencem a um ID de upload especificado.
Controle de acesso	PutObjectACL	Modifica as permissões de acesso de um objeto.
Controle de acesso	GetObjectACL	Consulta as permissões de acesso de um objeto.
Link simbólico	PutSymlink	Cria um link simbólico.
Link simbólico	GetSymlink	Consulta um link simbólico.
Marcação com tags	PutObjectTagging	Define ou atualiza tags de objeto.
	GetObjectTagging	Consulta tags de objeto.
	DeleteObjectTagging	Exclui tags de objeto especificadas.

Operações de bucket vetorial

Classificação	API	Descrição
Bucket vetorial	PutVectorBucket	Cria um bucket vetorial.
	GetVectorBucket	Consulta os detalhes de um bucket vetorial.
	ListVectorBuckets	Lista todos os buckets vetoriais que pertencem à conta atual.
	DeleteVectorBucket	Exclui um bucket vetorial.
Índice	PutVectorIndex	Cria um índice vetorial em um bucket vetorial.
	GetVectorIndex	Consulta os detalhes de um índice vetorial.
	ListVectorIndexes	Lista todos os índices vetoriais em um bucket vetorial.
	DeleteVectorIndex	Após fazer upload de todas as partes dos dados, você deve chamar a API CompleteMultipartUpload para concluir o upload multipart.
Vetores	PutVectors	Grava dados vetoriais em um índice.
	GetVectors	Consulta dados vetoriais especificados.
	ListVectors	Lista todos os dados vetoriais em um índice vetorial.
	DeleteVectors	Exclui dados vetoriais especificados de um índice vetorial.
	QueryVectors	Executa uma pesquisa de similaridade vetorial.

Operações de QoS de grupo de recursos

API	Descrição
PutBucketQoSInfo	Define limitação para um bucket em um pool de recursos.
GetBucketQoSInfo	Consulta a configuração de limitação de um bucket em um pool de recursos.
DeleteBucketQosInfo	Exclui a configuração de limitação de um bucket especificado em um pool de recursos.
PutBucketRequesterQoSInfo	Define limitação em nível de bucket para um solicitante.
GetBucketRequesterQoSInfo	Consulta a configuração de limitação em nível de bucket para um solicitante especificado.
ListBucketRequesterQoSInfos	Consulta as configurações de limitação em nível de bucket para todos os solicitantes.
DeleteBucketRequesterQoSInfo	Exclui a configuração de limitação de um solicitante para um bucket.
ListResourcePools	Consulta informações sobre todos os pools de recursos que pertencem à conta atual.
GetResourcePoolInfo	Consulta a configuração de limitação de um pool de recursos especificado.
ListResourcePoolBuckets	Consulta a lista de buckets incluídos em um pool de recursos especificado.
PutResourcePoolRequesterQoSInfo	Configura limitação para um solicitante de um pool de recursos.
GetResourcePoolRequesterQoSInfo	Consulta a configuração de limitação de um solicitante especificado para um pool de recursos.
ListResourcePoolRequesterQoSInfos	Consulta as configurações de limitação de todos os solicitantes para um pool de recursos.
DeleteResourcePoolRequesterQoSInfo	Exclui a configuração de limitação de um solicitante especificado para um pool de recursos.
PutBucketResourcePoolBucketGroup	Adiciona um bucket de um pool de recursos a um grupo de bucket.
ListResourcePoolBucketGroups	Lista os grupos de bucket em um pool de recursos especificado.
PutResourcePoolBucketGroupQoSInfo	Configura ou modifica as configurações de limitação para um grupo de bucket em um pool de recursos.
GetResourcePoolBucketGroupQoSInfo	Consulta a configuração de limitação de um grupo de bucket em um pool de recursos.
ListResourcePoolBucketGroupQoSInfos	Lista as configurações de limitação de grupos de bucket em um pool de recursos.
DeleteResourcePoolBucketGroupQoSInfo	Exclui a configuração de limitação de um grupo de bucket em um pool de recursos.

Operações de LiveChannel

API	Descrição
PutLiveChannelStatus	Altera o status de um LiveChannel.
PutLiveChannel	Cria um LiveChannel.
GetVodPlaylist	Consulta uma playlist.
PostVodPlaylist	Gera uma playlist.
GetLiveChannelStat	Consulta o status de ingestão de stream de um LiveChannel.
GetLiveChannelInfo	Consulta a configuração de um LiveChannel.
GetLiveChannelHistory	Consulta os registros de ingestão de stream de um LiveChannel.
ListLiveChannel	Lista LiveChannels.
DeleteLiveChannel	Exclui um LiveChannel.

Object Storage Service:Visão geral da API