OSS API reference | Operations listed by function - Object Storage Service

Enumera todas las operaciones de la API de OSS organizadas por tipo de recurso. Para cargas de trabajo en producción, utilice los SDK de OSS, ya que gestionan la firma, los reintentos y la concurrencia. Esta referencia está dirigida a desarrolladores que necesitan acceso directo a la API REST.

Antes de empezar:

Todas las llamadas a la API deben cumplir con Limits de OSS.
Revise billing methods de OSS antes de invocar cualquier API. OSS Pricing.

Inicio rápido: Realice su primera llamada a la API

Este ejemplo crea un bucket mediante PutBucket para demostrar el flujo completo de la solicitud.

1. Preparativos

Reúna la siguiente información:

Par de AccessKey: Las solicitudes a la API de OSS requieren autenticación mediante firma basada en HMAC (excepto en el acceso anónimo). Calcule la firma a partir de su AccessKey ID y su clave secreta, e inclúyala en el encabezado Authorization. Signature V4 (recommended).
Endpoint: Cada región cuenta con un endpoint único. Envíe las solicitudes al endpoint correspondiente a la región donde se encuentra su bucket. Regions and endpoints.

2. Construya y envíe una solicitud

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. Comprenda la respuesta

Respuesta exitosa: Una solicitud correcta devuelve un código de estado 2xx. En las operaciones que retornan datos, el cuerpo de la respuesta se presenta en 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

Manejo de errores: Las solicitudes con errores devuelven un código de estado 4xx o 5xx junto con un cuerpo XML que contiene un Code y un Message. Error codes.

Lista de API

Operaciones de servicio

API	Descripción
ListBuckets (GetService)	Devuelve todos los buckets propiedad del solicitante.
ListUserDataRedundancyTransition	Lista todas las tareas de transición de redundancia de datos del solicitante.

Operaciones de región

API	Descripción
DescribeRegions	Consulta los endpoints de todas las regiones compatibles o de una región específica.

Operaciones de bucket

Clasificación	API	Descripción
Operaciones básicas	PutBucket	Crea un bucket.
	DeleteBucket	Elimina un bucket.
	ListObjects (GetBucket)	Lista información sobre todos los objetos en un bucket.
	ListObjectsV2 (GetBucketV2)	Lista información sobre todos los objetos en un bucket.
	GetBucketInfo	Consulta la información del bucket.
	GetBucketLocation	Consulta la ubicación de un bucket.
	GetBucketStat	Consulta el uso de almacenamiento y la cantidad de objetos en un bucket.
Directiva de retención	InitiateBucketWorm	Crea una directiva de retención.
	AbortBucketWorm	Elimina una directiva de retención desbloqueada.
	CompleteBucketWorm	Bloquea una directiva de retención.
	ExtendBucketWorm	Extiende el periodo de retención de los objetos en un bucket cuya directiva de retención está bloqueada.
	GetBucketWorm	Consulta la directiva de retención de un bucket.
Control de acceso	PutBucketAcl	Establece los permisos de acceso de un bucket.
Control de acceso	GetBucketAcl	Consulta los permisos de acceso de un bucket.
Ciclo de vida	PutBucketLifecycle	Establece reglas de ciclo de vida para los objetos en un bucket.
	GetBucketLifecycle	Consulta las reglas de ciclo de vida de los objetos en un bucket.
	DeleteBucketLifecycle	Elimina las reglas de ciclo de vida de los objetos en un bucket.
Aceleración de transferencia	PutBucketTransferAcceleration	Configura la aceleración de transferencia para un bucket.
Aceleración de transferencia	GetBucketTransferAcceleration	Consulta la configuración de aceleración de transferencia de un bucket.
Versionado	PutBucketVersioning	Establece el estado de versionado de un bucket.
	GetBucketVersioning	Consulta el estado de versionado de un bucket.
	ListObjectVersions (GetBucketVersions)	Lista las versiones de todos los objetos en un bucket.
