Tous les produits
Search
Centre de documentation

:RegisterMedia

Dernière mise à jour :Aug 05, 2026

Enregistre les ressources multimédias. Les fichiers multimédias existants stockés dans votre propre compartiment OSS connecté à ApsaraVideo VOD doivent être enregistrés pour générer les données associées requises par VOD avant de pouvoir utiliser les fonctionnalités VOD telles que le transcodage et la capture d'instantanés.

Description de l'opération

  • Pour les fichiers audio et vidéo déjà stockés dans un compartiment OSS connecté à ApsaraVideo VOD, vous devez appeler cette opération pour générer les données associées requises par VOD avant de pouvoir lancer le transcodage, la capture d'instantanés, le traitement par IA et d'autres opérations sur ces fichiers par identifiant de média.

  • Vous pouvez enregistrer jusqu'à 10 fichiers multimédias OSS à la fois, et tous les fichiers multimédias soumis dans une seule requête doivent correspondre à la même adresse de stockage.

  • Pour les fichiers multimédias téléchargés via VOD, si aucun identifiant de groupe de modèles de transcodage n'est spécifié, le groupe de modèles par défaut est utilisé pour le transcodage. En revanche, après l'enregistrement de la ressource multimédia, le transcodage n'est pas déclenché automatiquement si aucun identifiant de groupe de modèles de transcodage n'est spécifié. Si un identifiant de groupe de modèles de transcodage est spécifié, le transcodage est effectué en fonction du groupe de modèles spécifié.

  • Si un fichier multimédia est enregistré de manière répétée, seul l'identifiant de média unique qui lui est associé est renvoyé, et aucun autre traitement n'est effectué.

  • Assurez-vous que le fichier multimédia que vous souhaitez enregistrer possède une extension de nom de fichier valide. Sinon, l'enregistrement échoue.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

  • Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.

  • API : l'API que vous pouvez appeler pour exécuter l'action.

  • Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.

  • Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.

    • Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.

    • Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.

  • Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.

  • Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

vod:RegisterMedia

create

*All Resource

*

Aucune Aucune

Paramètres de requête

Paramètre

Type

Requis

Description

Exemple

RegisterMetadatas

string

Oui

Les métadonnées des ressources multimédias à enregistrer. La valeur est une chaîne JSON. Vous pouvez spécifier des métadonnées pour jusqu'à 10 ressources multimédias à la fois. Pour plus d'informations sur la structure du paramètre, consultez le tableau RegisterMetadata ci-dessous.

[{"FileURL":"https://****.oss-cn-shanghai.aliyuncs.com/video/test/video123.m3u8","Title":"VideoName"}]

TemplateGroupId

string

Non

L'identifiant du groupe de modèles de transcodage. Vous pouvez obtenir cet identifiant en utilisant l'une des méthodes suivantes :

  • Connectez-vous à la console ApsaraVideo VOD et choisissez Gestion de la configuration > Traitement des médias > Groupes de modèles de transcodage pour afficher l'identifiant du groupe de modèles de transcodage.

  • Obtenez la valeur de TranscodeTemplateGroupId à partir de la réponse lorsque vous appelez l'opération CreateTranscodeTemplateGroup.

  • Obtenez la valeur de TranscodeTemplateGroupId à partir de la réponse lorsque vous appelez l'opération ListTranscodeTemplateGroup.

Remarque
  • Si le transcodage n'est pas requis, définissez ce paramètre sur VOD_NO_TRANSCODE (le groupe de modèles sans transcodage). Sinon, l'état de la vidéo est UploadSucc et la vidéo ne peut pas être lue à l'aide du service de lecture. Si le transcodage est requis, spécifiez l'identifiant du groupe de modèles de transcodage correspondant.

  • Si WorkflowId et TemplateGroupId sont tous deux spécifiés, WorkflowId est prioritaire. Pour plus d'informations, consultez Workflows.

  • Ce paramètre déclenche une tâche asynchrone. Après soumission, la tâche entre dans une file d'attente en arrière-plan pour une exécution asynchrone.

ca3a8f6e49c87b65806709586****

UserData

string

Non

Les paramètres personnalisés. La valeur est une chaîne JSON qui prend en charge des paramètres tels que les rappels de messages. Pour plus d'informations, consultez UserData.

Remarque

