DescribeReservedInstances - - Centre de documentation Alibaba Cloud

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	DescribeReservedInstances	L'opération à effectuer. Définissez la valeur sur DescribeReservedInstances.
RegionId	String	Oui	cn-hangzhou	ID de région des instances réservées. Appelez l'opération DescribeRegions pour obtenir la liste des régions la plus récente.
PageNumber	Integer	Non	1	Numéro de page. La numérotation commence à 1. Valeur par défaut : 1.
PageSize	Integer	Non	50	Nombre d'entrées par page. Valeur maximale : 100. Valeur par défaut : 10.
Tag.N.Key	String	Non	TestKey	Clé du tag N de l'instance réservée. Valeurs valides pour N : 1 à 20. La clé ne peut pas être une chaîne vide. Elle peut comporter jusqu'à 128 caractères et ne doit pas commencer par acs: ou aliyun. Elle ne doit pas contenir http:// ou https://. Si vous spécifiez un seul tag pour interroger des ressources, le système renvoie jusqu'à 1 000 ressources associées à ce tag. Si vous spécifiez plusieurs tags, le système renvoie jusqu'à 1 000 ressources associées à tous les tags spécifiés. Pour interroger plus de 1 000 ressources associées aux tags spécifiés, appelez l'opération ListTagResources.
Tag.N.Value	String	Non	TestValue	Valeur du tag N de l'instance réservée. Valeurs valides pour N : 1 à 20. La valeur peut être une chaîne vide. Elle peut comporter jusqu'à 128 caractères et ne doit pas contenir http:// ou https://. Elle ne doit pas commencer par acs:.
ZoneId	String	Non	cn-hangzhou-z	ID de zone de l'instance réservée. Ce paramètre est requis lorsque Scope est défini sur Zone. Appelez l'opération DescribeZones pour obtenir la liste des zones la plus récente.
ReservedInstanceName	String	Non	testReservedInstanceName	Nom de l'instance réservée.
LockReason	String	Non	security	Raison du verrouillage de l'instance réservée. Valeurs valides : financial : verrouille l'instance réservée en raison d'impayés ou de l'expiration du service. security : verrouille l'instance réservée pour des raisons de sécurité.
InstanceType	String	Non	ecs.g5.large	Type d'instance de l'instance réservée. Pour plus d'informations sur les valeurs, consultez la Présentation des familles d'instances.
InstanceTypeFamily	String	Non	ecs.g5	Famille d'instances de l'instance réservée. Pour plus d'informations sur les valeurs, consultez la Présentation des familles d'instances.
Scope	String	Non	Region	Portée de l'instance réservée. Valeurs valides : Region Zone Valeur par défaut : Region.
OfferingType	String	Non	All Upfront	Mode de facturation de l'instance réservée. Valeurs valides : No Upfront Partial Upfront All Upfront
AllocationType	String	Non	Normal	Type d'allocation des instances réservées. Valeurs valides : Normal : interroge toutes les instances réservées appartenant au compte actuel. Shared : interroge les instances réservées partagées entre le compte principal actuel et les comptes liés. Valeur par défaut : Normal.
ReservedInstanceId.N	String	Non	ri-bpzhex2ulpzf53****	ID de l'instance réservée N. Valeurs valides pour N : 1 à 100.
Status.N	String	Non	Active	État de l'instance réservée N. Valeurs valides pour N : 1 à 100. Valeurs valides : Creating : l'instance réservée est en cours de création. Active : l'instance réservée est active. Expired : l'instance réservée a expiré. Updating : les propriétés de l'instance réservée sont en cours de modification.

Paramètres de réponse