Cross-region replication	PutBucketReplication	Establece reglas de replicación de datos para un bucket.
	PutBucketRTC	Habilita o deshabilita el control de tiempo de replicación (RTC) para reglas de cross-region replication existentes.
	GetBucketReplication	Consulta las reglas de replicación de datos configuradas para un bucket.
	GetBucketReplicationLocation	Consulta las regiones de destino a las que se pueden replicar los datos.
	GetBucketReplicationProgress	Consulta el progreso de replicación de datos de un bucket.
	DeleteBucketReplication	Detiene las tareas de replicación de datos y elimina la configuración de replicación de un bucket.
Directiva de autorización	PutBucketPolicy	Establece una directiva de bucket.
	GetBucketPolicy	Consulta una directiva de bucket.
	GetBucketPolicyStatus	Comprueba si la directiva actual del bucket permite el acceso público.
	DeleteBucketPolicy	Elimina una directiva de bucket.
Inventario	PutBucketInventory	Establece una regla de inventario para un bucket.
	GetBucketInventory	Consulta una tarea de inventario específica en un bucket.
	ListBucketInventory	Consulta todas las tareas de inventario en un bucket.
	DeleteBucketInventory	Elimina una tarea de inventario específica de un bucket.
Gestión de registros	PutBucketLogging	Habilita la función de registro de logs de acceso para un bucket.
	GetBucketLogging	Consulta la configuración de registros de acceso de un bucket.
	DeleteBucketLogging	Deshabilita la función de registro de logs de acceso para un bucket.
	PutUserDefinedLogFieldsConfig	Configura el campo `user_defined_log_fields` en los registros en tiempo real de un bucket.
	GetUserDefinedLogFieldsConfig	Consulta la configuración del campo `user_defined_log_fields` en los registros en tiempo real de un bucket.
	DeleteUserDefinedLogFieldsConfig	Elimina la configuración del campo `user_defined_log_fields` en los registros en tiempo real de un bucket.
Sitio web estático	PutBucketWebsite	Configura un bucket en modo de hosting de sitio web estático.
	GetBucketWebsite	Consulta el estado de hosting de sitio web estático de un bucket.
	DeleteBucketWebsite	Deshabilita el modo de hosting de sitio web estático para un bucket.
Protección contra hotlink	PutBucketReferer	Establece una regla de protección contra hotlink para un bucket.
Protección contra hotlink	GetBucketReferer	Consulta la regla de protección contra hotlink de un bucket.
Etiquetas	PutBucketTags	Agrega o modifica etiquetas de bucket.
	GetBucketTags	Consulta las etiquetas de un bucket.
	DeleteBucketTags	Elimina las etiquetas de un bucket.
Cifrado	PutBucketEncryption	Configura reglas de cifrado para un bucket.
	GetBucketEncryption	Consulta las reglas de cifrado de un bucket.
	DeleteBucketEncryption	Elimina las reglas de cifrado de un bucket.
Pago por solicitante	PutBucketRequestPayment	Configura un bucket en modo de pago por solicitante.
Pago por solicitante	GetBucketRequestPayment	Consulta la configuración de pago por solicitante de un bucket.
Uso compartido de recursos de origen cruzado	PutBucketCors	Establece reglas de uso compartido de recursos de origen cruzado (CORS) para un bucket específico.
	GetBucketCors	Consulta las reglas CORS actuales de un bucket específico.
	DeleteBucketCors	Deshabilita la función CORS y borra todas las reglas CORS de un bucket específico.
	Options	Envía una solicitud de verificación previa (OPTIONS) con el origen, el método HTTP y los encabezados a OSS para determinar si el navegador tiene permiso para enviar la solicitud de origen cruzado real.
Seguimiento de acceso	PutBucketAccessMonitor	Configura el estado de seguimiento de acceso de un bucket.
Seguimiento de acceso	GetBucketAccessMonitor	Consulta el estado de seguimiento de acceso de un bucket.
Indexación de datos	OpenMetaQuery	Habilita la función de gestión de metadatos para un bucket.
	GetMetaQueryStatus	Consulta la biblioteca de índices de metadatos de un bucket específico.
	DoMetaQuery	Consulta objetos que cumplen condiciones específicas y devuelve resultados ordenados según los campos y métodos de clasificación indicados.
	CloseMetaQuery	Deshabilita la función de gestión de metadatos para un bucket.