Cette opération ne prend pas en charge les rappels. Même si vous configurez un rappel de message dans ce paramètre, aucun message de rappel n'est généré une fois l'enregistrement de la ressource multimédia terminé. Lorsque vous lancez ultérieurement un traitement multimédia tel que le transcodage ou la capture d'instantanés sur la ressource multimédia enregistrée, si vous spécifiez un rappel de message dans UserData à ce moment-là, cette URL de rappel est prioritaire. Sinon, l'URL de rappel spécifiée dans UserData lors de l'enregistrement de la ressource multimédia est utilisée.

{"Extend":{"localId":"****","test":"www"}}

WorkflowId

string

Non

L'identifiant du workflow. Connectez-vous à la console ApsaraVideo VOD et choisissez Gestion de la configuration > Traitement des médias > Gestion des workflows pour afficher l'identifiant du workflow.

Remarque
  • Si WorkflowId et TemplateGroupId sont tous deux spécifiés, WorkflowId est prioritaire. Pour plus d'informations, consultez Workflows.

  • Ce paramètre déclenche une tâche asynchrone. Après soumission, la tâche entre dans une file d'attente en arrière-plan pour une exécution asynchrone.

637adc2b7ba51a83d841606f8****

EnableFirstFrameCover

boolean

Non

GenerateThumbnail

boolean

Non

RegisterMetadata

Spécifie les métadonnées des ressources multimédias à enregistrer.

NomTypeRequisDescription
FileURLStringOuiL'URL du fichier source. Vous pouvez obtenir cette valeur en appelant l'opération GetMezzanineInfo.
L'URL ne peut pas dépasser 1 024 octets. Le nom du fichier doit être globalement unique. Si vous ajoutez un fichier portant le même nom, il est associé à l'identifiant de média unique. L'URL est au format du point de terminaison public du compartiment OSS + ObjectName (nom du fichier).

TitleStringOuiLe titre. Le titre ne peut pas dépasser 128 octets. Encodé en UTF-8.
DescriptionStringNonLa description. La description ne peut pas dépasser 1 024 octets. Encodée en UTF-8.
TagsStringNonLes balises. Chaque balise ne peut pas dépasser 32 octets. Vous pouvez spécifier jusqu'à 16 balises. Séparez plusieurs balises par des virgules (,). Encodées en UTF-8.
CoverURLStringNonL'URL de la couverture. L'URL ne peut pas dépasser 1 024 octets.
CateIdLongNonL'identifiant de la catégorie. Vous pouvez obtenir cet identifiant en utilisant l'une des méthodes suivantes :
Connectez-vous à la console ApsaraVideo VOD et choisissez Gestion de la configuration > Gestion des ressources multimédias > Gestion des catégories pour afficher l'identifiant de la catégorie.
Obtenez la valeur de CateId à partir de la réponse lorsque vous appelez l'opération AddCategory.
Obtenez la valeur de CateId à partir de la réponse lorsque vous appelez l'opération GetCategories.







ReferenceIdStringNonL'identifiant personnalisé. Seules les lettres minuscules, les lettres majuscules, les chiffres, les traits d'union (-) et les traits de soulignement (_) sont pris en charge. La valeur doit comporter de 6 à 64 caractères et doit être unique pour chaque utilisateur.

Éléments de réponse

Élément

Type

Description

Exemple

object

Les paramètres de réponse.

RequestId

string

L'identifiant de la requête.

14F43C5C-8033-448B-AD04F64E5098****

FailedFileURLs

array

La liste des URL de fichiers dont l'enregistrement a échoué.

string

La liste des URL de fichiers dont l'enregistrement a échoué.

["http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_03.mp4"]

RegisteredMediaList

array<object>

La liste des ressources multimédias qui sont enregistrées avec succès, y compris les fichiers nouvellement enregistrés et les fichiers précédemment enregistrés.

object

Les détails de l'enregistrement.

NewRegister

boolean

Indique si la ressource multimédia est nouvellement enregistrée ou enregistrée de manière répétée.

  • true : nouvellement enregistrée.

  • false : enregistrée de manière répétée.

false

FileURL

string

L'URL du fichier OSS.

http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_01.mp4

MediaId

string

L'identifiant de média VOD. Si le fichier multimédia enregistré est un fichier audio ou vidéo, cette valeur correspond au VideoId dans ApsaraVideo VOD.

d97af32828084d1896683b1aa38****

Exemples

JSON format

{
  "RequestId": "14F43C5C-8033-448B-AD04F64E5098****",
  "FailedFileURLs": [
    "[\"http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_03.mp4\"]"
  ],
  "RegisteredMediaList": [
    {
      "NewRegister": false,
      "FileURL": "http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_01.mp4",
      "MediaId": "d97af32828084d1896683b1aa38****"
    }
  ]
}

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.