Normes API et SDK multilingues prédéfinis
L'OpenAPI de ce produit (sae/2019-05-06) utilise le style de signature ROA. Des SDK sont disponibles pour les langages de programmation courants. Les développeurs peuvent télécharger le SDK pour appeler directement l'OpenAPI de ce produit, sans se soucier des détails techniques. Si le SDK existant ne répond pas à vos besoins, utilisez le mécanisme de signature pour une intégration par auto-signature. L'auto-signature étant particulièrement complexe, comptez environ 5 jours ouvrables. Nous vous recommandons donc de rejoindre notre groupe d'assistance DingTalk (147535001692) pour bénéficier d'un accompagnement expert lors de l'intégration.
Avant d'utiliser l'API, préparez votre compte d'identité et votre clé d'accès (AccessKey) afin d'accéder efficacement à l'API via des outils clients (tels que SDK et CLI). Pour plus d'informations, consultez Obtenir un AccessKey.
Scénarios de signature personnalisée
Si votre scénario métier présente des exigences particulières et nécessite une intégration par auto-signature, consultez d'abord notre équipe de support technique (groupe d'assistance DingTalk : 147535001692) pour obtenir un accompagnement professionnel et garantir une intégration efficace.
Préparation du compte et de la sécurité
Les comptes Alibaba Cloud disposent de permissions administratives complètes sur l'ensemble des ressources. En cas de compromission d'un AccessKey, toutes les ressources associées sont exposées à un risque d'accès non autorisé. Pour garantir la sécurité, créez un utilisateur RAM disposant uniquement de permissions d'accès API et configurez son AccessKey. Appliquez ensuite des politiques RAM selon le principe du moindre privilège (PoLP). N'utilisez le compte Alibaba Cloud que dans les scénarios spécifiques où ses permissions sont explicitement requises.
Activation du service
|
API |
Titre |
Description |
| OpenSaeService | OpenSaeService. | Active Serverless App Engine (SAE) gratuitement. |
Gestion générale des services
|
API |
Titre |
Description |
| Espaces de noms et VPC | Espaces de noms et VPC | |
| CreateIngress | CreateIngress. | Crée une règle de routage. |
| DeleteIngress | DeleteIngress. | Supprime une instance d'ingress. |
| UpdateNamespaceVpc | UpdateNamespaceVpc | Met à jour le VPC associé à un espace de noms. |
| UpdateApplicationVswitches | UpdateApplicationVswitches. | Met à jour la configuration du vSwitch pour une application. |
| UpdateIngress | UpdateIngress | Met à jour la configuration d'une instance Ingress. |
| DescribeNamespaces | DescribeNamespaces. | Consulte la liste des espaces de noms. |
| DescribeNamespaceList | DescribeNamespaceList. | Consulte la liste des espaces de noms. |
| ListAppEvents | ListAppEvents | Répertorie les événements d'application en appelant l'API ListAppEvents. |
| ListNamespaceChangeOrders | ListNamespaceChangeOrders. | Répertorie les ordres de modification dans un espace de noms. |
| DescribeNamespaceResources | DescribeNamespaceResources. | Consulte les ressources d'un espace de noms. |
| DescribeIngress | DescribeIngress. | Consulte les détails d'un Ingress. |
| ListIngresses | ListIngresses. | Obtient la liste des Ingress. |
| DescribePipeline | DescribePipeline. | Consulte les informations du lot. |
| Surveillance du Top N de la page de vue d'ensemble | Surveillance du Top N de la page de vue d'ensemble | |
| GetArmsTopNMetric | GetArmsTopNMetric. | Consulte les N premières applications dans la surveillance des applications. |
| GetChangeOrderMetric | GetChangeOrderMetric. | Récupère les N premières applications présentant des ordres de modification anormaux en appelant l'API GetChangeOrderMetric. |
| GetScaleAppMetric | GetScaleAppMetric. | Consulte les N principales applications dans lesquelles la mise à l'échelle automatique prend effet. |
| GetWarningEventMetric | GetWarningEventMetric. | Consulte les N principales applications dans lesquelles des événements d'avertissement se produisent. |
Applications de microservices
|
API |
Titre |
Description |
| Cycle de vie des applications | Cycle de vie des applications | |
| StopApplication | StopApplication | Arrête une application. |
| StartApplication | StartApplication. | Démarre une application. |
| ReduceApplicationCapacityByInstanceIds | ReduceApplicationCapacityByInstanceIds. | Réduit la capacité d'une application en fonction des identifiants d'instance. |
| UpdateApplicationDescription | UpdateApplicationDescription. | Met à jour la description d'une application. |
| UpdateAppSecurityGroup | UpdateAppSecurityGroup. | Met à jour un groupe de sécurité d'application. |
| DescribeApplicationStatus | DescribeApplicationStatus. | Obtient l'état d'une application. |
| ListChangeOrders | ListChangeOrders. | Répertorie les ordres de modification. |
| DescribeChangeOrder | DescribeChangeOrder. | Obtient les informations relatives à un ordre de modification. |
| DescribeInstanceSpecifications | DescribeInstanceSpecifications. | Obtient la liste des spécifications d'instances d'application disponibles. |
| DeployApplication | Déploiement d'une application. | Déploie une application. |
| RescaleApplicationVertically | Modification des spécifications d'instance de l'application. | Modifie les spécifications d'instance d'une application. |
| ConfirmPipelineBatch | Confirmation du lot du pipeline. | Confirme le démarrage du lot suivant. |
| AbortAndRollbackChangeOrder | AbortAndRollbackChangeOrder. | Interrompt un ordre de modification et restaure l'application correspondante. |
| RestartApplication | RestartApplication. | Redémarre une application. |
| AbortChangeOrder | AbortChangeOrder. | Interrompt un ordre de modification. |
| BatchStopApplications | BatchStopApplications. | Arrête des applications par lots. |
| BatchStartApplications | BatchStartApplications. | Démarre plusieurs applications à la fois. |
| DowngradeApplicationApmService | DowngradeApplicationApmService. | Désactive la supervision de l'édition avancée d'ARMS. |
| UpgradeApplicationApmService | UpgradeApplicationApmService. | Active la fonctionnalité de surveillance avancée du service de surveillance en temps réel des applications (ARMS). |
| Liste des microservices | Liste des microservices | |
| ListConsumedServices | ListConsumedServices. | Obtient la liste des microservices abonnés. |
| ListPublishedServices | ListPublishedServices. | Consulte la liste des microservices publiés. |
| ListAppServices | ListAppServices. | Répertorie les microservices. |
| Gestion des éléments de configuration | Gestion des éléments de configuration | |
| CreateConfigMap | CreateConfigMap. | Crée un ConfigMap dans un espace de noms. |
| DeleteConfigMap | DeleteConfigMap. | Supprime une instance ConfigMap. |
| UpdateConfigMap | UpdateConfigMap. | Met à jour une instance ConfigMap. |
| DescribeConfigMap | DescribeConfigMap. | Consulte les détails d'une instance ConfigMap. |
| ListNamespacedConfigMaps | ListNamespacedConfigMaps. | Répertorie les instances ConfigMap dans un espace de noms. |
| Routage par balises canari | Routage par balises canari | |
| CreateGreyTagRoute | CreateGreyTagRoute. | Crée une règle de déploiement canari pour une application Spring Cloud ou Dubbo. |
| DeleteGreyTagRoute | DeleteGreyTagRoute. | Supprime une route de balise grise par l'identifiant de règle spécifié. |
| UpdateGreyTagRoute | Mise à jour d'une route de balise grise. | Met à jour une route de balise grise. |
| DescribeGreyTagRoute | DescribeGreyTagRoute. | Obtient une règle de déploiement canari par identifiant de règle. |
| ListGreyTagRoute | ListGreyTagRoute. | Consulte les détails d'une règle de mise en gris en fonction d'un identifiant d'application. |
| Déploiement canari de bout en bout | Déploiement canari de bout en bout | |
| CreateOrUpdateSwimmingLaneGroup | CreateOrUpdateSwimmingLaneGroup. | Crée ou met à jour un groupe de couloirs. |
| CreateOrUpdateSwimmingLane | CreateOrUpdateSwimmingLane. | Crée ou met à jour une swimlane. |
| ListApplicationsForSwimmingLane | ListApplicationsForSwimmingLane. | Obtient la liste des applications pour les déploiements canari à lien complet. |
| ListSwimmingLaneGatewayRoutes | ListSwimmingLaneGatewayRoutes. | Répertorie les routes de passerelle pouvant être associées à une swimlane. |
| ListSwimmingLaneGroupTags | ListSwimmingLaneGroupTags. | Répertorie toutes les balises de voie de natation. |
| DescribeSwimmingLane | DescribeSwimmingLane. | Obtient les détails d'une swimlane. |
| ListAllSwimmingLanes | ListAllSwimmingLanes. | Répertorie toutes les swimlanes. |
| ListAllSwimmingLaneGroups | ListAllSwimmingLaneGroups. | Renvoie la liste de tous les groupes de couloirs de nage. |
| DeleteSwimmingLaneGroup | DeleteSwimmingLaneGroup. | Supprime un groupe de couloirs de nage. |
| UpdateSwimmingLaneEnableAttribute | UpdateSwimmingLaneEnableAttribute. | Met à jour l'état d'activation d'une swimlane. |
| Requête d'informations sur l'application | Requête d'informations sur l'application | |
| DescribeApplicationConfig | Informations de configuration de l'application. | Obtient les informations de configuration d'une application. |
| DescribeInstanceLog | DescribeInstanceLog. | Obtient le journal d'une instance. |
| DescribeComponents | DescribeComponents. | Appelle l'API DescribeComponents pour récupérer les versions des composants requises pour créer un déploiement d'application. |
| DescribeEdasContainers | DescribeEdasContainers. | Obtient les composants du conteneur de microservices pour une application. |
| DescribeApplicationImage | DescribeApplicationImage. | Obtient les informations relatives à une image d'application. |
| DescribeApplicationInstances | DescribeApplicationInstances. | Obtient la liste des instances d'application. |
| DescribeApplicationGroups | DescribeApplicationGroups. | Récupère les groupes d'instances d'application à l'aide de DescribeApplicationGroups. |
| QueryResourceStatics | QueryResourceStatics. | Obtient l'utilisation des ressources d'une application. |
| ListLogConfigs | ListLogConfigs. | Renvoie une liste des journaux d'application. |
| RestartInstances | RestartInstances. | Redémarre une ou plusieurs instances dans une application. |
| GetAvailabilityMetric | GetAvailabilityMetric. | Consulte les N premières applications comportant des instances anormales. Les applications sont triées par nombre total d'instances anormales. |
| DescribeAppServiceDetail | DescribeAppServiceDetail. | Décrit les détails des métadonnées d'un service d'application. |
| ListAppServicesPage | ListAppServicesPage. | Appelle ListAppServicesPage pour obtenir la liste des services d'application. |
| Gestion du SLB | Gestion du SLB | |
| DescribeApplicationNlbs | DescribeApplicationNlbs. | Consulte la configuration NLB de l'application. |
| BindNlb | BindNlb | Associe une instance Network Load Balancer (NLB) à une application. |
| DescribeApplicationSlbs | DescribeApplicationSlbs. | Consulte les configurations des instances Server Load Balancer (SLB) pour une application. |
| BindSlb | BindSlb. | Associe une instance Server Load Balancer (SLB) à l'application. |
| UnbindSlb | UnbindSlb | Dissocie une instance SLB publique ou privée d'une application. |
| UnbindNlb | UnbindNlb. | Dissocie un écouteur NLB d'une application. |
| Règles de mise à l'échelle des applications | Règles de mise à l'échelle des applications | |
| CreateApplicationScalingRule | CreateApplicationScalingRule. | Crée une stratégie de mise à l'échelle automatique d'application. |
| DeleteApplicationScalingRule | DeleteApplicationScalingRule. | Supprime une stratégie Auto Scaling pour une application. |
| DisableApplicationScalingRule | DisableApplicationScalingRule. | Désactive une stratégie Auto Scaling pour une application. |
| EnableApplicationScalingRule | EnableApplicationScalingRule | Active une stratégie de mise à l'échelle automatique pour une application. |
| UpdateApplicationScalingRule | UpdateApplicationScalingRule. | Met à jour la stratégie de mise à l'échelle automatique de l'application. |
| DescribeApplicationScalingRule | DescribeApplicationScalingRule. | Décrit une stratégie de mise à l'échelle automatique pour une application. |
| DescribeApplicationScalingRules | DescribeApplicationScalingRules. | Décrit les stratégies de mise à l'échelle automatique d'une application. |
Tâches
|
API |
Titre |
Description |
| DeleteHistoryJob | DeleteHistoryJob. | Supprime une tâche. |
| DescribeJobStatus | DescribeJobStatus. | Consulte l'état d'une tâche. |
| DescribeJob | DescribeJob. | Appelle l'API DescribeJob pour récupérer la configuration du modèle de tâche. |
| ExecJob | ExecJob. | Exécute une tâche. |
| SuspendJob | SuspendJob. | Suspend un ou plusieurs travaux. |
| DescribeJobHistory | DescribeJobHistory. | Consulte les informations sur les tâches. |
Autres
|
API |
Titre |
Description |
| DescribeConfigurationPrice | DescribeConfigurationPrice. | Consulte le prix d'une configuration. |
| GetWebshellToken | GetWebshellToken. | Obtient le jeton utilisé pour se connecter à distance au Webshell d'une instance. |
| UpdateAppMode | UpdateAppMode. | Met à jour le mode inactif d'une application. |
| QueryArmsEnable | QueryArmsEnable. | Vérifie si la surveillance ARMS est activée pour une application spécifiée. |
| DescribeApplicationMseService | DescribeApplicationMseService. | Consulte les informations de l'application de gouvernance des microservices MSE associée. |
| BatchRestartApplications | BatchRestartApplications. | Redémarre les applications par lots. |
| UpdateNamespaceSlsConfigs | UpdateNamespaceSlsConfigs. | Met à jour la configuration SLS au niveau de l'espace de noms. |
| DisableArms | DisableArms | Désactive la surveillance ARMS. |
| ResumeTraffic | ResumeTraffic. | Rétablit le trafic sur une instance provenant de Classic Load Balancer (CLB), Network Load Balancer (NLB), du routage de passerelle CLB, du routage de passerelle Application Load Balancer (ALB) et de Kubernetes Service. |
| SuspendTraffic | SuspendTraffic. | Interrompt le routage du trafic depuis l'accès aux applications Classic Load Balancer (CLB), l'accès aux applications Network Load Balancer (NLB), les routes de passerelle CLB, les routes de passerelle Application Load Balancer (ALB) ou les services Kubernetes (K8s) vers les instances spécifiées. |
Others
|
API |
Titre |
Description |
| CreateApplication | Créer une application SAE. | Crée une application. |
| CreateJob | CreateJob. | Crée un modèle de tâche. |
| CreateNamespace | CreateNamespace. | Crée un espace de noms. |
| CreateSecret | CreateSecret. | Crée un Secret dans un espace de noms. |
| DeleteApplication | DeleteApplication | Supprime une application. |
| DeleteInstances | DeleteInstances. | Supprime une ou plusieurs instances d'application. |
| DeleteJob | DeleteJob. | Supprime un modèle de tâche. |
| DeleteNamespace | DeleteNamespace. | Supprime un espace de noms. |
| DeleteSecret | DeleteSecret. | Supprime un secret. |
| DescribeNamespace | DescribeNamespace. | Consulte les détails d'un espace de noms. |
| DescribeRegions | DescribeRegions. | Consulte les régions disponibles. |
| DescribeSecret | DescribeSecret. | Consulte les détails d'un secret. |
| GetApplication | GetApplication. | Obtient les informations de base sur une application. |
| ListApplications | Liste des applications. | Obtient la liste des applications. |
| ListAppVersions | ListAppVersions. | Répertorie les versions historiques d'une application. |
| ListJobs | ListJobs. | Obtient la liste des modèles de tâche. |
| ListSecrets | ListSecrets. | Répertorie les secrets dans un espace de noms. |
| ListTagResources | ListTagResources. | Répertorie les balises associées à vos applications. |
| RescaleApplication | RescaleApplication. | Redimensionne une application. |
| RollbackApplication | RollbackApplication. | Restaure une application. |
| TagResources | TagResources. | Ajoute une ou plusieurs balises aux ressources spécifiées. |
| UntagResources | UntagResources. | Supprime une ou plusieurs balises des ressources spécifiées. |
| UpdateJob | UpdateJob. | Met à jour un modèle de tâche. |
| UpdateNamespace | UpdateNamespace. | Met à jour les informations d'un espace de noms. |
| UpdateSecret | UpdateSecret. | Met à jour une instance Secret. |