Protección DDoS	InitUserAntiDDosInfo	Crea una instancia de Anti-DDoS for OSS.
	UpdateUserAntiDDosInfo	Cambia el estado de una instancia de Anti-DDoS for OSS.
	GetUserAntiDDosInfo	Consulta las instancias de Anti-DDoS for OSS que pertenecen a una cuenta específica.
	InitBucketAntiDDosInfo	Inicializa la protección para un bucket.
	UpdateBucketAntiDDosInfo	Actualiza el estado de protección de un bucket.
	ListBucketAntiDDosInfo	Consulta la información de protección del bucket.
Resource group	PutBucketResourceGroup	Configura un resource group para un bucket.
Resource group	GetBucketResourceGroup	Consulta el ID del resource group al que pertenece un bucket.
Nombre de dominio personalizado	CreateCnameToken	Crea un token CNAME necesario para verificar la propiedad de un nombre de dominio.
	GetCnameToken	Consulta un token CNAME creado.
	PutCname	Vincula un registro CNAME a un bucket.
	ListCname	Lista todos los registros CNAME vinculados a un bucket.
	DeleteCname	Elimina un registro CNAME vinculado.
Estilo de imagen	PutStyle	Agrega un estilo de imagen.
	GetStyle	Consulta información sobre un estilo de imagen específico en un bucket.
	ListStyle	Consulta todos los estilos de imagen creados en un bucket.
	DeleteStyle	Elimina un estilo de imagen específico de un bucket.
Seguridad de capa de transporte	PutBucketHttpsConfig	Habilita o deshabilita la configuración de versión TLS para un bucket.
Seguridad de capa de transporte	GetBucketHttpsConfig	Consulta la configuración de versión TLS de un bucket.
Transición de redundancia	CreateBucketDataRedundancyTransition	Crea una tarea de transición de redundancia de datos.
	GetBucketDataRedundancyTransition	Consulta una tarea de transición de redundancia de datos.
	DeleteBucketDataRedundancyTransition	Elimina una tarea de transición de redundancia de datos.
	ListUserDataRedundancyTransition	Lista todas las tareas de transición de redundancia de datos del solicitante.
	ListBucketDataRedundancyTransition	Lista todas las tareas de transición de redundancia de datos en un bucket.
Punto de acceso	CreateAccessPoint	Crea un punto de acceso.
	GetAccessPoint	Consulta la información sobre un punto de acceso.
	DeleteAccessPoint	Elimina un punto de acceso.
	ListAccessPoints	Consulta la información sobre puntos de acceso a nivel de usuario o de bucket.
	PutAccessPointPolicy	Configura una directiva de punto de acceso.
	GetAccessPointPolicy	Consulta la configuración de la directiva de un punto de acceso.
	DeleteAccessPointPolicy	Elimina la directiva de un punto de acceso.
Punto de acceso Object FC	CreateAccessPointForObjectProcess	Crea un punto de acceso Object FC.
	GetAccessPointForObjectProcess	Consulta información básica sobre un punto de acceso Object FC.
	DeleteAccessPointForObjectProcess	Elimina un punto de acceso Object FC.
	ListAccessPointsForObjectProcess	Consulta información sobre puntos de acceso Object FC a nivel de usuario.
	PutAccessPointConfigForObjectProcess	Modifica la configuración de un punto de acceso Object FC.
	GetAccessPointConfigForObjectProcess	Consulta la configuración de un punto de acceso Object FC.
	PutAccessPointPolicyForObjectProcess	Configura una directiva de acceso para un punto de acceso Object FC.
	GetAccessPointPolicyForObjectProcess	Consulta la configuración de la directiva de acceso de un punto de acceso Object FC.
	DeleteAccessPointPolicyForObjectProcess	Elimina la directiva de acceso de un punto de acceso Object FC.
	WriteGetObjectResponse	Personaliza los datos devueltos y los encabezados de respuesta.
