Modifier les paramètres du terminal proxy - - Centre de documentation Alibaba Cloud

Avant d'appeler l'opération ModifyDBProxyEndpoint, assurez-vous d'avoir appelé l'opération ModifyDBProxy afin d'activer la fonctionnalité de proxy de base de données pour l'instance.

Le proxy dédié d'ApsaraDB RDS for MySQL offre des fonctionnalités telles que la répartition lecture/écriture et l'optimisation des connexions éphémères. Pour plus d'informations, consultez la rubrique Présentation des proxys de base de données
Le proxy de base de données d'ApsaraDB RDS for PostgreSQL prend en charge la répartition lecture/écriture. Pour plus d'informations, consultez la rubrique Présentation des proxys de base de données

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. Il 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	ModifyDBProxyEndpoint	Opération à effectuer. Définissez la valeur sur ModifyDBProxyEndpoint.
DBInstanceId	String	Yes	rm-bp145737x5bi6****	ID de l'instance. Appelez l'opération DescribeDBInstances pour récupérer l'ID de l'instance.
DBProxyEndpointId	String	Yes	gos787jog2wk0y****	ID du terminal proxy. Appelez l'opération DescribeDBProxyEndpoint pour récupérer l'ID du terminal proxy. Remarque Si l'instance exécute MySQL et que vous définissez le paramètre DbEndpointOperator sur Delete ou Modify, vous devez spécifier le paramètre DBProxyEndpointId. Si l'instance exécute PostgreSQL et que vous définissez le paramètre DbEndpointOperator sur Delete, Modify ou Create, vous devez spécifier le paramètre DBProxyEndpointId.
ConfigDBProxyFeatures	String	No	ReadWriteSpliting:1;ConnectionPersist:0	Fonctionnalités à activer pour le terminal proxy. Si vous spécifiez plusieurs fonctionnalités, séparez-les par des points-virgules (;). Format : `Feature 1:Status;Feature 2:Status;...`. N'ajoutez pas de point-virgule (;) après la dernière valeur. Valeurs de fonctionnalité valides : ReadWriteSpliting : répartition lecture/écriture ConnectionPersist : regroupement de connexions TransactionReadSqlRouteOptimizeStatus : répartition des transactions Valeurs d'état valides : 1 : activé 0 : désactivé Remarque Si l'instance exécute PostgreSQL, vous ne pouvez activer que la fonctionnalité de répartition lecture/écriture, spécifiée par ReadWriteSpliting.
RegionId	String	No	cn-hangzhou	ID de région de l'instance. Appelez l'opération DescribeRegions pour récupérer la liste des régions la plus récente.
ReadOnlyInstanceMaxDelayTime	String	No	30	Seuil de latence maximal autorisé pour la répartition lecture/écriture. Si la latence d'une instance en lecture seule dépasse le seuil spécifié, ApsaraDB RDS cesse de transférer les requêtes de lecture vers cette instance. Si vous omettez ce paramètre, sa valeur d'origine est conservée. Unité : secondes. Valeurs valides : 30 à 3600. Valeur par défaut : 30. Remarque Spécifiez ce paramètre uniquement si la fonctionnalité de répartition lecture/écriture est activée.
ReadOnlyInstanceDistributionType	String	No	Standard	Politique d'attribution des poids de lecture. Valeurs valides : Standard : ApsaraDB RDS attribue automatiquement les poids de lecture à l'instance principale et à ses instances en lecture seule en fonction de leurs spécifications. Custom : Vous devez attribuer manuellement les poids de lecture à l'instance principale et à ses instances en lecture seule. Remarque Spécifiez ce paramètre uniquement si la fonctionnalité de répartition lecture/écriture est activée. Pour plus d'informations sur la politique d'allocation des poids, consultez les rubriques Modifier le seuil de latence et les poids de lecture des instances ApsaraDB RDS for MySQL et Activer et configurer la fonctionnalité de proxy de base de données pour une instance ApsaraDB RDS for PostgreSQL.
ReadOnlyInstanceWeight	String	No	{"rm-uf6wjk5xxxx":"500","rr-tfhfgk5xxx":"200"...}	Poids de lecture de l'instance principale et de ses instances en lecture seule. Un poids de lecture doit être un multiple de 100 et ne peut pas dépasser 10 000. Formats : Instance standard : `{"ID of the primary instance":"Weight","ID of the read-only instance":"Weight"...}` Exemple : `{"rm-uf6wjk5xxxx":"500","rr-tfhfgk5xxx":"200"...}` Instance de cluster : `{"ID of the read-only instance ID":"Weight","DBClusterNode":{"ID of the primary node":"Weight","ID of the secondary node ID":"Weight","ID of the secondary node ID":"Weight"...}}` Exemple : `{"rr-tfhfgk5xxx":"200","DBClusterNode":{"rn-2z**":"0","rn-2z":"400","rn-2z":"400"...}}` Remarque Le paramètre DBClusterNode est requis si l'instance exécute RDS Cluster Edition. Le paramètre DBClusterNode inclut les IDs et les weights** des nœuds principaux et secondaires.
DbEndpointOperator	String	No	Modify	Type d'opération à effectuer. Valeurs valides : Modify : Modifie un terminal proxy. Valeur par défaut. Create : Crée un terminal proxy. Delete : Supprime un terminal proxy.
DbEndpointAliases	String	No	test-proxy	Description du terminal proxy.
DbEndpointType	String	No	RWSplit	Type de terminal proxy. Paramètre réservé ; inutile de le spécifier.
DbEndpointReadWriteMode	String	No	ReadWrite	Attributs de lecture et d'écriture du terminal proxy. Valeurs valides : ReadWrite : Le terminal proxy se connecte à l'instance principale et peut recevoir des requêtes de lecture et d'écriture. ReadOnly : Le terminal proxy ne se connecte pas à l'instance principale et ne peut recevoir que des requêtes de lecture. Valeur par défaut. Remarque Si vous définissez le paramètre DbEndpointOperator sur Create, vous devez également spécifier le paramètre DbEndpointReadWriteMode. Si l'instance exécute MySQL et que vous modifiez la valeur de ce paramètre de ReadWrite à ReadOnly, la fonctionnalité de répartition des transactions est désactivée.
DBProxyEngineType	String	No	normal	Paramètre interne. Inutile de le spécifier.

