RegisterMedia - - Centre de documentation Alibaba Cloud

Description de l'opération

Pour les fichiers multimédias audio et vidéo déjà stockés dans des compartiments OSS intégrés à ApsaraVideo VOD, vous devez appeler l'opération d'enregistrement des ressources multimédias pour générer les données associées requises par ApsaraVideo VOD. Vous pouvez ensuite lancer le transcodage, la génération d'instantanés et le traitement par IA pour ces fichiers multimédias en utilisant leurs identifiants multimédias dans ApsaraVideo VOD.
Vous pouvez enregistrer jusqu'à 10 fichiers multimédias OSS à la fois, et les adresses de stockage des fichiers multimédias soumis simultanément doivent être identiques.
Pour les fichiers multimédias chargés dans ApsaraVideo 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 des ressources multimédias, si aucun identifiant de groupe de modèles de transcodage n'est spécifié, le transcodage n'est pas déclenché automatiquement. Si un identifiant de groupe de modèles de transcodage est spécifié, le groupe de modèles indiqué est utilisé pour le transcodage.
Pour les fichiers multimédias enregistrés de manière répétée, seul l'identifiant multimédia unique associé au fichier est renvoyé, et aucun autre traitement n'est effectué.
Assurez-vous que les fichiers de ressources multimédias que vous souhaitez enregistrer possèdent des extensions de nom de fichier valides. Dans le cas contraire, 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

*Toutes les ressources.

*

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 les métadonnées de 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 > Configuration du traitement des médias > Groupes de modèles de transcodage pour afficher l'identifiant du groupe de modèles de transcodage. Lorsque vous créez un groupe de modèles de transcodage en appelant l'opération Créer un groupe de modèles de transcodage, l'identifiant du groupe de modèles de transcodage correspond à la valeur du paramètre de réponse TranscodeTemplateGroupId. Lorsque vous interrogez des groupes de modèles de transcodage en appelant l'opération Interroger les configurations de transcodage, l'identifiant du groupe de modèles de transcodage correspond à la valeur du paramètre de réponse TranscodeTemplateGroupId. Remarque Si le transcodage n'est pas requis, définissez ce paramètre sur VOD_NO_TRANSCODE, qui spécifie le groupe de modèles sans transcodage. Sinon, l'état de la vidéo est Chargement terminé et vous ne pouvez pas utiliser le service de lecture pour lire l'audio ou la vidéo. 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 multimédias. La tâche pour ce paramètre est une tâche asynchrone. Une fois la tâche soumise, elle n'est pas immédiatement terminée, mais mise en file d'attente pour une exécution asynchrone en arrière-plan.	ca3a8f6e49c87b65806709586****
UserData	string	Non	Les paramètres personnalisés. La valeur est une chaîne JSON. Vous pouvez configurer des paramètres tels que les rappels de messages. Pour plus d'informations sur le paramètre, consultez UserData. Remarque Cette opération ne prend pas en charge les rappels. Même si un rappel de message est configuré 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 et la génération d'instantanés pour les ressources multimédias enregistrées, si vous configurez séparément un rappel de message dans UserData lors du lancement du transcodage ou de la génération d'instantanés, cette URL de rappel est prioritaire. Si aucun rappel n'est configuré séparément, l'URL de rappel configuré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 multimédia. Vous pouvez vous connecter à la console ApsaraVideo VOD et choisir Gestion de la configuration > Configuration du 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 multimédias. La tâche pour ce paramètre est une tâche asynchrone. Une fois la tâche soumise, elle n'est pas immédiatement terminée, mais mise en file d'attente pour une exécution asynchrone en arrière-plan.	637adc2b7ba51a83d841606f8****
EnableFirstFrameCover	boolean	Non	Indique si la première image de la vidéo doit être utilisée comme miniature.
GenerateThumbnail	boolean	Non	Indique si une miniature doit être générée pour la vidéo.

RegisterMetadata

Les métadonnées des ressources multimédias à enregistrer.

Nom	Type	Requis	Description
FileURL	String	Yes	L'URL du fichier source. Vous pouvez obtenir l'URL en appelant l'opération Obtenir les informations du fichier source. L'URL peut comporter jusqu'à 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 multimédia unique. Le format est le point de terminaison public du compartiment OSS + ObjectName (nom du fichier).
Title	String	Yes	Le titre. Le titre peut comporter jusqu'à 128 octets. Il doit être encodé en UTF-8.
Description	String	No	La description. La description peut comporter jusqu'à 1 024 octets. Elle doit être encodée en UTF-8.
Tags	String	No	Les balises. Une balise unique peut comporter jusqu'à 32 octets. Vous pouvez spécifier jusqu'à 16 balises. Séparez plusieurs balises par des virgules (,). Elles doivent être encodées en UTF-8.
CoverURL	String	No	L'URL de la miniature. L'URL peut comporter jusqu'à 1 024 octets.
CateId	Long	No	L'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 > Configuration de la gestion des ressources multimédias > Gestion des catégories pour afficher l'identifiant de la catégorie. Lorsque vous créez une catégorie en appelant l'opération Créer une catégorie, l'identifiant de la catégorie correspond à la valeur du paramètre de réponse CateId. Lorsque vous interrogez des catégories en appelant l'opération Obtenir les catégories et sous-catégories, l'identifiant de la catégorie correspond à la valeur du paramètre de réponse CateId.
ReferenceId	String	No	L'identifiant personnalisé. L'identifiant peut comporter de 6 à 64 caractères et ne peut contenir que des lettres minuscules, des lettres majuscules, des chiffres, des traits d'union (-) et des traits de soulignement (_). L'identifiant doit être unique par utilisateur.

Éléments de réponse

Élément	Type	Description	Exemple
	object	La réponse.
RequestId	string	L'identifiant de la requête.	14F43C5C-8033-448B-AD04F64E5098****
FailedFileURLs	array	La liste des URL des fichiers dont l'enregistrement a échoué.
	string	La liste des URL des 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 ont été enregistrées avec succès dans cette requête, 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 : La ressource multimédia est nouvellement enregistrée. false : La ressource multimédia est 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 multimédia dans ApsaraVideo VOD. Si le fichier multimédia enregistré est un fichier audio ou vidéo, ce paramètre 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.