Cette rubrique répertorie toutes les opérations de l'API OSS, organisées par type de ressource. Pour les charges de travail en production, privilégiez les SDK OSS qui gèrent automatiquement la signature, les nouvelles tentatives et la concurrence. Cette référence s'adresse aux développeurs nécessitant un accès direct à l'API REST.
Avant de commencer :
Tous les appels d'API doivent respecter les Limites d'OSS.
Familiarisez-vous avec les méthodes de facturation d'OSS avant d'effectuer tout appel d'API. Tarification OSS.
Prise en main : Effectuez votre premier appel d'API
Cet exemple illustre le flux complet d'une requête en créant un bucket à l'aide de PutBucket.
1. Préparatifs
Rassemblez les éléments suivants :
Paire d'AccessKey : Les requêtes API OSS nécessitent une authentification par signature HMAC (sauf pour les accès anonymes). Calculez la signature à partir de votre AccessKey ID et de votre clé secrète, puis incluez-la dans l'en-tête
Authorization. Signature V4 (recommandé).Endpoint : Chaque région dispose d'un endpoint unique. Adressez vos requêtes à l'endpoint correspondant à la région où réside votre bucket. Régions et endpoints.
2. Construire et envoyer une requête
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. Comprendre la réponse
-
Réponse réussie : Une requête aboutie renvoie un code d'état
2xx. Pour les opérations retournant des données, le corps de la réponse est au format 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 Gestion des erreurs : Les requêtes échouées renvoient un code d'état
4xxou5xx, accompagné d'un corps XML contenant unCodeet unMessage. Codes d'erreur.
Liste des API
Opérations de service
|
API |
Description |
|
Renvoie tous les buckets appartenant au demandeur. |
|
|
Répertorie toutes les tâches de transition de redondance des données du demandeur. |
Opérations de région
|
API |
Description |
|
Interroge les endpoints de toutes les régions prises en charge ou d'une région spécifique. |
Opérations sur les buckets
|
Classification |
API |
Description |
|
Opérations de base |
Crée un bucket. |
|
|
Supprime un bucket. |
||
|
Répertorie les informations de tous les objets d'un bucket. |
||
|
Interroge les informations d'un bucket. |
||
|
Interroge l'emplacement d'un bucket. |
||
|
Interroge l'utilisation du stockage et le nombre d'objets d'un bucket. |
||
|
Politique de rétention |
Crée une politique de rétention. |
|
|
Supprime une politique de rétention non verrouillée. |
||
|
Verrouille une politique de rétention. |
||
|
Prolonge la période de rétention des objets d'un bucket dont la politique de rétention est verrouillée. |
||
|
Interroge la politique de rétention d'un bucket. |
||
|
Contrôle d'accès |
Définit les permissions d'accès d'un bucket. |
|
|
Interroge les permissions d'accès d'un bucket. |
||
|
Cycle de vie |
Définit des règles de cycle de vie pour les objets d'un bucket. |
|
|
Interroge les règles de cycle de vie des objets d'un bucket. |
||
|
Supprime les règles de cycle de vie des objets d'un bucket. |
||
|
Accélération des transferts |
Configure l'accélération des transferts pour un bucket. |
|
|
Interroge la configuration d'accélération des transferts d'un bucket. |
||
|
Versioning |
Définit l'état du versioning d'un bucket. |
|
|
Interroge l'état du versioning d'un bucket. |
||
|
Répertorie les versions de tous les objets d'un bucket. |
||
|
Réplication interrégionale |
Définit des règles de réplication des données pour un bucket. |
|
|
Active ou désactive le contrôle du temps de réplication (RTC) pour les règles de réplication interrégionale existantes. |
||
|
Interroge les règles de réplication des données définies pour un bucket. |
||
|
Interroge les régions de destination vers lesquelles les données peuvent être répliquées. |
||
|
Interroge la progression de la réplication des données d'un bucket. |
||
|
Arrête les tâches de réplication des données et supprime la configuration de réplication d'un bucket. |
||
|
Politique d'autorisation |
Définit une politique de bucket. |
|
|
Interroge une politique de bucket. |
||
|
Vérifie si la politique actuelle du bucket autorise l'accès public. |
||
|
Supprime une politique de bucket. |
||
|
Inventaire |
Définit une règle d'inventaire pour un bucket. |
|
|
Interroge une tâche d'inventaire spécifique dans un bucket. |
||
|
Interroge toutes les tâches d'inventaire d'un bucket. |
||
|
Supprime une tâche d'inventaire spécifique d'un bucket. |
||
|
Gestion des journaux |
Active la fonctionnalité d'enregistrement des journaux d'accès pour un bucket. |
|
|
Interroge la configuration des journaux d'accès d'un bucket. |
||
|
Désactive la fonctionnalité d'enregistrement des journaux d'accès pour un bucket. |
||
|
Configure le champ |
||
|
Interroge la configuration du champ |
||
|
Supprime la configuration du champ |
||
|
Site web statique |
Configure un bucket en mode d'hébergement de site web statique. |
|
|
Interroge l'état d'hébergement de site web statique d'un bucket. |
||
|
Désactive le mode d'hébergement de site web statique pour un bucket. |
||
|
Protection contre le hotlinking |
Définit une règle de protection contre le hotlinking pour un bucket. |
|
|
Interroge la règle de protection contre le hotlinking d'un bucket. |
||
|
Tags |
Ajoute ou modifie les tags d'un bucket. |
|
|
Interroge les tags d'un bucket. |
||
|
Supprime les tags d'un bucket. |
||
|
Chiffrement |
Configure les règles de chiffrement d'un bucket. |
|
|
Interroge les règles de chiffrement d'un bucket. |
||
|
Supprime les règles de chiffrement d'un bucket. |
||
|
Paiement par le demandeur |
Configure un bucket en mode de paiement par le demandeur. |
|
|
Interroge la configuration de paiement par le demandeur d'un bucket. |
||
|
Partage de ressources cross-origin |
Définit des règles de partage de ressources cross-origin (CORS) pour un bucket spécifié. |
|
|
Interroge les règles CORS actuelles d'un bucket spécifié. |
||
|
Désactive la fonctionnalité CORS et efface toutes les règles CORS d'un bucket spécifié. |
||
|
Envoie une requête preflight (OPTIONS) contenant l'origine source, la méthode HTTP et les en-têtes à OSS afin de déterminer si le navigateur est autorisé à envoyer la requête cross-origin réelle. |
||
|
Suivi des accès |
Configure l'état du suivi des accès d'un bucket. |
|
|
Interroge l'état du suivi des accès d'un bucket. |
||
|
Indexation des données |
Active la fonctionnalité de gestion des métadonnées pour un bucket. |
|
|
Interroge la bibliothèque d'index de métadonnées d'un bucket spécifié. |
||
|
Interroge les objets correspondant aux conditions spécifiées et renvoie les résultats triés selon les champs et méthodes de tri indiqués. |
||
|
Désactive la fonctionnalité de gestion des métadonnées pour un bucket. |
||
|
Protection DDoS |
Crée une instance Anti-DDoS for OSS. |
|
|
Modifie l'état d'une instance Anti-DDoS for OSS. |
||
|
Interroge les instances Anti-DDoS for OSS appartenant à un compte spécifié. |
||
|
Initialise la protection d'un bucket. |
||
|
Met à jour l'état de protection d'un bucket. |
||
|
Interroge les informations de protection des buckets. |
||
|
Groupe de ressources |
Configure un groupe de ressources pour un bucket. |
|
|
Interroge l'ID du groupe de ressources auquel appartient un bucket. |
||
|
Nom de domaine personnalisé |
Crée un token CNAME nécessaire pour vérifier la propriété d'un nom de domaine. |
|
|
Interroge un token CNAME créé. |
||
|
Associe un enregistrement CNAME à un bucket. |
||
|
Répertorie tous les enregistrements CNAME associés à un bucket. |
||
|
Supprime un enregistrement CNAME associé. |
||
|
Style d'image |
Ajoute un style d'image. |
|
|
Interroge les informations relatives à un style d'image spécifique dans un bucket. |
||
|
Interroge tous les styles d'image créés dans un bucket. |
||
|
Supprime un style d'image spécifique d'un bucket. |
||
|
Sécurité de la couche de transport |
Active ou désactive les paramètres de version TLS pour un bucket. |
|
|
Interroge les paramètres de version TLS d'un bucket. |
||
|
Transition de redondance |
Crée une tâche de transition de redondance des données. |
|
|
Interroge une tâche de transition de redondance des données. |
||
|
Supprime une tâche de transition de redondance des données. |
||
|
Répertorie toutes les tâches de transition de redondance des données du demandeur. |
||
|
Répertorie toutes les tâches de transition de redondance des données d'un bucket. |
||
|
Point d'accès |
Crée un point d'accès. |
|
|
Interroge les informations d'un point d'accès. |
||
|
Supprime un point d'accès. |
||
|
Interroge les informations des points d'accès au niveau utilisateur ou au niveau du bucket. |
||
|
Configure une politique de point d'accès. |
||
|
Interroge la configuration d'une politique de point d'accès. |
||
|
Supprime une politique de point d'accès. |
||
|
Point d'accès Object FC |
Crée un point d'accès Object FC. |
|
|
Interroge les informations de base d'un point d'accès Object FC. |
||
|
Supprime un point d'accès Object FC. |
||
|
Interroge les informations des points d'accès Object FC au niveau utilisateur. |
||
|
Modifie la configuration d'un point d'accès Object FC. |
||
|
Interroge la configuration d'un point d'accès Object FC. |
||
|
Configure une politique d'accès pour un point d'accès Object FC. |
||
|
Interroge la configuration de la politique d'accès d'un point d'accès Object FC. |
||
|
Supprime la politique d'accès d'un point d'accès Object FC. |
||
|
Personnalise les données renvoyées et les en-têtes de réponse. |
||
|
Blocage de l'accès public |
Active globalement le blocage de l'accès public pour OSS. |
|
|
Interroge la configuration globale de blocage de l'accès public pour OSS. |
||
|
Supprime la configuration globale de blocage de l'accès public pour OSS. |
||
|
Active le blocage de l'accès public pour un bucket. |
||
|
Interroge la configuration de blocage de l'accès public d'un bucket spécifié. |
||
|
Supprime la configuration de blocage de l'accès public d'un bucket spécifié. |
||
|
Active le blocage de l'accès public pour un point d'accès. |
||
|
Interroge la configuration de blocage de l'accès public d'un point d'accès spécifié. |
||
|
Supprime la configuration de blocage de l'accès public d'un point d'accès spécifié. |
||
|
Accès en temps réel aux objets Archive |
Active ou désactive l'accès en temps réel aux objets Archive. |
|
|
Vérifie si l'accès en temps réel aux objets Archive est activé. |
||
|
Accélérateur OSS |
Crée un accélérateur OSS ou modifie sa configuration. |
|
|
Interroge les informations d'un accélérateur OSS. |
||
|
Supprime un accélérateur OSS. |
Opérations sur les objets
|
Classification |
API |
Description |
|
Opérations de base |
Charge un objet. |
|
|
Interroge un objet. |
||
|
Copie un objet. |
||
|
Charge un objet via un chargement par ajout. |
||
|
Empêche l'ajout de données à un objet Appendable. |
||
|
Supprime un objet unique. |
||
|
Supprime plusieurs objets. |
||
|
Renvoie uniquement les métadonnées de l'objet, sans son contenu. |
||
|
Renvoie les métadonnées de base de l'objet (ETag, taille, date de dernière modification) sans son contenu. |
||
|
Charge un objet à l'aide d'un formulaire HTML. |
||
|
Permet d'implémenter un rappel en incluant les paramètres de callback dans une requête envoyée à OSS. |
||
|
Restaure un objet Archive Storage, Cold Archive ou Deep Cold Archive. |
||
|
Met fin prématurément à l'état restauré d'un objet. |
||
|
Exécute une instruction SQL sur un fichier objet et renvoie le résultat. |
||
|
Interroge le nombre de lignes, le nombre de colonnes (CSV) et le nombre de splits d'un fichier objet. |
||
|
Gestion des dossiers |
Crée un dossier. |
|
|
Renomme un dossier ou un objet. |
||
|
Supprime un dossier. |
||
|
Chargement multipartite |
Lance un événement de chargement multipartite. |
|
|
Charge une partie en utilisant le nom de l'objet et l'ID de chargement. |
||
|
Copie des données d'un objet existant pour charger une partie, en ajoutant l'en-tête de requête x-oss-copy-source à une requête UploadPart. |
||
|
Termine un chargement multipartite en assemblant toutes les parties chargées. |
||
|
Annule un événement de chargement multipartite et supprime les parties déjà chargées. |
||
|
Répertorie tous les chargements multipartites en cours (lancés mais non terminés ni annulés). |
||
|
Répertorie toutes les parties chargées avec succès associées à un ID de chargement spécifié. |
||
|
Contrôle d'accès |
Modifie les permissions d'accès d'un objet. |
|
|
Interroge les permissions d'accès d'un objet. |
||
|
Lien symbolique |
Crée un lien symbolique. |
|
|
Interroge un lien symbolique. |
||
|
Tagging |
Définit ou met à jour les tags d'un objet. |
|
|
Interroge les tags d'un objet. |
||
|
Supprime les tags spécifiés d'un objet. |
Opérations sur les buckets vectoriels
|
Classification |
API |
Description |
|
Bucket vectoriel |
PutVectorBucket |
Crée un bucket vectoriel. |
|
GetVectorBucket |
Interroge les détails d'un bucket vectoriel. |
|
|
ListVectorBuckets |
Répertorie tous les buckets vectoriels appartenant au compte actuel. |
|
|
DeleteVectorBucket |
Supprime un bucket vectoriel. |
|
|
Index |
PutVectorIndex |
Crée un index vectoriel dans un bucket vectoriel. |
|
GetVectorIndex |
Interroge les détails d'un index vectoriel. |
|
|
ListVectorIndexes |
Répertorie tous les index vectoriels d'un bucket vectoriel. |
|
|
DeleteVectorIndex |
Après avoir chargé toutes les parties de données, vous devez appeler l'API CompleteMultipartUpload pour terminer le chargement multipartite. |
|
|
Vecteurs |
PutVectors |
Écrit des données vectorielles dans un index. |
|
GetVectors |
Interroge des données vectorielles spécifiées. |
|
|
ListVectors |
Répertorie toutes les données vectorielles d'un index vectoriel. |
|
|
DeleteVectors |
Supprime des données vectorielles spécifiées d'un index vectoriel. |
|
|
QueryVectors |
Effectue une recherche de similarité vectorielle. |
Opérations QoS des groupes de ressources
|
API |
Description |
|
Définit la limitation de débit pour un bucket dans un pool de ressources. |
|
|
Interroge la configuration de limitation de débit d'un bucket dans un pool de ressources. |
|
|
Supprime la configuration de limitation de débit d'un bucket spécifié dans un pool de ressources. |
|
|
Définit une limitation de débit au niveau du bucket pour un demandeur. |
|
|
Interroge la configuration de limitation de débit au niveau du bucket pour un demandeur spécifié. |
|
|
Interroge les configurations de limitation de débit au niveau du bucket pour tous les demandeurs. |
|
|
Supprime la configuration de limitation de débit d'un demandeur pour un bucket. |
|
|
Interroge les informations de tous les pools de ressources appartenant au compte actuel. |
|
|
Interroge la configuration de limitation de débit d'un pool de ressources spécifié. |
|
|
Interroge la liste des buckets inclus dans un pool de ressources spécifié. |
|
|
Configure la limitation de débit pour un demandeur d'un pool de ressources. |
|
|
Interroge la configuration de limitation de débit d'un demandeur spécifié pour un pool de ressources. |
|
|
Interroge les configurations de limitation de débit de tous les demandeurs pour un pool de ressources. |
|
|
Supprime la configuration de limitation de débit d'un demandeur spécifié pour un pool de ressources. |
|
|
Ajoute un bucket d'un pool de ressources à un groupe de buckets. |
|
|
Répertorie les groupes de buckets d'un pool de ressources spécifié. |
|
|
Configure ou modifie les paramètres de limitation de débit pour un groupe de buckets dans un pool de ressources. |
|
|
Interroge la configuration de limitation de débit d'un groupe de buckets dans un pool de ressources. |
|
|
Répertorie les configurations de limitation de débit des groupes de buckets d'un pool de ressources. |
|
|
Supprime la configuration de limitation de débit d'un groupe de buckets dans un pool de ressources. |
Opérations LiveChannel
|
API |
Description |
|
Modifie l'état d'un LiveChannel. |
|
|
Crée un LiveChannel. |
|
|
Interroge une playlist. |
|
|
Génère une playlist. |
|
|
Interroge l'état d'ingestion de flux d'un LiveChannel. |
|
|
Interroge la configuration d'un LiveChannel. |
|
|
Interroge l'historique d'ingestion de flux d'un LiveChannel. |
|
|
Répertorie les LiveChannels. |
|
|
Supprime un LiveChannel. |