ModifyDBInstanceConnectionString - - Centre de documentation Alibaba Cloud

Description de l'opération

Vous pouvez modifier l'adresse de connexion et le port pour les types d'instances suivants :

Vous pouvez modifier l'adresse de connexion et le port pour les instances qui utilisent des disques locaux ou des disques cloud.
Pour les instances de cluster fragmenté, vous pouvez uniquement modifier l'adresse de connexion des nœuds Mongos.

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.

dds:ModifyDBInstanceConnectionString

update

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
DBInstanceId	string	Oui	L'identifiant de l'instance. Remarque Si vous spécifiez l'identifiant d'une instance de cluster fragmenté, vous devez également spécifier le paramètre NodeId.	dds-bpxxxxxxxx
NodeId	string	Non	L'identifiant d'un nœud Mongos dans une instance de cluster fragmenté. Vous ne pouvez spécifier qu'un seul identifiant de nœud Mongos par appel. Remarque Ce paramètre n'est valide que lorsque DBInstanceId spécifie l'identifiant d'une instance de cluster fragmenté.	s-bpxxxxxxxx
CurrentConnectionString	string	Non	L'adresse de connexion actuelle, c'est-à-dire l'adresse à modifier.	s-bpxxxxxxxx.mongodb.rds.aliyuncs.com
NewConnectionString	string	Non	La nouvelle adresse de connexion. Elle doit répondre aux exigences suivantes : Commencer par une lettre minuscule. Se terminer par une lettre minuscule ou un chiffre. Contenir uniquement des lettres minuscules, des chiffres et des traits d'union (-). Comporter entre 8 et 63 caractères. Remarque Spécifiez uniquement le préfixe de l'adresse de connexion. Vous ne pouvez modifier aucune partie au-delà du préfixe.	aliyuntest111
NewPort	integer	Non	Le nouveau numéro de port. Les valeurs valides sont comprises entre 1000 et 65535. Remarque Ce paramètre n'est valide que lorsque DBInstanceId spécifie l'identifiant d'une instance de disque cloud.	3310
PortModifyOnly	boolean	Non
NetworkType	string	Non		vpc
ForceModifySuffix	boolean	Non

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	FF36A84C-0694-42D0-861D-C383E8E4FAAF
ModifiedConnectionString	string

Exemples

JSON format

{
  "RequestId": "FF36A84C-0694-42D0-861D-C383E8E4FAAF",
  "ModifiedConnectionString": ""
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	NewConnectionString.NotSupport	Specified newConnectionString is not supported.	newConnectionString format
400	InvalidConnectionStringOrPort.Duplicate	Specified connection string or port already exists.	The specified connection string or port information already exists, please check and resubmit.

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

Notes de version

Consultez Notes de version pour la liste complète.