Paramètres de réponse

Parameter	Type	Example	Description
RequestId	String	6B50D92C-1960-4D4F-A290-AFADD6B1A5C8	ID de la requête.

Exemples

Exemples de requêtes

http(s)://rds.aliyuncs.com/?Action=ModifyDBProxyEndpoint
&DBInstanceId=rm-bp145737x5bi6****
&DBProxyEndpointId=gos787jog2wk0y****
&ConfigDBProxyFeatures=ReadWriteSpliting:1;ConnectionPersist:1;
&ReadOnlyInstanceMaxDelayTime=30
&ReadOnlyInstanceDistributionType=Standard
&<Common request parameters>

Exemples de réponses réussies

XML format

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

<ModifyDBProxyEndpointResponse>
  <RequestId>6B50D92C-1960-4D4F-A290-AFADD6B1A5C8</RequestId>
</ModifyDBProxyEndpointResponse>

JSON format

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

{
  "RequestId" : "6B50D92C-1960-4D4F-A290-AFADD6B1A5C8"
}

Codes d'erreur

HTTP status code	Error code	Error message	Description
400	InvalidVpcInstanceId	The specified VPC instance ID is invalid.	L'ID VPC spécifié n'est pas valide.
400	InvalidEndPoint.Format	The specified EndPoint is not valid.	Le paramètre DBProxyEndpointId est vide ou le terminal proxy correspondant est introuvable.
400	InvalidEndpointType.Format	The specified EndpointType is invalid.	La valeur du paramètre EndpointType n'est pas valide.
400	IncorrectDBInstanceNetType	The current database instance network type does not support the operation.	Le type de réseau de l'instance ne prend pas en charge cette opération.
400	EndpointNum.Error	The number of endpoint is invalid.	Le nombre de terminaux proxy configurés ne respecte pas les exigences.
400	EndpointTypeOperation.NotSupport	The endpoint type does not support the operation.	Le type de terminal proxy spécifié ne prend pas en charge cette opération.
400	InvalidDBInstanceName	Specified parameter DBInstanceName is not valid.	La valeur du paramètre DBInstanceName n'est pas valide. Vérifiez qu'elle n'est pas nulle ou vide.
400	ClusterEndpoint.StatusNotValid	The cluster endpoint status is invalid.	L'état du terminal proxy n'est pas valide.
403	MaxScaleLevel.NotSupport	The current maxscale ins_num does not support this operation.	Les spécifications du proxy de base de données ne prennent pas en charge cette opération.
403	ReadDBInstance.NotFound	The current database instance does not contain any read only instance.	Aucune instance en lecture seule n'est associée à l'instance.
403	IncorrectKindCode	The current KindCode of the custins does not support the operation.	La configuration de l'instance ne prend pas en charge cette opération. Vérifiez la configuration de l'instance.
403	IncorrectDBInstanceState	The current database instance state does not support the operation.	L'état de l'instance ne prend pas en charge cette opération. Vérifiez que l'instance est dans l'état Running.
404	EndpointConfig.Invalid	Please check the endpoint config parameter.	Les paramètres du terminal proxy ne sont pas valides. Vérifiez les valeurs des paramètres associés.
404	Readins.NotFound	The current instance does not contain any read only instance. The operation is not supported.	Aucune instance en lecture seule n'est associée à l'instance.
404	Endpoint.NotFound	Specified endpoint is not found.	Le port utilisé pour se connecter au terminal proxy est introuvable.
404	EndpointType.NotFound	The specified endpoint type is not found.	Le type de terminal proxy spécifié est inconnu du système.
404	InvalidReadDBInstance.NotFound	The specified read only database instance does not exist.	Aucune instance en lecture seule n'est associée à l'instance ou certains paramètres de la requête sont incorrects.
404	InvalidParam	The specified Weight is invalid.	Les poids de lecture spécifiés ne sont pas valides.

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