Paramètre	Type	Exemple	Description
PageSize	Integer	1	Nombre d'entrées par page.
RequestId	String	E572643C-6A29-49D6-9D4E-6CFA4E063A3E	ID de la requête.
PageNumber	Integer	1	Numéro de page.
TotalCount	Integer	1	Nombre total d'instances réservées.
ReservedInstances	Array of ReservedInstance		Détails sur les instances réservées.
ReservedInstance
Status	String	Active	État de l'instance réservée.
CreationTime	String	2018-12-10T12:07Z	Date et heure de création de l'instance réservée.
ReservedInstanceName	String	riZbpzhex2ulpzf53****	Nom de l'instance réservée.
ReservedInstanceId	String	ri-bpzhex2ulpzf53****	ID de l'instance réservée.
InstanceType	String	ecs.g5.large	Type d'instance des instances à la demande qui correspondent à chaque instance réservée.
InstanceAmount	Integer	10	Nombre d'instances à la demande du même type que l'instance réservée et pouvant correspondre à celle-ci.
RegionId	String	cn-hangzhou	ID de région de l'instance réservée.
OfferingType	String	All Upfront	Mode de facturation de l'instance réservée.
StartTime	String	2018-12-10T12:00Z	Date et heure de prise d'effet des instances réservées.
Description	String	testDescription	Description de l'instance réservée.
AllocationStatus	String	allocated	État d'allocation de l'instance réservée lorsque le paramètre AllocationType est défini sur Shared. Valeurs valides : allocated : l'instance réservée est allouée à un autre compte. beAllocated : l'instance réservée est allouée par un autre compte.
ExpiredTime	String	2019-12-10T12:07Z	Date et heure d'expiration de l'instance réservée.
ResourceGroupId	String	EcsDocTest	ID du groupe de ressources.
ZoneId	String	cn-hangzhou-z	ID de la zone.
Platform	String	Linux	Type de système d'exploitation. Valeurs valides : Windows Linux
Scope	String	region	Portée de l'instance réservée.
OperationLocks	Array of OperationLock		Détails sur l'état de verrouillage des instances réservées.
OperationLock
LockReason	String	security	Raison du verrouillage de l'instance réservée.
Tags	Array of Tag		Tags de l'instance réservée.
Tag
TagValue	String	TestValue	Valeur du tag de l'instance réservée.
TagKey	String	TestKey	Clé du tag de l'instance réservée.

Exemples

Exemples de requêtes

https://ecs.aliyuncs.com/?Action=DescribeReservedInstances
&RegionId=cn-hangzhou
&Scope=Region
&<Common request parameters>

Exemples de réponses réussies

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeReservedInstancesResponse>
    <ReservedInstances>
        <ReservedInstance>
            <CreationTime>2018-12-10T12:07Z</CreationTime>
            <ExpiredTime>2019-12-10T16:00Z</ExpiredTime>
            <InstanceAmount>1</InstanceAmount>
            <ReservedInstanceId>ri-0xzhex2ulpzf53****</ReservedInstanceId>
            <InstanceType>ecs.g5.large</InstanceType>
            <OfferingType>All Upfront</OfferingType>
            <RegionId>cn-hangzhou-test-307</RegionId>
            <ReservedInstanceName>riZ0xzhex2ulpzf53****</ReservedInstanceName>
            <Scope>region</Scope>
            <StartTime>2018-12-10T12:00Z</StartTime>
            <Status>Active</Status>
            <Tags>
                <Tag>
                    <TagKey>TestKey</TagKey>
                    <TagValue>TestValue</TagValue>
                </Tag>
            </Tags>
        </ReservedInstance>
    </ReservedInstances>
    <RequestId>E572643C-6A29-49D6-9D4E-6CFA4E063A3E</RequestId>
    <PageNumber>1</PageNumber>
    <PageSize>50</PageSize>
    <Total>1</Total>
</DescribeReservedInstancesResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "ReservedInstances" : {
    "ReservedInstance" : [ {
      "CreationTime" : "2018-12-10T12:07Z",
      "ExpiredTime" : "2019-12-10T16:00Z",
      "InstanceAmount" : 1,
      "ReservedInstanceId" : "ri-0xzhex2ulpzf53****",
      "InstanceType" : "ecs.g5.large",
      "OfferingType" : "All Upfront",
      "RegionId" : "cn-hangzhou-test-307",
      "ReservedInstanceName" : "riZ0xzhex2ulpzf53****",
      "Scope" : "region",
      "StartTime" : "2018-12-10T12:00Z",
      "Status" : "Active",
      "Tags" : {
        "Tag" : [ {
          "TagKey" : "TestKey",
          "TagValue" : "TestValue"
        } ]
      }
    } ]
  },
  "RequestId" : "E572643C-6A29-49D6-9D4E-6CFA4E063A3E",
  "PageNumber" : 1,
  "PageSize" : 50,
  "Total" : 1
}

Codes d'erreur

Code d'état HTTP

Code d'erreur

Message d'erreur

Description

400

MissingParamter.RegionId

The regionId should not be null.

RegionId est requis.

400

InvalidRegion.NotFound

The specified parameter RegionId is not valid.

Valeur RegionId non valide.

400

InvalidZone.NotFound

The specified parameter ZoneId is not valid.

Valeur ZoneId non valide.

400

InvalidEndTime.ValueNotSupported

The specified endTime is out of the permitted range.

Valeur EndTime non valide.

400

InvalidAllocationType.ValueNotSupported

The specified AllocationType is not supported.

Valeur AllocationType non valide.

404

InvalidRegionId.NotFound

The specified RegionId does not exist in our records.

La valeur RegionId est introuvable. Vérifiez si le service est disponible dans la région spécifiée.

Pour obtenir la liste des codes d'erreur, consultez les Codes d'erreur de service.