GetVideoList - - Centre de documentation Alibaba Cloud

Obtient la liste des informations audio et vidéo.

Description de l'opération

Cette opération récupère jusqu'à 5000 fichiers audio et vidéo correspondant aux conditions de filtrage spécifiées (telles que l'état de la vidéo et l'identifiant de la catégorie). Spécifiez StartTime et EndTime pour récupérer les données par lots. Pour interroger davantage de fichiers audio et vidéo ou parcourir toutes les informations audio et vidéo, consultez Rechercher des informations sur les médias.

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:GetVideoList

list

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
CateId	integer	Non	L'identifiant de la catégorie. Vous pouvez obtenir l'identifiant de la catégorie en utilisant les méthodes suivantes : Connectez-vous à la console ApsaraVideo VOD et choisissez Gestion de la configuration > Configuration de la gestion des mé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 CreateCategory. Obtenez la valeur de CateId à partir de la réponse lorsque vous appelez l'opération GetCategories.	781111
Status	string	Non	L'état de la vidéo. Vous pouvez spécifier plusieurs états. Séparez les différents états par des virgules (,). Valeurs valides : Uploading : la vidéo est en cours de téléversement. UploadFail : le téléversement de la vidéo a échoué. UploadSucc : la vidéo a été téléversée. Transcoding : la vidéo est en cours de transcodage. TranscodeFail : le transcodage de la vidéo a échoué. Checking : la vidéo est en cours de vérification. Blocked : la vidéo est bloquée. Normal : la vidéo est dans un état normal. ProduceFail : la production de la vidéo a échoué. Pour plus d'informations sur les états des vidéos et les limites associées, consultez État : état de la vidéo.	Uploading,Normal
PageNo	integer	Non	Le numéro de page. Valeur par défaut : 1.	1
PageSize	integer	Non	Le nombre d'entrées par page. Valeur par défaut : 10. Valeur maximale : 100.	10
SortBy	string	Non	La règle de tri des résultats. Valeurs valides : CreationTime:Desc (par défaut) : triés par heure de création par ordre décroissant. CreationTime:Asc : triés par heure de création par ordre croissant.	CreationTime:Asc
StartTime	string	Non	Le début de la plage de temps à interroger en fonction de CreationTime (heure de création). Spécifiez l'heure au format yyyy-MM-ddTHH:mm:ssZ (UTC).	2017-01-11T12:00:00Z
EndTime	string	Non	La fin de la plage de temps à interroger en fonction de CreationTime. L'heure de fin doit être postérieure à l'heure de début. Spécifiez l'heure au format yyyy-MM-ddTHH:mm:ssZ (UTC).	2017-01-11T12:59:00Z
StorageLocation	string	Non	L'adresse de stockage du fichier audio ou vidéo.	out-****.oss-cn-shanghai.aliyuncs.com
ReferenceIds	string	Non	La liste des identifiants personnalisés. Spécifiez un ou plusieurs identifiants personnalisés séparés par des virgules (,). Un maximum de 20 identifiants sont pris en charge.	123-123,1234-1234

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
Total	integer	Le nombre total de fichiers audio et vidéo.	100
RequestId	string	L'identifiant de la requête.	25818875-5F78-4AF6-D7393642CA58****
VideoList	object
Video	array<object>	La liste des informations audio et vidéo. Un maximum de 5000 entrées peuvent être renvoyées.
	array<object>	Les détails du fichier audio ou vidéo.
StorageLocation	string	The storage address of the audio or video file.	out-****.oss-cn-shanghai.aliyuncs.com
Status	string	The video status. Valid values: Uploading: The video is being uploaded. UploadFail: The video failed to be uploaded. UploadSucc: The video has been uploaded. Transcoding: The video is being transcoded. TranscodeFail: The video failed to be transcoded. Checking: The video is being reviewed. Blocked: The video is blocked. Normal: The video is in a normal state. ProduceFail: The video failed to be produced. For more information about video statuses and related limits, see Status: video status.	Normal
CreationTime	string	The creation time of the audio or video file. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2017-11-14T09:15:50Z
CateId	integer	The category ID.	781111
VideoId	string	The audio or video ID.	9ae2af636ca6c10412f44891fc****
Tags	string	The tags of the audio or video file. Multiple tags are separated by commas (,).	Tag 1, Tag 2
ModificationTime	string	The last modification time of the video. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2017-11-14T09:16:50Z
CateName	string	The category name.	Category name
Description	string	The description of the audio or video file.	Alibaba Cloud VOD video description
AppId	string	The application ID. Default value: app-1000000.	app-1000000
Size	integer	The size of the source audio or video file. Unit: bytes.	10897890
CoverURL	string	The thumbnail URL of the audio or video file.	https://example.aliyundoc.com/****.jpg
Duration	number	The duration of the audio or video file. Unit: seconds.	135.6
Title	string	The title of the audio or video file.	Alibaba Cloud VOD video title
Snapshots	object
Snapshot	array	The array of video snapshot URLs.
	string	The video snapshot URL. Remarque Snapshot data is returned only for videos that have been processed by video snapshots. Otherwise, an empty value is returned.	http://example.aliyundoc.com/snapshot/**.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333**
StorageClass	string	The storage class of the media asset. Valid values: Standard: standard. IA: Infrequent Access for media assets. Archive: Archive for media assets. ColdArchive: Cold Archive for media assets. SourceIA: Infrequent Access for source files. SourceArchive: Archive for source files. SourceColdArchive: Cold Archive for source files. Changing: The storage class of the media asset is being changed. SourceChanging: The storage class of the source file is being changed.	Standard
RestoreStatus	string	The restoration status of the media asset. Valid values: Processing: The media asset is being restored. Success: The media asset has been restored. Failed: The media asset failed to be restored.	Success
RestoreExpiration	string	The expiration time of the media asset restoration.	2023-03-30T10:14:14Z
UserData	string	The custom settings. The value is a JSON string that supports settings such as message callbacks and upload acceleration. For more information, see UserData.	{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"*****","test":"www"}}
ReferenceId	string	The custom ID. Only lowercase letters, uppercase letters, digits, hyphens, and underscores are supported. The value must be 6 to 64 characters in length and is unique at the user level.	123-123

Exemples

JSON format

{
  "Total": 100,
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "VideoList": {
    "Video": [
      {
        "StorageLocation": "out-****.oss-cn-shanghai.aliyuncs.com",
        "Status": "Normal",
        "CreationTime": "2017-11-14T09:15:50Z",
        "CateId": 781111,
        "VideoId": "9ae2af636ca6c10412f44891fc****",
        "Tags": "Tag 1, Tag 2",
        "ModificationTime": "2017-11-14T09:16:50Z",
        "CateName": "Category name",
        "Description": "Alibaba Cloud VOD video description",
        "AppId": "app-1000000",
        "Size": 10897890,
        "CoverURL": "https://example.aliyundoc.com/****.jpg",
        "Duration": 135.6,
        "Title": "Alibaba Cloud VOD video title",
        "Snapshots": {
          "Snapshot": [
            "http://example.aliyundoc.com/snapshot/****.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****"
          ]
        },
        "StorageClass": "Standard",
        "RestoreStatus": "Success",
        "RestoreExpiration": "2023-03-30T10:14:14Z",
        "UserData": "{\"MessageCallback\":{\"CallbackURL\":\"http://example.aliyundoc.com\"},\"Extend\":{\"localId\":\"*****\",\"test\":\"www\"}}",
        "ReferenceId": "123-123"
      }
    ]
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.