CreateDBInstanceEndpoint - ApsaraDB RDS - Centre de documentation Alibaba Cloud

Crée un point de terminaison pour une instance exécutant RDS Cluster Edition.

Description de l'opération

Moteurs de base de données pris en charge

MySQL

Références

Remarque

Avant d'appeler cette opération, lisez attentivement la documentation suivante. Assurez-vous de bien comprendre les prérequis et les impacts de l'appel de cette opération.

Créer un point de terminaison en lecture seule pour un cluster

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.

rds:CreateDBInstanceEndpoint

create

*DBInstance

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

rds:ResourceTag

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
ClientToken	string	Non	Le jeton client utilisé pour garantir l'idempotence de la requête. Vous pouvez utiliser le client pour générer le jeton, mais vous devez vous assurer que le jeton est unique parmi les différentes requêtes. Le jeton ne peut contenir que des caractères ASCII et ne doit pas dépasser 64 caractères.	6000170000591aed949d0f****
DBInstanceId	string	Oui	L'identifiant de l'instance. Vous pouvez appeler l'opération DescribeDBInstances pour obtenir l'identifiant de l'instance.	rm-****
VpcId	string	Oui	L'identifiant du VPC du point de terminaison interne.	vpc-xxxmmxjqqi****
VSwitchId	string	Oui	L'identifiant du vSwitch du point de terminaison interne.	vsw-bp1kqp****
PrivateIpAddress	string	Non	L'adresse IP du point de terminaison interne.	172.16.XX.XX
ConnectionStringPrefix	string	Oui	Le préfixe du point de terminaison interne. Lorsque vous créez n'importe quel type de point de terminaison, un point de terminaison interne est automatiquement créé pour ce point de terminaison. Ce paramètre spécifie le préfixe du point de terminaison interne.	rm-****-ro
Port	string	Oui	Le numéro de port du point de terminaison interne. Vous pouvez spécifier le numéro de port pour le point de terminaison interne. Valeurs valides : 3000 à 5999.	3306
DBInstanceEndpointType	string	Oui	Le type de point de terminaison. Valeurs valides : Primary : point de terminaison de lecture/écriture de l'instance Readonly : point de terminaison en lecture seule de l'instance Valeurs valides : Readonly : Lecture seule.	Readonly
DBInstanceEndpointDescription	string	Non	La description définie par l'utilisateur du point de terminaison.	pour les activités en lecture seule
NodeItems	array<object>	Oui	Les informations relatives au point de terminaison.
	object	Non	Les informations relatives à l'objet tableau.
DBInstanceId	string	Oui	L'identifiant de l'instance. Vous pouvez appeler l'opération DescribeDBInstances pour obtenir l'identifiant de l'instance.	rm-****
NodeId	string	Oui	L'identifiant du nœud.	rn-xxxx-****
Weight	integer	Non	Le poids du nœud. Les requêtes de lecture sont réparties en fonction du poids.\n\nValeurs valides : 0 à 100.	50
ResourceGroupId	string	Non	L'identifiant du groupe de ressources. Vous pouvez appeler l'opération DescribeDBInstanceAttribute pour obtenir l'identifiant du groupe de ressources.	rg-acfmy****

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
Data	object	Les données renvoyées.
ConnectionString	string	Le point de terminaison interne.	rm-****.mysql.rds.aliyuncs.com
DBInstanceEndpointId	string	L'identifiant du point de terminaison de l'instance.	ep-****
DBInstanceName	string	Le nom de l'instance.	rm-****
RequestId	string	L'identifiant de la requête.	C8E88DED-533F-4B3C-9207-731FBF394CCA

Exemples

JSON format

