DescribeCasterConfig - - Centre de documentation Alibaba Cloud

Consulte les informations de configuration d'un studio de production.

Description de l'opération

Créez un studio de production en appelant l'opération CreateCaster, puis appelez cette opération pour consulter les informations de configuration du studio de production.

Limite de QPS

La limite de QPS par utilisateur pour cette opération est de 15 appels par seconde. Si cette limite est dépassée, l'appel d'API est limité, ce qui peut affecter votre activité. Appelez cette opération de manière appropriée.

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.

live:DescribeCasterConfig

get

*Caster.

acs:live:*:{#accountId}:caster/{#CasterId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Non	L'identifiant de la région.	cn-shanghai
CasterId	string	Oui	L'identifiant du studio de production. Si vous avez créé le studio de production en appelant l'opération CreateCaster, vérifiez la valeur du paramètre CasterId renvoyée par l'opération CreateCaster. Si vous avez créé le studio de production dans la console ApsaraVideo Live, accédez à Console ApsaraVideo Live > Studios de production > Studio de production cloud pour consulter l'identifiant. Remarque Le nom du studio de production dans la liste des studios de production sur la page Studio de production cloud correspond à l'identifiant du studio de production.	LIVEPRODUCER_POST-cn-0pp1czt****

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les informations de configuration du studio de production.
AutoSwitchUrgentConfig	string	La configuration de basculement automatique vers la vidéo de secours. `eofThres` : spécifie la durée d'interruption du flux avant le basculement automatique vers la vidéo de secours. Unité : secondes.	{"eofThres":3}
AutoSwitchUrgentOn	string	Indique si le basculement automatique vers la vidéo de secours en cas d'interruption du flux est activé. true : Activé. false : Désactivé.	true
CallbackUrl	string	L'URL de rappel de l'utilisateur.	http://learn.aliyundoc.com/callBackLive
CasterId	string	L'identifiant du studio de production.	LIVEPRODUCER_POST-cn-0pp1czt****
CasterName	string	Le nom du studio de production.	coco-caster10
ChannelEnable	integer	Indique si le canal est activé. Valeurs valides : 0 : Désactivé. 1 : Activé.	1
Delay	number	Le délai du flux. Unité : secondes. 0 : Le délai du flux est désactivé. Supérieur à 0 : Le délai du flux est activé.	0
DomainName	string	Le domaine de diffusion principal.	example.com
ProgramEffect	integer	L'indicateur d'effectivité de la liste de lecture. Valeurs valides : 0 : Non effectif. 1 : Effectif.	0
ProgramName	string	Le nom de la liste de lecture.	program_name
RecordConfig	object	La configuration d'enregistrement. Si ce paramètre est vide, la fonction d'enregistrement n'est pas activée.
OnDemand	integer	Le mode d'enregistrement à la demande. Valeurs valides : 0 : Désactivé. 1 : Basé sur un rappel HTTP. 2 : Enregistrement à la demande en analysant les paramètres d'ingestion de flux. 7 : Non enregistré par défaut.	0
OssBucket	string	L'emplacement de stockage.	liveBucket****
OssEndpoint	string	Le point de terminaison OSS de l'emplacement de stockage.	oss-cn-shanghai.aliyundoc.com
RecordFormat	object
RecordFormat	array<object>	La configuration du format d'enregistrement.
	object	Les informations sur la durée d'enregistrement.
CycleDuration	integer	La durée d'enregistrement.	3600
Format	string	Le format d'enregistrement.	M3U8
OssObjectPrefix	string	Le nom du fichier d'enregistrement.	record/{liveApp**}/{liveStream**}
SliceOssObjectPrefix	string	Le nom du segment.	record/{liveApp**}/{liveStream}/{UnixTimestamp**}
RequestId	string	L'identifiant de la requête.	97df6b7f-3490-47d2-ac50-8833e1b64597
SideOutputUrl	string	L'URL de sortie secondaire personnalisée du studio de production.	rtmp://sophon-developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201**?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5**
SideOutputUrlList	string	La liste des URL de sortie secondaire personnalisées du studio de production.	["rtmp://domain/app1/stream1","rtmp://domain/app2/stream2"]
SyncGroupsConfig	object
SyncGroup	array<object>	La configuration de stockage.
	array<object>	La configuration de stockage.
HostResourceId	string	L'identifiant de ressource du studio de production.	28768383240243****
Mode	integer	Le mode de mise en cache pour les pages statiques. Valeurs valides : 0 : Mode standard. 1 : Mode fort. 2 : Aucune mise en cache.	0
ResourceIds	object
ResourceId	array	La liste des identifiants des ressources cloud dont vous souhaitez modifier le groupe de ressources. Vous pouvez spécifier de 1 à 50 identifiants de ressources.
	string	La liste des identifiants des ressources cloud dont vous souhaitez modifier le groupe de ressources. Vous pouvez spécifier de 1 à 50 identifiants de ressources.	1
TranscodeConfig	object	La configuration de transcodage.
CasterTemplate	string	Le modèle de transcodage du studio de production. Valeurs valides : lp_ld : définition basse. lp_sd : définition standard. lp_hd : haute définition. lp_ud : ultra haute définition. lp_ld_v : définition basse portrait. lp_sd_v : définition standard portrait. lp_hd_v : haute définition portrait. lp_ud_v : ultra haute définition portrait.	lp_hd
LiveTemplateIds	object
LocationId	array	La configuration de transcodage du flux en direct.
	string	La configuration de transcodage du flux en direct. Valeurs valides : lsd : Définition standard. lld : Basse définition. lud : Très haute définition. lhd : Modèle de transcodage adaptatif haute définition. daobo-lsd : Définition standard. daobo-lld : Basse définition. daobo-lud : Très haute définition. daobo-lhd : Haute définition.	lld
CustomParams	object	La configuration personnalisée.
video	object	Paramètres vidéo.
fps	integer	Fréquence d'images vidéo.	300
bitrate	integer	Débit binaire vidéo.	300
width	integer	La largeur de la vidéo en pixels (px).	1080
height	integer	La hauteur de la vidéo en pixels (px).	720
UrgentImageId	string	L'identifiant de la ressource de la médiathèque de l'image de secours.	a089175eb5f4427684fc0715159a****
UrgentImageUrl	string	L'URL de l'image de secours.	http://learn.aliyundoc.com/AppName/image.jpg
UrgentLiveStreamUrl	string	L'URL du flux en direct de secours.	rtmp://demo.aliyundoc.com
UrgentMaterialId	string	L'identifiant de la ressource de la médiathèque de la vidéo de secours.	98646538-bcf9-4aef-bd4a-e6bb76588****
AudioMixerMode	string

Exemples

JSON format

{
  "AutoSwitchUrgentConfig": "{\"eofThres\":3}",
  "AutoSwitchUrgentOn": "true",
  "CallbackUrl": "http://learn.aliyundoc.com/callBackLive",
  "CasterId": "LIVEPRODUCER_POST-cn-0pp1czt****",
  "CasterName": "coco-caster10",
  "ChannelEnable": 1,
  "Delay": 0,
  "DomainName": "example.com",
  "ProgramEffect": 0,
  "ProgramName": "program_name",
  "RecordConfig": {
    "OnDemand": 0,
    "OssBucket": "liveBucket****",
    "OssEndpoint": "oss-cn-shanghai.aliyundoc.com",
    "RecordFormat": {
      "RecordFormat": [
        {
          "CycleDuration": 3600,
          "Format": "M3U8",
          "OssObjectPrefix": "record/{liveApp****}/{liveStream****}",
          "SliceOssObjectPrefix": "record/{liveApp****}/{liveStream****}/{UnixTimestamp****}"
        }
      ]
    }
  },
  "RequestId": "97df6b7f-3490-47d2-ac50-8833e1b64597",
  "SideOutputUrl": "rtmp://sophon-developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****",
  "SideOutputUrlList": "[\"rtmp://domain/app1/stream1\",\"rtmp://domain/app2/stream2\"]",
  "SyncGroupsConfig": {
    "SyncGroup": [
      {
        "HostResourceId": "28768383240243****",
        "Mode": 0,
        "ResourceIds": {
          "ResourceId": [
            "1"
          ]
        }
      }
    ]
  },
  "TranscodeConfig": {
    "CasterTemplate": "lp_hd",
    "LiveTemplateIds": {
      "LocationId": [
        "lld"
      ]
    },
    "CustomParams": {
      "video": {
        "fps": 300,
        "bitrate": 300,
        "width": 1080,
        "height": 720
      }
    }
  },
  "UrgentImageId": "a089175eb5f4427684fc0715159a****",
  "UrgentImageUrl": "http://learn.aliyundoc.com/AppName/image.jpg",
  "UrgentLiveStreamUrl": "rtmp://demo.aliyundoc.com",
  "UrgentMaterialId": "98646538-bcf9-4aef-bd4a-e6bb76588****",
  "AudioMixerMode": ""
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidCasterId.Malformed	%s, please check and try again later.	Le paramètre CasterId n'est pas valide. Vérifiez le paramètre et réessayez.
401	IllegalOperation	%s, please check and try again later.	L'opération n'est pas valide. Vérifiez la requête et réessayez.
500	InternalError	%s, please try again later.	Une erreur interne s'est produite. Réessayez plus tard.
404	InvalidCaster.NotFound	%s, please check and try again later.	Le studio de production n'existe pas. Vérifiez la configuration et réessayez.

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

Notes de version

Consultez Notes de version pour la liste complète.