ModifyDBInstanceEndpoint - - Alibaba Cloud Dokümantasyon Merkezi

Cluster Edition'daki bir ApsaraDB RDS örneğinin uç nokta ağırlık bilgilerini değiştirir.

Operation description

Uygulanabilir motorlar

RDS MySQL.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

rds:ModifyDBInstanceEndpoint

update

*DBInstance.

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

None

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	İsteğin idempotent olmasını sağlamak ve tekrarlanan gönderimleri önlemek için kullanılan istemci belirteci. Belirteç istemci tarafından oluşturulur. Belirteç yalnızca ASCII karakterleri içerebilir ve uzunluğu 64 karakteri aşamaz.	6000170000591aed949d0f****
DBInstanceId	string	Yes	Örnek kimliği. Örnek kimliğini sorgulamak için DescribeDBInstances'ı çağırabilirsiniz.	rm-****
DBInstanceEndpointId	string	Yes	Örneğin uç nokta kimliği. Uç nokta kimliğini sorgulamak için DescribeDBInstanceEndpoints'ı çağırabilirsiniz.	ep-****
DBInstanceEndpointDescription	string	No	Uç noktanın özel açıklaması.	for readonly business
NodeItems	array<object>	No	Uç nokta düğümleri hakkındaki bilgiler.
	object	No	Düğüm ayrıntıları.
DBInstanceId	string	No	Örnek kimliği. Örnek kimliğini sorgulamak için DescribeDBInstances'ı çağırabilirsiniz.	rm-****
NodeId	string	No	Düğüm kimliği. Düğüm kimliğini aşağıdaki yöntemleri kullanarak sorgulayabilirsiniz: ApsaraDB RDS konsolundaki örnek ayrıntıları sayfasının örnek topolojisi bölümünden düğüm kimliğini görüntüleyin. Düğüm kimliğini sorgulamak için DescribeDBInstanceAttribute'ı çağırın.	rn-xxxx-****
Weight	integer	No	Düğümün okuma trafiği ağırlığı. Okuma trafiği bu değere göre dağıtılır. Geçerli değerler: 0 ile 100 arası.	50

Response elements

Element	Type	Description	Example
	object	Yanıt parametreleri.
Data	object	Döndürülen veriler.
DBInstanceEndpointId	string	Örneğin uç nokta kimliği.	ep-****
DBInstanceName	string	Örnek kimliği.	rm-****
RequestId	string	İstek kimliği.	F2911788-25E8-42E5-A3A3-1B38D263F01E

Examples

Success response

JSON format

{
  "Data": {
    "DBInstanceEndpointId": "ep-****",
    "DBInstanceName": "rm-****"
  },
  "RequestId": "F2911788-25E8-42E5-A3A3-1B38D263F01E"
}

Error codes

HTTP status code	Error code	Error message
400	InvalidSourceCategory	specified source category is invalid.
400	InvalidDBInstanceConnType.Format	Specified DB instance conn type is not valid.
400	APICallingFailed	Meta db calling failed.
400	InvalidNodeItems.JsonFormat	NodeItems is not a json string.
400	EmptyEndpointNodeConfig	Specified endpoint has no nodes, add node to endpoint first.
400	InvalidNodeItems.RONodeIdPrimary	ReadOnly endpoint can not contain primary node.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	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.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.
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.
400	Commodity.InvalidComponent	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.
400	Price.CommoditySys	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.
400	Order.PeriodInvalid	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.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.
400	KmsApiError	User secret key invalid.
400	System.SaleValidateFailed	Sales expression validation system error.
400	Abs.InvalidAccount.NotFound	account is not found.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.
400	RequiredParam.NotFound	Required input param is not found.
400	Parameters.Invalid	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	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.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.
400	Pay.NoCreditCard	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.
400	UnsupportedClassCode	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.
500	ExternalFailure	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	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.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.
403	InvalidUserOperatorPermission	The user permission does not support this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
403	IncorrectMinorVersion	Current engine minor version does not support operations.
403	OperationDenied.ZoneResource	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.
404	IncorrectDBInstanceLockMode	Current DB instance lock mode does not support this operation.
404	InvalidDBInstanceName.NotFound	Invalid DBInstanceId NotFound.
404	Endpoint.NotFound	Specified endpoint is not existed.
404	InvalidConnectionString.NotFound	Specified connection string or net type is not found.
404	InvalidWeight.Format	The Specified Weight format is not valid.
404	InvalidDBInstance.NotFound	Specified instance does not exist or not support.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.
404	Request.NotFound	The requested resource is not available.
404	HostInfo.NotFound	The specified host info is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.