Remote Rendering - List Sessions
Obtient une liste de toutes les sessions de rendu.
GET {endpoint}/accounts/{account_id}/sessions?api-version=2021-01-01
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
account_id
|
path | True |
string uuid |
ID de compte Azure Remote Rendering. |
endpoint
|
path | True |
string |
Point de terminaison à utiliser, par exemple https://remoterendering.eastus.mixedreality.azure.com. Vous trouverez une liste à l’adresse https://docs.microsoft.com/azure/remote-rendering/reference/regions. |
api-version
|
query | True |
string |
Version de l’API à utiliser avec la requête HTTP. |
En-tête de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
Authorization | True |
string |
Jeton du porteur retourné par le service de jeton sécurisé Mixed Reality. Pour plus d'informations, consultez https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
OK. Retourne la liste des sessions qui sont à l’état « Démarrage » ou « Prêt ». |
|
401 Unauthorized |
Non autorisé. Autorisation manquante ou non valide. Headers
|
|
403 Forbidden |
Interdit. Autorisation insuffisante pour une ressource donnée. Headers MS-CV: string |
|
500 Internal Server Error |
Erreur interne. Le serveur a rencontré une erreur interne. La nouvelle tentative de la demande peut produire des résultats réussis. Headers MS-CV: string |
|
Other Status Codes |
Trop de demandes. La limite de débit a été dépassée. Réessayez la demande après la durée indiquée dans l’en-tête Retry-After. Headers
|
Sécurité
Authorization
Jeton du porteur retourné par le service de jeton sécurisé Mixed Reality. Pour plus d'informations, consultez https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.
Type:
apiKey
In:
header
Exemples
List sessions
Sample Request
GET https://remoterendering.eastus.mixedreality.azure.com/accounts/30ea64bd-100f-4bf0-adc9-29fa45d4880c/sessions?api-version=2021-01-01
Sample Response
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
"sessions": [
{
"id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28",
"creationTime": "2020-11-11T11:11:11.111Z",
"arrInspectorPort": 50052,
"handshakePort": 50051,
"elapsedTimeMinutes": 59,
"hostname": "d4cefb7b-10b9-4631-934d-67445ffa9126.remoterenderingvm.westus2.mixedreality.azure.com",
"maxLeaseTimeMinutes": 60,
"size": "Standard",
"status": "Stopped",
"error": null,
"teraflops": 10.6
},
{
"id": "contoso-session-03c200ce-faf8-4238-8db9-872ac9dd501d",
"creationTime": "2021-01-01T11:11:11.111Z",
"arrInspectorPort": 50053,
"handshakePort": 50052,
"elapsedTimeMinutes": 12,
"hostname": "615854b8-1748-4f2e-9522-bf8523d7299c.remoterenderingvm.westus2.mixedreality.azure.com",
"maxLeaseTimeMinutes": 72,
"size": "Standard",
"status": "Ready",
"error": null,
"teraflops": 10.6
}
]
}
WWW-Authenticate: Bearer error="invalid_token"
MS-CV: dKEFmka2kkSlDmp/af+sOw
MS-CV: dKEFmka2kkSlDmp/af+sOw
Retry-After: 15
MS-CV: dKEFmka2kkSlDmp/af+sOw
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
"error": {
"code": "InternalServerError",
"message": "An internal server error occurred."
}
}
Définitions
Nom | Description |
---|---|
error |
Objet d’erreur contenant les détails de la raison de l’échec de la demande. |
error_response |
Réponse d’erreur contenant des détails sur la raison de l’échec de la demande. |
session_properties |
Propriétés d’une session de rendu. |
session_size |
Taille du serveur utilisé pour la session de rendu. La taille a un impact sur le nombre de polygones que le serveur peut afficher. Consultez https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes pour plus d'informations. |
session_status |
Status de la session de rendu. Les états de terminal sont « Erreur », « Expiré » et « Arrêté ». |
sessions_list |
Résultat d’une demande de sessions de liste. |
error
Objet d’erreur contenant les détails de la raison de l’échec de la demande.
Nom | Type | Description |
---|---|---|
code |
string |
Code d’erreur. |
details |
error[] |
Tableau de détails sur les erreurs spécifiques qui ont conduit à cette erreur signalée. |
innerError |
Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur. |
|
message |
string |
Représentation lisible de l’erreur. |
target |
string |
Cible de l’erreur particulière (par exemple, le nom de la propriété dans l’erreur). |
error_response
Réponse d’erreur contenant des détails sur la raison de l’échec de la demande.
Nom | Type | Description |
---|---|---|
error |
Objet d’erreur contenant les détails de la raison de l’échec de la demande. |
session_properties
Propriétés d’une session de rendu.
Nom | Type | Description |
---|---|---|
arrInspectorPort |
integer |
Port TCP sur lequel l’outil Azure Remote Rendering Inspector est hébergé. |
creationTime |
string |
Heure de création de la session de rendu. Date et heure au format ISO 8601. |
elapsedTimeMinutes |
integer |
Durée en minutes pendant laquelle la session est ou était à l’état « Prêt ». Le temps est arrondi à une minute entière. |
error |
Objet d’erreur contenant des détails sur l’échec de démarrage de la session de rendu. |
|
handshakePort |
integer |
Port TCP utilisé pour l’établissement d’une liaison lors de l’établissement d’une connexion. |
hostname |
string |
Nom d’hôte sous lequel la session de rendu est accessible. |
id |
string |
ID de la session fournie lors de la création de la session. |
maxLeaseTimeMinutes |
integer |
Durée en minutes de l’exécution de la session après avoir atteint l’état « Prêt ». |
size |
Taille du serveur utilisé pour la session de rendu. La taille a un impact sur le nombre de polygones que le serveur peut afficher. Consultez https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes pour plus d'informations. |
|
status |
Status de la session de rendu. Les états de terminal sont « Erreur », « Expiré » et « Arrêté ». |
|
teraflops |
number |
Puissance de calcul du GPU de session de rendu mesurée en téraflops. |
session_size
Taille du serveur utilisé pour la session de rendu. La taille a un impact sur le nombre de polygones que le serveur peut afficher. Consultez https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes pour plus d'informations.
Nom | Type | Description |
---|---|---|
Premium |
string |
Taille de session de rendu Premium. |
Standard |
string |
Taille de session de rendu standard. |
session_status
Status de la session de rendu. Les états de terminal sont « Erreur », « Expiré » et « Arrêté ».
Nom | Type | Description |
---|---|---|
Error |
string |
La session de rendu a rencontré une erreur et est inutilisable. Il s’agit d’un état terminal. |
Expired |
string |
La session de rendu passe à l’état « Expiré » lorsqu’elle a été à l’état « Prêt » plus longtemps que son bail. Il s’agit d’un état terminal. |
Ready |
string |
La session de rendu est prête pour les connexions entrantes. |
Starting |
string |
La session de rendu démarre, mais n’accepte pas encore les connexions entrantes. |
Stopped |
string |
La session de rendu a été arrêtée avec l’opération « Arrêter la session ». Il s’agit d’un état terminal. |
sessions_list
Résultat d’une demande de sessions de liste.
Nom | Type | Description |
---|---|---|
@nextLink |
string |
Si d’autres sessions de rendu sont disponibles, ce champ contient une URL où le lot suivant de sessions peut être demandé. Cette URL nécessite la même authentification que tous les appels à l’API Azure Remote Rendering. |
sessions |
Liste des sessions de rendu. N’inclut pas les sessions à l’état « Arrêté ». |