Block Public Access	PutPublicAccessBlock	Habilita globalmente Block Public Access para OSS.
	GetPublicAccessBlock	Consulta la configuración global de Block Public Access para OSS.
	DeletePublicAccessBlock	Elimina la configuración global de Block Public Access para OSS.
	PutBucketPublicAccessBlock	Habilita Block Public Access para un bucket.
	GetBucketPublicAccessBlock	Consulta la configuración de Block Public Access de un bucket específico.
	DeleteBucketPublicAccessBlock	Elimina la configuración de Block Public Access de un bucket específico.
	PutAccessPointPublicAccessBlock	Habilita Block Public Access para un punto de acceso.
	GetAccessPointPublicAccessBlock	Consulta la configuración de Block Public Access de un punto de acceso específico.
	DeleteAccessPointPublicAccessBlock	Elimina la configuración de Block Public Access de un punto de acceso específico.
Acceso en tiempo real a objetos Archive	PutBucketArchiveDirectRead	Habilita o deshabilita el acceso en tiempo real a objetos Archive.
Acceso en tiempo real a objetos Archive	GetBucketArchiveDirectRead	Consulta si el acceso en tiempo real a objetos Archive está habilitado.
Acelerador OSS	PutBucketDataAccelerator	Crea un acelerador OSS o modifica su configuración.
	GetBucketDataAccelerator	Consulta la información sobre un acelerador OSS.
	DeleteBucketDataAccelerator	Elimina un acelerador OSS.

Operaciones de objeto

Clasificación	API	Descripción
Operaciones básicas	PutObject	Carga un objeto.
	GetObject	Consulta un objeto.
	CopyObject	Copia un objeto.
	AppendObject	Carga un objeto mediante carga por anexión.
	SealAppendObject	Impide que se anexe datos a un objeto Appendable.
	DeleteObject	Elimina un solo objeto.
	DeleteMultipleObjects	Elimina varios objetos.
	HeadObject	Devuelve solo los metadatos del objeto sin su contenido.
	GetObjectMeta	Devuelve metadatos básicos del objeto (ETag, tamaño, última modificación) sin su contenido.
	PostObject	Carga un objeto mediante un formulario HTML.
	Callback	Permite implementar una devolución de llamada al incluir los parámetros correspondientes en una solicitud enviada a OSS.
	RestoreObject	Restaura un objeto de Archive Storage, Cold Archive o Deep Cold Archive.
	CleanRestoredObject	Finaliza anticipadamente el estado restaurado de un objeto.
	SelectObject	Ejecuta una instrucción SQL en un archivo de objeto y devuelve el resultado.
	CreateSelectObjectMeta	Consulta el número de filas, columnas (CSV) y divisiones de un archivo de objeto.
Gestión de carpetas	CreateDirectory	Crea una carpeta.
	Rename	Renombra una carpeta o un objeto.
	DeleteDirectory	Elimina una carpeta.
Carga multiparte	InitiateMultipartUpload	Inicia un evento de carga multiparte.
	UploadPart	Carga una parte por nombre de objeto e ID de carga.
	UploadPartCopy	Copia datos de un objeto existente para cargar una parte al agregar el encabezado de solicitud x-oss-copy-source a una petición UploadPart.
	CompleteMultipartUpload	Completa una carga multiparte al ensamblar todas las partes cargadas.
	AbortMultipartUpload	Cancela un evento de carga multiparte y elimina las partes cargadas.
	ListMultipartUploads	Lista todas las cargas multiparte en curso (iniciadas pero no completadas ni canceladas).
	ListParts	Lista todas las partes cargadas correctamente que pertenecen a un ID de carga específico.
Control de acceso	PutObjectACL	Modifica los permisos de acceso de un objeto.
Control de acceso	GetObjectACL	Consulta los permisos de acceso de un objeto.
Enlace simbólico	PutSymlink	Crea un enlace simbólico.
Enlace simbólico	GetSymlink	Consulta un enlace simbólico.
Etiquetado	PutObjectTagging	Establece o actualiza las etiquetas de un objeto.
	GetObjectTagging	Consulta las etiquetas de un objeto.
	DeleteObjectTagging	Elimina etiquetas específicas de un objeto.

Operaciones de bucket vectorial