{
  "Data": {
    "ConnectionString": "rm-****.mysql.rds.aliyuncs.com",
    "DBInstanceEndpointId": "ep-****",
    "DBInstanceName": "rm-****"
  },
  "RequestId": "C8E88DED-533F-4B3C-9207-731FBF394CCA"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidSourceCategory	specified source category is invalid.	The specified source category is invalid.
400	InvalidDBInstanceConnType.Format	Specified DB instance conn type is not valid.	The operation failed. The operation is not supported for the connection type of the RDS instance.
400	EndpointNum.Error	The number of endpoint is too many.
400	InvalidNodeItems.DuplicateNodeId	Duplicate nodeId, please ensure all nodeIds are different.	Duplicate NodeId parameter values exist in NodeItems.
400	InvalidNodeItems.RONode	ReadOnly endpoint can not contain readonly instance node.	The read-only endpoint cannot contain the read-only instance.
400	InvalidNodeItems.RONodeIdPrimary	ReadOnly endpoint can not contain primary node.	The read-only endpoint cannot contain the primary instance.
400	InvalidNodeItems.JsonFormat	NodeItems is not a json string.	The NodeItems parameter value must be a JSON string.
400	InvalidNodeItems.DBInstanceId	Specified dbInstanceId is invalid	The specified dbInstanceId parameter in NodeItems is invalid.
400	InvalidNodeItems.NodeId	Specified Node id is invalid	A NodeId parameter value in NodeItems is not found among instances.
400	EndpointType.NotSupport	Current db type is not support specified endpoint type.	The specified endpoint type is invalid.
400	OtherEndpoint.Exist	Other endpoint already exist.
400	InvalidPort.Malformed	Specified port is not valid.	The port number is invalid.
400	APICallingFailed	Api called failed, please check vpc vsw vip
400	InvalidDBInstanceName.NotFound	The specified DB instance name does not exist.	The instance name does not exist.
400	InvalidNodeItems.BlackNodeItems	NodeItems is blank.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	Pricing plan price result not found.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	Your account available limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.	Failed to call commodity service return.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.	Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	The module you purchased is not legal, please buy it again.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.	Hello customer, this area has been abolished.
400	Price.CommoditySys	Commodity system call exception.	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.	No payment method has been specified for your account. We recommend that you add a payment method.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	Your basic information is not complete, please complete your basic information before operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.	The current interface does not support.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.	You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.	The DBInstanceId provided does not exist.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	The current instance type does not support the specified storage type.
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.	The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.
400	KmsApiError	User secret key invalid.	The user key is invalid.
400	System.SaleValidateFailed	Sales expression validation system error.	A system error occurs when the sales expression is verified.
400	Abs.InvalidAccount.NotFound	account is not found.	The account does not exist.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.	SQL command execution failed or timed out
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.	This operation is not supported by the instance type.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.	The link address name is duplicate. Please reset the connection string.
400	RequiredParam.NotFound	Required input param is not found.
400	Parameters.Invalid	Parameter error, please check the parameters.	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400	InvalideStatus.Format	The instance status does not support this operation.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.	Specified Released Keep Policy is not valid.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.	This operation is not supported for the database engine of the instance.
400	Pay.NoCreditCard	No credit cards.	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	The vpc network type instance does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.	Specified DB instance mirror ins already existed.
400	UnsupportedClassCode	The specified DB instance class stops selling.	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.	Failed to query product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.	The instance has been released, please verify and place an order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.	The region is no longer supported.
500	ExternalFailure	The request processing has failed due to external service failure.	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.	The service request failed. Please try again later or contact service personnel.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.	The request failed to be processed due to an RDS API failure.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.
403	InvalidConnVPCId	Specified conn vpc id is not valid.	The specified VPC ID is invalid.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	The instance has an unpaid order. Please pay first and try again.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.	The scale-in target capacity cannot be less than the current storage space usage
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.
403	InvalidUserOperatorPermission	The user permission does not support this operation.	The user is not authorized to perform this operation.
403	IncorrectMinorVersion	Current engine minor version does not support operations.	This operation is not supported for the current minor engine version.
403	OperationDenied.ZoneResource	There is no available zone for inventory.	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.	The specified database instance type does not support this operation.
404	IncorrectDBInstanceLockMode	Current DB instance lock mode does not support this operation.	The operation failed. The RDS instance is locked.
404	InvalidConnectionString.NotFound	Specified connection string or net type is not found.	The endpoint cannot be found. Check the endpoint.
404	InvalidConnectionString.Duplicate	Specified connection string already exists in the Aliyun RDS.	The endpoint is duplicate. Specify a different endpoint.
404	InvalidWeight.Format	The Specified Weight format is not valid.	The weight range is invalid.
404	InvalidDBInstance.NotFound	Specified instance does not exist or not support.	The RDS instance cannot be found, is deleted, or does not support the operation.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.	The instance does not have permissions to access Key Management Service (KMS).
404	Request.NotFound	The requested resource is not available.	The requested resources are unavailable.
404	HostInfo.NotFound	The specified host info is not found.

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

Notes de version

Consultez Notes de version pour la liste complète.