Modifier les spécifications d'une instance - - Centre de documentation Alibaba Cloud

Appelez l'opération ModifyDBInstanceSpec pour modifier le type d'instance ou la capacité de stockage d'une instance. Cette opération est prise en charge pour les instances principales et les instances en lecture seule. Elle n'est pas prise en charge pour les instances de reprise après sinistre ni pour les instances temporaires.

Avant d'appeler cette opération, vérifiez que les conditions suivantes sont remplies :

L'instance est dans l'état Running.
Aucune tâche de sauvegarde n'est en cours sur l'instance.
La requête spécifie au moins l'un des paramètres DBInstanceClass ou DBInstanceStorage.
Pour réduire la capacité de stockage, la nouvelle capacité spécifiée doit être supérieure ou égale à 1,1 fois la capacité utilisée.
L'instance est une instance principale ou une instance en lecture seule.

Remarque

Pour mettre à niveau l'édition RDS de l'instance, sélectionnez simplement un type d'instance compatible avec la nouvelle édition. Par exemple, pour passer de l'édition RDS Basic Edition à l'édition RDS High-availability Edition, choisissez un type d'instance qui prend en charge l'édition RDS High-availability Edition.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	ModifyDBInstanceSpec	Opération à effectuer. Définissez la valeur sur ModifyDBInstanceSpec.
DBInstanceId	String	Yes	rm-uf6wjk5*******	ID de l'instance.
DBInstanceClass	String	No	rds.mys2.small	Nouveau type d'instance. Pour plus d'informations, consultez Types d'instances ApsaraDB RDS principales. Appelez l'opération DescribeAvailableClasses pour consulter les types d'instances disponibles dans une région. Remarque Spécifiez au moins l'un des paramètres DBInstanceClass ou DBInstanceStorage. Appelez l'opération DescribeDBInstanceAttribute pour consulter le type d'instance actuellement utilisé.
DBInstanceStorage	Integer	No	20	Nouvelle capacité de stockage de l'instance. Unité : Go. Augmentez la capacité de stockage par paliers de 5 Go. Pour plus d'informations, consultez Types d'instances ApsaraDB RDS principales. Appelez l'opération DescribeAvailableClasses pour consulter la plage de capacités de stockage prises en charge par un type d'instance. Remarque Spécifiez au moins l'un des paramètres DBInstanceStorage ou DBInstanceClass. Si l'instance exécute MySQL sur l'édition RDS High-availability Edition et utilise des SSD locaux, vous pouvez réduire la capacité de stockage par paliers de 5 Go. Appelez l'opération DescribeDBInstanceAttribute pour consulter la capacité de stockage actuelle de l'instance.
PayType	String	Yes	Postpaid	Mode de facturation de l'instance. Valeurs possibles : Postpaid : paiement à l'utilisation Prepaid : abonnement
EffectiveTime	String	No	MaintainTime	Moment où la modification doit prendre effet. Valeurs possibles : Immediate : la modification prend effet immédiatement. MaintainTime : la modification prend effet pendant la fenêtre de maintenance spécifiée. Pour plus d'informations, consultez ModifyDBInstanceMaintainTime. Remarque Valeur par défaut : Immediate.
EngineVersion	String	No	5,6	Version du moteur de base de données de l'instance. Valeurs valides lorsque le paramètre Engine est défini sur MySQL : 5,5, 5,6, 5,7 et 8,0 Valeurs valides lorsque le paramètre Engine est défini sur SQLServer : 2008r2, 08r2_ent_ha, 2012, 2012_ent_ha, 2012_std_ha, 2012_web, 2014_std_ha, 2016_ent_ha, 2016_std_ha, 2016_web, 2017_std_ha, 2017_ent, 2019_std_ha et 2019_ent Valeurs valides lorsque le paramètre Engine est défini sur PostgreSQL : 10,0, 11,0, 12,0, 13,0, 14,0 et 15,0 Valeurs valides lorsque le paramètre Engine est défini sur MariaDB : 10,3
DBInstanceStorageType	String	No	local_ssd	Type de stockage de l'instance. Valeurs possibles : local_ssd : SSD local. cloud_ssd : SSD standard. Ce type de stockage n'est pas recommandé et n'est pas disponible dans certaines régions Alibaba Cloud. cloud_essd : disque ESSD (enhanced SSD) de niveau de performance 1 (PL1). cloud_essd2 : disque ESSD de niveau PL2. cloud_essd3 : disque ESSD de niveau PL3. Pour modifier le type de stockage, tenez compte des éléments suivants : Si l'instance exécute PostgreSQL, vous pouvez mettre à niveau son type de stockage de SSD standard vers ESSD. En revanche, vous ne pouvez pas rétrograder le type de stockage d'ESSD vers SSD standard. Les disques ESSD offrent les niveaux de performance (PL) suivants : PL1, PL2 et PL3. Vous pouvez effectuer une mise à niveau ou une rétrogradation entre ces niveaux. Pour plus d'informations, consultez Éléments de configuration.
Direction	String	No	Up	Type de modification à appliquer à l'instance. Valeurs possibles : Up : met à niveau une instance d'abonnement, ou met à niveau ou rétrograde une instance de paiement à l'utilisation. Down : rétrograde une instance d'abonnement. TempUpgrade : effectue des modifications élastiques des spécifications sur une instance d'abonnement. Cette valeur est requise pour les modifications élastiques des spécifications. Remarque Valeur par défaut : Up. Si vous spécifiez uniquement le paramètre DBInstanceStorageType, laissez le paramètre Direction vide. Par exemple, si vous souhaitez uniquement modifier le type de stockage de l'instance de SSD standard vers ESSD, ne spécifiez pas le paramètre Direction.
SourceBiz	String	No	N/A	Paramètre obsolète.
DedicatedHostGroupId	String	No	dhg-7a9********	ID du cluster dédié auquel appartient l'instance.
ZoneId	String	No	cn-hangzhou-b	ID de la zone de l'instance.
SwitchTime	String	No	2019-07-10T13:15:12Z	Heure à laquelle vous souhaitez modifier les spécifications. Nous vous recommandons d'effectuer cette opération pendant les heures creuses. Spécifiez l'heure au format ISO 8601 yyyy-MM-ddTHH:mm:ssZ. L'heure doit être exprimée en UTC. Remarque Spécifiez une heure postérieure à l'heure actuelle. Sinon, la tâche de modification des spécifications échoue. L'heure actuelle correspond à l'heure d'appel de cette opération. En cas d'échec de la tâche, attendez l'annulation automatique de la commande, puis rappelez cette opération. Si vous augmentez la capacité de stockage ou modifiez le type de stockage ESSD entre différents niveaux de performance (PL), la modification des spécifications prend effet immédiatement et n'affecte pas vos charges de travail. Vous n'avez pas besoin de configurer ce paramètre.
ResourceGroupId	String	No	rg-acfmy**********	ID du groupe de ressources auquel appartient l'instance.
UsedTime	Long	No	3	Durée de validité des modifications de spécifications pour une instance ApsaraDB RDS for SQL Server. Unité : jours.
MaxCapacity	double	No	8	Nombre maximal d'unités de capacité RDS (RCU).
MinCapacity	double	No	0,5	Nombre minimal de RCU.
AutoPause	Boolean	No	true	Indique si la suspension automatique est prise en charge.
SwitchForce	Boolean	No	false	Indique si la fonctionnalité de mise à l'échelle forcée est activée pour l'instance serverless. Valeurs possibles : true : active la fonctionnalité. false : désactive la fonctionnalité. Il s'agit de la valeur par défaut.
Category	String	No	HighAvailability	Édition RDS de l'instance. Valeurs possibles : Basic : édition RDS Basic Edition. HighAvailability : édition RDS High-availability Edition. AlwaysOn : édition RDS Cluster Edition pour SQL Server Finance : édition RDS Enterprise Edition. Cette édition est disponible uniquement sur le site Chine (aliyun.com). Remarque Si vous définissez le paramètre EngineVersion sur une version SQL Server, vous devez également spécifier ce paramètre.

