API de test de charge distribuée

Cette solution de test de charge vous permet d'exposer les données des résultats de test de manière sécurisée. L'API fait office de « porte d'entrée » pour accéder aux données de test stockées dans Amazon DynamoDB. Vous pouvez également utiliser le APIs pour accéder à toutes les fonctionnalités étendues que vous intégrez à la solution.

Cette solution utilise un groupe d'utilisateurs Amazon Cognito intégré à Amazon API Gateway pour l'identification et l'autorisation. Lorsqu'un groupe d'utilisateurs est utilisé avec l'API, les clients ne sont autorisés à appeler les méthodes activées par le groupe d'utilisateurs qu'après avoir fourni un jeton d'identité valide.

Pour plus d'informations sur l'exécution de tests directement via l'API, consultez la section Signing Requests dans la documentation de référence de l'API REST Amazon API Gateway.

Les opérations suivantes sont disponibles dans l'API de la solution.

Note

Pour plus d'informations sur testScenario les paramètres et autres, reportez-vous aux scénarios et à l'exemple de charge utile dans le GitHub référentiel.

Scénarios

• GET /scénarios

• POST /scénarios

• OPTIONS/SCÉNARIOS

• OBTENEZ /scenarios/ {testId}

• POST /scenarios/ {testId}

• SUPPRIMER /scenarios/ {testId}

• OPTIONS /scénarios/ {testId}

Tâches

• GET /tâches

• OPTIONS /tâches

Régions

• GET /régions

• OPTIONS /régions

GET /scenarios

Description

L'GET /scenariosopération permet de récupérer une liste de scénarios de test.

Réponse

Name (Nom)	Description
data	Une liste de scénarios comprenant l'ID, le nom, la description, le statut et la durée d'exécution de chaque test

POST /scénarios

Description

L'POST /scenariosopération permet de créer ou de planifier un scénario de test.

Corps de la demande