Clasificación	API	Descripción
Bucket vectorial	PutVectorBucket	Crea un bucket vectorial.
	GetVectorBucket	Consulta los detalles de un bucket vectorial.
	ListVectorBuckets	Lista todos los buckets vectoriales que pertenecen a la cuenta actual.
	DeleteVectorBucket	Elimina un bucket vectorial.
Índice	PutVectorIndex	Crea un índice vectorial en un bucket vectorial.
	GetVectorIndex	Consulta los detalles de un índice vectorial.
	ListVectorIndexes	Lista todos los índices vectoriales en un bucket vectorial.
	DeleteVectorIndex	Después de cargar todas las partes de datos, debe llamar a la API CompleteMultipartUpload para completar la carga multiparte.
Vectores	PutVectors	Escribe datos vectoriales en un índice.
	GetVectors	Consulta datos vectoriales específicos.
	ListVectors	Lista todos los datos vectoriales en un índice vectorial.
	DeleteVectors	Elimina datos vectoriales específicos de un índice vectorial.
	QueryVectors	Realiza una búsqueda de similitud vectorial.

Operaciones QoS de resource group

API	Descripción
PutBucketQoSInfo	Establece límites de velocidad para un bucket en un pool de recursos.
GetBucketQoSInfo	Consulta la configuración de límites de velocidad de un bucket en un pool de recursos.
DeleteBucketQosInfo	Elimina la configuración de límites de velocidad de un bucket específico en un pool de recursos.
PutBucketRequesterQoSInfo	Establece límites de velocidad a nivel de bucket para un solicitante.
GetBucketRequesterQoSInfo	Consulta la configuración de límites de velocidad a nivel de bucket para un solicitante específico.
ListBucketRequesterQoSInfos	Consulta las configuraciones de límites de velocidad a nivel de bucket para todos los solicitantes.
DeleteBucketRequesterQoSInfo	Elimina la configuración de límites de velocidad de un solicitante para un bucket.
ListResourcePools	Consulta información sobre todos los pools de recursos que pertenecen a la cuenta actual.
GetResourcePoolInfo	Consulta la configuración de límites de velocidad de un pool de recursos específico.
ListResourcePoolBuckets	Consulta la lista de buckets incluidos en un pool de recursos específico.
PutResourcePoolRequesterQoSInfo	Configura límites de velocidad para un solicitante de un pool de recursos.
GetResourcePoolRequesterQoSInfo	Consulta la configuración de límites de velocidad de un solicitante específico para un pool de recursos.
ListResourcePoolRequesterQoSInfos	Consulta las configuraciones de límites de velocidad de todos los solicitantes para un pool de recursos.
DeleteResourcePoolRequesterQoSInfo	Elimina la configuración de límites de velocidad de un solicitante específico para un pool de recursos.
PutBucketResourcePoolBucketGroup	Agrega un bucket de un pool de recursos a un grupo de buckets.
ListResourcePoolBucketGroups	Lista los grupos de buckets en un pool de recursos específico.
PutResourcePoolBucketGroupQoSInfo	Configura o modifica los ajustes de límites de velocidad para un grupo de buckets en un pool de recursos.
GetResourcePoolBucketGroupQoSInfo	Consulta la configuración de límites de velocidad de un grupo de buckets en un pool de recursos.
ListResourcePoolBucketGroupQoSInfos	Lista las configuraciones de límites de velocidad de los grupos de buckets en un pool de recursos.
DeleteResourcePoolBucketGroupQoSInfo	Elimina la configuración de límites de velocidad de un grupo de buckets en un pool de recursos.

Operaciones de LiveChannel

API	Descripción
PutLiveChannelStatus	Cambia el estado de un LiveChannel.
PutLiveChannel	Crea un LiveChannel.
GetVodPlaylist	Consulta una lista de reproducción.
PostVodPlaylist	Genera una lista de reproducción.
GetLiveChannelStat	Consulta el estado de ingesta de flujo de un LiveChannel.
GetLiveChannelInfo	Consulta la configuración de un LiveChannel.
GetLiveChannelHistory	Consulta los registros de ingesta de flujo de un LiveChannel.
ListLiveChannel	Lista los LiveChannels.
DeleteLiveChannel	Elimina un LiveChannel.

Object Storage Service:Descripción general de la API