DeleteDBInstanceEndpoint - ApsaraDB RDS - Alibaba Cloud ドキュメントセンター

Deletes the endpoint of an ApsaraDB RDS for MySQL instance that runs RDS Cluster Edition.

Operation description

Supported database engine

MySQL

References

Note Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.

Delete the read-only endpoint of an ApsaraDB RDS for MySQL cluster

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
rds:DeleteDBInstanceEndpoint	Write	DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	none

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token that is used to ensure the idempotency of requests. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.	0c593ea1-3bea-11e9-b96b-88****
DBInstanceId	string	Yes	The instance ID. You can call the DescribeDBInstances operation to query the ID of the instance.	rm-****
DBInstanceEndpointId	string	Yes	The endpoint ID of the instance. You can call the DescribeDBInstanceEndpoints operation to query the endpoint ID of the instance.	ep-****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
Data	object	The data returned.
DBInstanceName	string	The ID of the instance.	rm-****
DBInstanceEndpointId	string	The endpoint ID of the instance.	ep-****
RequestId	string	The ID of the request.	224DB9F7-3100-4899-AB9C-C938BCCB43E7

Examples

Sample success responses

JSONformat

{
  "Data": {
    "DBInstanceName": "rm-****",
    "DBInstanceEndpointId": "ep-****"
  },
  "RequestId": "224DB9F7-3100-4899-AB9C-C938BCCB43E7"
}

Error codes

HTTP status code	Error code	Error message	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	EndpointType.NotSupport	Current db type is not support specified endpoint type.	The specified endpoint type is invalid.
400	APICallingFailed	Meta db calling failed.	An internal error occurred.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.	-
404	InvalidDBInstanceName.NotFound	Invalid DBInstanceId NotFound.	The instance ID cannot be found.
404	IncorrectDBInstanceLockMode	Current DB instance lock mode does not support this operation.	The operation failed. The RDS instance is locked.
404	Endpoint.NotFound	Specified endpoint is not existed.	-
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.

For a list of error codes, visit the Service error codes.