Paramètres de réponse

Parameter	Type	Example	Description
DBInstanceId	String	rm-uf6wjk5***	ID de l'instance.
RequestId	String	3C5CFDEE-F774-4DED-89A2-1D76EC63C575	ID de la requête.
OrderId	Long	20793850608****	ID de la commande.

Exemples

Exemple de requête

http(s)://rds.aliyuncs.com/?Action=ModifyDBInstanceSpec
&DBInstanceId=rm-uf6wjk5*******
&PayType=Postpaid
&DBInstanceClass=rds.mys2.small
&<Common request parameters>

Exemple de réponse réussie

XML format

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

<ModifyDBInstanceSpecResponse>
    <RequestId>3C5CFDEE-F774-4DED-89A2-1D76EC63C575</RequestId>
    <DBInstanceId>rm-uf6wjk5*******</DBInstanceId>
    <OrderId>20793850608****</OrderId>
</ModifyDBInstanceSpecResponse>

JSON format

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

{
  "RequestId" : "3C5CFDEE-F774-4DED-89A2-1D76EC63C575",
  "DBInstanceId" : "rm-uf6wjk5*******",
  "OrderId" : "20793850608****"
}

Codes d'erreur

Http status code	Error code	Error message	Description
400	CannotDecreaseEssdPerfLevel	cannot decrease cloud essd performance level.	Le message d'erreur indique que la modification du type de stockage n'est pas autorisée. Le type de stockage d'une instance exécutant SQL Server avec des SSD standards ne peut être modifié qu'en ESSD. Le type de stockage d'une instance exécutant SQL Server avec des SSD locaux peut être modifié en SSD standards ou en ESSD.
400	InvalidEssdStorageSize	invalid cloud essd storage size.	Le message d'erreur indique que le type d'instance spécifié n'est pas valide. Sélectionnez un type d'instance valide et réessayez.
400	NotSupportReduceDiskSize	Not support reduce disk size.	Le message d'erreur indique que la capacité de stockage de l'instance ne peut pas être réduite.
400	InvalidDBInstanceClass.NotFound	Specified DB instance class is not found.	Le message d'erreur indique que le nouveau type d'instance est introuvable ou n'est plus disponible à l'achat. Sélectionnez un type d'instance disponible.
400	InvalidAvZone.Format	Specified AvZone is not valid.	Le message d'erreur indique que la valeur du paramètre ZoneID n'est pas valide.
400	OperationDenied.OrderUnPaid	The operation is not permitted due to the wrong Order status (Unpaid).	Le message d'erreur indique que vous avez des commandes impayées. Réglez les commandes avant d'appeler cette opération.
400	OperationDenied.InvalidStorageSize	The storage size limit is exceeded.	Le message d'erreur indique que l'utilisation du stockage dépasse la limite supérieure. Libérez ou augmentez la capacité de stockage.
400	InsufficientResourceCapacity	The instance cluster does not support this operation.	Le message d'erreur indique que l'opération n'est pas prise en charge dans le cluster dédié auquel appartient l'instance.
400	InvalidUsedTime	The parameter usedTime is invalid.	Le message d'erreur indique que la valeur du paramètre UsedTime n'est pas valide.
400	CannotChangeStorageType	Temp upgrade does not support changing storage type.	Le message d'erreur indique que les mises à niveau élastiques ne prennent pas en charge les modifications du type de stockage.
400	TempUpgrade.NotSupport	The instance does not support temp upgrade.	Le message d'erreur indique que l'instance ne prend pas en charge les mises à niveau élastiques.
400	EngineNotSupported	Engine specified cannot be supported the operation.	Le message d'erreur indique que cette opération n'est pas prise en charge pour le moteur de base de données exécuté sur l'instance. Mettez à jour la version mineure du moteur.
400	MaxscaleNotSupport	Maxscale not supported	Le message d'erreur indique que l'instance ne prend pas en charge la fonctionnalité de proxy de base de données. Vérifiez la configuration du proxy de base de données spécifiée.
400	ADInstanceNotSupportThisOperation	The AD instance is not supported this operation	Le message d'erreur indique que l'opération n'est pas prise en charge pour une instance ajoutée à un domaine Active Directory (AD).
400	BYOKInstanceNotSupportThisOperation	The BYOK instance is not supported this operation	Le message d'erreur indique que l'opération n'est pas prise en charge pour une instance dont le chiffrement de disque est activé.
400	BYOLInstanceNotSupportThisOperation	The BYOL instance is not supported this operation	Le message d'erreur indique que l'opération n'est pas prise en charge pour une instance utilisant Bring Your Own License (BYOL).
400	SSLInstanceNotSupportThisOperation	The instance opened SSL, upgrade is not this operation	Le message d'erreur indique que l'opération n'est pas prise en charge pour une instance dont la fonctionnalité de chiffrement SSL est activée.
400	TDEInstanceNotSupportThisOperation	The instance opened TDE, this operation is not supported	Le message d'erreur indique que l'opération n'est pas prise en charge pour une instance dont la fonctionnalité Transparent Data Encryption (TDE) est activée.
400	InstanceIsSnapshotBackupNotSupportThisOperation	The instance backup method is snapshot backup, this operation is not supported	Le message d'erreur indique que l'opération n'est pas prise en charge pour une instance dont la fonctionnalité de sauvegarde par snapshot est activée.
400	InstanceHasReadOnlyInstanceNotSupportThisOperation	The instance has read-only instance or is read-only instance, this operation is not supported	Le message d'erreur indique que l'opération n'est pas prise en charge pour une instance en lecture seule ou une instance à laquelle des instances en lecture seule sont attachées.
400	BackupReadInstanceModifyNotAllowed	Modify Backup Read Instance Is Not Allowed.	Le message d'erreur indique que vous n'êtes pas autorisé à modifier l'instance à partir de laquelle la sauvegarde provient.
400	MinorVersionNotSupport	The current database minor version does not support the operation.	Le message d'erreur indique que l'opération n'est pas prise en charge par la version mineure actuelle du moteur de l'instance.
400	LX.ARGUMENT.ILLEGAL	The parameters that you specified for the specification change are invalid.	Le message d'erreur indique que les paramètres spécifiés pour la modification des spécifications ne sont pas valides.
400	ORD.S.QUERY.PROD.ERROR	An error occurred while querying the ordering information	Le message d'erreur indique que la commande est introuvable.
403	IncorrectDBInstanceType	The database instance type does not support the operation.	Le message d'erreur indique que l'opération n'est pas prise en charge par le moteur de base de données exécuté sur l'instance.
403	OperationDenied.NotSupportedBackupMethod	When the storage is larger than 4000 GB, only snapshot backup is supported.	Le message d'erreur indique que la capacité de stockage est supérieure à 4 000 Go et que seules les sauvegardes par snapshot sont prises en charge.
403	IncorrectReadDBInstanceDisksize	Read instance disk size must be equal or higher than primary instance.	Le message d'erreur indique que la capacité de stockage de l'instance en lecture seule est inférieure à celle de l'instance principale. Assurez-vous que la capacité de stockage de l'instance en lecture seule est supérieure ou égale à celle de l'instance principale.
403	GroupReplicationNotSupport.InvalidEngineVersion	Group Replication requires the instance engine version to be 8.0.	Le message d'erreur indique que la version majeure du moteur de l'instance n'est pas MySQL 8.0 et que la réplication de groupe MySQL (MGR) n'est pas prise en charge.
403	GroupReplicationNotSupport.InvalidNodeClassCode	Group Replication requires the ClassCode of each node to be consistent.	Le message d'erreur indique que les spécifications des nœuds de l'instance sont différentes et que la MGR n'est pas prise en charge.
403	GroupReplicationNotSupport.InvalidNodeNum	Group Replication is not supported, the number of nodes must be an odd number greater than or equal to 3.	Le message d'erreur indique que le nombre de nœuds de l'instance n'est pas un nombre impair supérieur ou égal à 3 et que la MGR n'est pas prise en charge.
403	GroupReplicationNotSupport.InvalidXengine	Group Replication is not supported because the instance has xengine tables.	Le message d'erreur indique que des tables X-Engine existent dans l'instance et que la MGR n'est pas prise en charge.
403	GroupReplicationNotSupport.MemoryTooSmall	Group Replication is not supported because the memory is too small.	Le message d'erreur indique que la capacité mémoire de l'instance est insuffisante et que la MGR n'est pas prise en charge.
403	ARMNotSupport	ARM arch does not support this operation.	Le message d'erreur indique que cette opération n'est pas prise en charge par l'architecture ARM.
403	HostTypeNotSupport	Host type is inconsistent, please check that the original host type is the same as the target host type.	Le message d'erreur indique que les types d'hôte avant et après la modification des spécifications sont différents.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.	Le message d'erreur indique que l'opération n'est pas prise en charge par le type de stockage SSD standard. Mettez à niveau le type de stockage de l'instance vers ESSD.
403	MaxscaleInstanceNotSupport	Instances with maxscale instance do not support this operation.	Le message d'erreur indique que l'opération n'est pas prise en charge par l'instance pour laquelle MaxScale est activé.
403	ReadInstanceNotSupport	Instances with read-only do not support this operation.	Le message d'erreur indique que l'opération n'est pas prise en charge par l'instance à laquelle des instances en lecture seule sont attachées.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.	Le message d'erreur indique que l'instance ne dispose pas des autorisations nécessaires pour accéder au service Key Management Service (KMS).

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