Name (Nom)	Description
testName	Le nom du test
testDescription	Description du test
testTaskConfigs	Un objet qui spécifie concurrency (le nombre d'exécutions parallèles), taskCount (le nombre de tâches nécessaires pour exécuter un test) et region pour le scénario
testScenario	La définition du test, y compris la simultanéité, la durée du test, l'hôte et la méthode du test
testType	Le type de test (par exemplesimple,jmeter)
fileType	Le type de fichier de téléchargement (par exemple,none,script,zip)
scheduleDate	Date à laquelle un test doit être effectué. Fourni uniquement si vous planifiez un test (par exemple,2021-02-28)
scheduleTime	C'est le moment d'effectuer un test. Fourni uniquement si vous planifiez un test (par exemple,21:07)
scheduleStep	Étape du processus de planification. Fourni uniquement si vous planifiez un test récurrent. (Les étapes disponibles incluent create etstart)
cronvalue	La valeur cron pour personnaliser la planification récurrente. Le cas échéant, omettez ScheduleDate et ScheduleTime.
cronExpiryDate	Date requise pour que le cron expire et ne s'exécute pas indéfiniment.
recurrence	La récurrence d'un test programmé. Fourni uniquement si vous planifiez un test récurrent (par exemple dailyweekly,,biweekly, oumonthly)

Réponse

Name (Nom)	Description
testId	L'identifiant unique du test
testName	Le nom du test
status	État du test

OPTIONS/SCÉNARIOS

Description

L'OPTIONS /scenariosopération fournit une réponse à la demande avec les en-têtes de réponse CORS corrects.

Réponse

Name (Nom)	Description
testId	L'identifiant unique du test
testName	Le nom du test
status	État du test

OBTENEZ /scenarios/ {testId}

Description

L'GET /scenarios/{testId}opération permet de récupérer les détails d'un scénario de test spécifique.

Paramètre de demande

testId

• L'identifiant unique du test

  Type : String

  Obligatoire : oui

Réponse

Name (Nom)	Description
testId	L'identifiant unique du test
testName	Le nom du test
testDescription	Description du test
testType	Le type de test qui est exécuté (par exemplesimple,jmeter)
fileType	Le type de fichier chargé (par exemplenone,script,zip)
status	État du test
startTime	L'heure et la date du début du dernier test
endTime	L'heure et la date de fin du dernier test
testScenario	La définition du test, y compris la simultanéité, la durée du test, l'hôte et la méthode du test
taskCount	Le nombre de tâches nécessaires pour exécuter le test
taskIds	Une liste de tâches IDs pour exécuter des tests
results	Les résultats finaux du test
history	Une liste des résultats finaux des tests passés
errorReason	Un message d'erreur généré lorsqu'une erreur se produit
nextRun	La prochaine exécution planifiée (par exemple,2017-04-22 17:18:00)
scheduleRecurrence	La récurrence du test (par exemple,,daily, weeklybiweekly,monthly)

POST /scenarios/ {testId}

Description

L'POST /scenarios/{testId}opération permet d'annuler un scénario de test spécifique.

Paramètre de demande

testId

• L'identifiant unique du test

  Type : String

  Obligatoire : oui

Réponse

Name (Nom)	Description
status	État du test

SUPPRIMER /scenarios/ {testId}

Description

L'DELETE /scenarios/{testId}opération permet de supprimer toutes les données relatives à un scénario de test spécifique.

Paramètre de demande

testId

• L'identifiant unique du test

  Type : String

  Obligatoire : oui

Réponse

Name (Nom)	Description
status	État du test

OPTIONS /scénarios/ {testId}

Description

L'OPTIONS /scenarios/{testId}opération fournit une réponse à la demande avec les en-têtes de réponse CORS corrects.

Réponse

Name (Nom)	Description
testId	L'identifiant unique du test
testName	Le nom du test
testDescription	Description du test
testType	Le type de test qui est exécuté (par exemplesimple,jmeter)
fileType	Le type de fichier chargé (par exemplenone,script,zip)
status	État du test
startTime	L'heure et la date du début du dernier test
endTime	L'heure et la date de fin du dernier test
testScenario	La définition du test, y compris la simultanéité, la durée du test, l'hôte et la méthode du test
taskCount	Le nombre de tâches nécessaires pour exécuter le test
taskIds	Une liste de tâches IDs pour exécuter des tests
results	Les résultats finaux du test
history	Une liste des résultats finaux des tests passés
errorReason	Un message d'erreur généré lorsqu'une erreur se produit

GET /tâches

Description

L'GET /tasksopération vous permet de récupérer une liste des tâches Amazon Elastic Container Service (Amazon ECS) en cours d'exécution.

Réponse

Name (Nom)	Description
tasks	Une liste de tâches IDs pour exécuter des tests

OPTIONS /tâches

Description

L'opération OPTIONS /tasks des tâches fournit une réponse à la demande avec les en-têtes de réponse CORS corrects.

Réponse

Name (Nom)	Description
taskIds	Une liste de tâches IDs pour exécuter des tests

GET /régions

Description

L'GET /regionsopération vous permet de récupérer les informations sur les ressources régionales nécessaires pour exécuter un test dans cette région.

Réponse

Name (Nom)	Description
testId	L'identifiant de la région
ecsCloudWatchLogGroup	Le nom du groupe de CloudWatch journaux Amazon pour les tâches Amazon Fargate dans la région
region	La région dans laquelle se trouvent les ressources du tableau
subnetA	L'ID de l'un des sous-réseaux de la région
subnetB	L'ID de l'un des sous-réseaux de la région
taskCluster	Le nom du cluster AWS Fargate de la région
taskDefinition	L'ARN de la définition de tâche dans la région
taskImage	Le nom de l'image de la tâche dans la région
taskSecurityGroup	L'ID du groupe de sécurité dans la région

OPTIONS /régions

Description

L'OPTIONS /regionsopération fournit une réponse à la demande avec les en-têtes de réponse CORS corrects.

Réponse

Name (Nom)	Description
testId	L'identifiant de la région
ecsCloudWatchLogGroup	Le nom du groupe de CloudWatch journaux Amazon pour les tâches Amazon Fargate dans la région
region	La région dans laquelle se trouvent les ressources du tableau
subnetA	L'ID de l'un des sous-réseaux de la région
subnetB	L'ID de l'un des sous-réseaux de la région
taskCluster	Le nom du cluster AWS Fargate de la région
taskDefinition	L'ARN de la définition de tâche dans la région
taskImage	Le nom de l'image de la tâche dans la région
taskSecurityGroup	L'ID du groupe de sécurité dans la région