DescribeInstanceMaintenanceAttributes - Elastic Compute Service

Consulte les attributs de maintenance d'une instance.

Description de l'opération

Cette opération permet d'interroger la stratégie de maintenance spécifiée d'une instance, qui comprend les attributs de maintenance suivants :

Fenêtre de maintenance : la période que vous spécifiez pour la maintenance.
Action de maintenance : l'action que vous spécifiez en réponse à l'arrêt de l'instance.

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.

ecs:DescribeInstanceMaintenanceAttributes

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région de l'instance. Vous pouvez appeler l'opération DescribeRegions pour consulter la liste des régions la plus récente.	cn-hangzhou
PageNumber	integer	Non	Le numéro de page.\n\nLes pages commencent à la page 1.\n\nValeur par défaut : 1.	1
PageSize	integer	Non	Le nombre d'entrées par page. Valeurs valides : 1 à 100.\n\nValeur par défaut : 10.	10
InstanceId	array	Non	Les identifiants des instances. Vous pouvez spécifier jusqu'à 100 identifiants d'instances.	i-bp67acfmxazb4p****
	string	Non	L'identifiant de l'instance.	i-bp67acfmxazb4p****

Éléments de réponse

Élément	Type	Description	Exemple
	object
PageSize	integer	Le nombre d'entrées par page.	10
RequestId	string	L'identifiant de la requête.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	Le numéro de page.	1
TotalCount	integer	Le nombre total d'attributs de maintenance renvoyés.	100
MaintenanceAttributes	object
MaintenanceAttribute	array<object>	Les attributs de maintenance.
	array<object>
NotifyOnMaintenance	boolean	Indicates whether an event notification is sent before instance downtime maintenance.	false
InstanceId	string	The instance ID.	i-bp67acfmxazb4p****
MaintenanceWindows	object
MaintenanceWindow	array<object>	The list of O&M window instances.
	object
EndTime	string	The end time of the maintenance time window.	18:00:00
StartTime	string	The start time of the maintenance time window.	02:00:00
ActionOnMaintenance	object	The maintenance action attribute of the instance.
DefaultValue	string	The default value of the maintenance action.	AutoRecover
Value	string	The current effective value of the maintenance action. Valid values: Stop: The instance is stopped (down). AutoRecover: The instance is automatically recovered. AutoRedeploy: The instance is migrated when it is down, which may cause damage to data cloud disks.	Stop
SupportedValues	object
SupportedValue	array	The list of supported maintenance action values, returned as an array.
	string	The maintenance action value.	Stop

Exemples

JSON format

{
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 100,
  "MaintenanceAttributes": {
    "MaintenanceAttribute": [
      {
        "NotifyOnMaintenance": false,
        "InstanceId": "i-bp67acfmxazb4p****",
        "MaintenanceWindows": {
          "MaintenanceWindow": [
            {
              "EndTime": "18:00:00",
              "StartTime": "02:00:00"
            }
          ]
        },
        "ActionOnMaintenance": {
          "DefaultValue": "AutoRecover",
          "Value": "Stop",
          "SupportedValues": {
            "SupportedValue": [
              "Stop"
            ]
          }
        }
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	MissingParameter	%s	A parameter is not specified.
403	InvalidParameter	%s
403	InstanceIdLimitExceeded	%s	More than 100 instance IDs are specified.
403	OperationDenied.NotInWhiteList	%s	You are not authorized to perform this operation. Try again when you are authorized.
404	InvalidInstanceId.NotFound	The specified InstanceId does not exist.	The specified instanceId is invalid.

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

Notes de version

Consultez Notes de version pour la liste complète.