Tous les produits
Search
Centre de documentation

:DescribeInstanceAutoRenewalAttribute

Dernière mise à jour :Aug 08, 2026

Cette opération permet de vérifier si le renouvellement automatique est activé pour une instance ApsaraDB for MongoDB.

Cette opération s'applique aux instances en abonnement.

Débogage

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

Paramètres de requête

Paramètre Type Obligatoire Exemple Description
Action String Oui DescribeInstanceAutoRenewalAttribute

L'opération à effectuer. Définissez la valeur sur DescribeInstanceAutoRenewalAttribute.

RegionId String Oui cn-hangzhou

L'ID de région de l'instance. Appelez l'opération DescribeDBInstanceAttribute pour interroger l'ID de région de l'instance.

DBInstanceId String Non dds-bpxxxxxxxx

L'ID de l'instance.

DBInstanceType String Non replicate

La catégorie de l'instance. Valeurs valides :

  • replicate : instance autonome ou ensemble de réplicas
  • sharding : instance de cluster fragmenté

Valeur par défaut : replicate.

PageSize String Non 30

Le nombre d'entrées à renvoyer par page. Valeurs valides : 30, 50 et 100.

Remarque Valeur par défaut : 30.
PageNumber String Non 1

Le numéro de la page à renvoyer. La valeur doit être un entier positif ne dépassant pas la valeur maximale du paramètre Integer. Valeur par défaut : 1.

Paramètres de réponse

Paramètre Type Exemple Description
Items Array

Détails des entrées renvoyées.

Item
AutoRenew String true

Indique si le renouvellement automatique est activé pour l'instance. Valeurs valides :

  • true : le renouvellement automatique est activé pour l'instance.
  • false : le renouvellement automatique est désactivé pour l'instance.
DBInstanceType String replicate

La catégorie de l'instance. Valeurs valides :

  • replicate : instance autonome ou ensemble de réplicas
  • sharding : instance de cluster fragmenté
DbInstanceId String dds-bpxxxxxxxx

L'ID de l'instance.

Duration String 1

La période de renouvellement automatique. Unité : mois.

Remarque
  • Ce paramètre est renvoyé uniquement lorsque la valeur du paramètre AutoRenew est true.
  • Appelez l'opération ModifyInstanceAutoRenewalAttribute pour modifier la période de renouvellement automatique.
RegionId String cn-hangzhou

L'ID de région de l'instance.

ItemsNumbers Integer 2

Le nombre total d'entrées renvoyées.

PageNumber Integer 1

Le numéro de la page renvoyée.

PageRecordCount Integer 2

Le nombre d'entrées renvoyées sur la page actuelle.

RequestId String FAB5CB3B-DB9D-473A-9DF1-F57B6B9CB949

L'ID de la requête.

Exemples

Exemples de requêtes

http(s)://mongodb.aliyuncs.com/? Action=DescribeInstanceAutoRenewalAttribute
&<Common request parameters>

Exemples de réponses réussies

XML format

<DescribeInstanceAutoRenewalAttributeResponse>
	  <Items>
		    <Item>
			      <DBInstanceType>replicate</DBInstanceType>
			      <RegionId>cn-hangzhou</RegionId>
			      <DbInstanceId>dds-bpxxxxxxxx</DbInstanceId>
			      <AutoRenew>false</AutoRenew>
		    </Item>
		    <Item>
			      <DBInstanceType>replicate</DBInstanceType>
			      <Duration>1</Duration>
			      <RegionId>cn-hangzhou</RegionId>
			      <DbInstanceId>dds-bpxxxxxxxx</DbInstanceId>
			      <AutoRenew>true</AutoRenew>
		    </Item>
	  </Items>
	  <PageNumber>1</PageNumber>
	  <RequestId>FAB5CB3B-DB9D-473A-9DF1-F57B6B9CB949</RequestId>
	  <ItemsNumbers>2</ItemsNumbers>
	  <PageRecordCount>2</PageRecordCount>
</DescribeInstanceAutoRenewalAttributeResponse>

JSON format

{
	"Items": {
		"Item": [
			{
				"DBInstanceType": "replicate",
				"RegionId": "cn-hangzhou",
				"DbInstanceId": "dds-bpxxxxxxxx",
				"AutoRenew": "false"
			},
			{
				"DBInstanceType": "replicate",
				"Duration": 1,
				"RegionId": "cn-hangzhou",
				"DbInstanceId": "dds-bpxxxxxxxx",
				"AutoRenew": "true"
			}
		]
	},
	"PageNumber": 1,
	"RequestId": "FAB5CB3B-DB9D-473A-9DF1-F57B6B9CB949",
	"ItemsNumbers": 2,
	"PageRecordCount": 2
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez le Centre d'erreurs de l'API.