You can call this operation to update the information and check the connectivity of a specified database instance.

Before calling this operation to update a database instance, call the GetInstance operation to query the complete information of the database instance, and set the instance parameters as required.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes UpdateInstance

The operation that you want to perform. Set the value to UpdateInstance.

DatabasePassword String Yes ******

The logon password of the database instance.

DatabaseUser String Yes dbuser

The logon username of the database instance.

DbaId String Yes 1

The ID of the database administrator (DBA) of the database instance. The value is the same as the ID of the DBA returned by the ListUsers operation.

EnvType String Yes test

The type of the environment to which the database instance belongs.

ExportTimeout Integer Yes 600

The timeout period for exporting the database instance.

Host String Yes xxxx.mysql.rds.aliyuncs.com

The endpoint of the database instance.

InstanceAlias String Yes test

The alias of the database instance.

InstanceId String Yes 1

The ID of the database instance. The value is the same as the value of the InstanceId parameter returned by the GetInstance operation.

InstanceSource String Yes RDS

The source of the database instance. For more information about the valid values, see the description of the RegisterInstance operation.

InstanceType String Yes MySQL

The type of the database instance. For more information about the valid values, see the description of the RegisterInstance operation.

Port Integer Yes 3306

The connection port of the database instance.

QueryTimeout Integer Yes 60

The timeout period for querying the database instance.

SafeRuleId String Yes 1

The ID of the security rule for the database instance.

Tid Long Yes -1

The ID of the tenant in Data Management (DMS) Enterprise.

DataLinkName String No datalink_test

The name of the data link for the database instance.

DdlOnline Integer No 1

Specifies whether to enable the online data description language (DDL) service for the database instance. For more information about the valid values, see the description of the RegisterInstance operation.

EcsInstanceId String No xxx

The ID of the Elastic Compute Service (ECS) instance to which the database instance belongs. For more information, see the description of the RegisterInstance operation.

EcsRegion String No cn-hangzhou

The region where the database instance resides.

Sid String No xxx

The system ID (SID) of the database instance.

UseDsql Integer No 1

Specifies whether to enable cross-database query for the database instance.

VpcId String No xxx

The ID of the Virtual Private Cloud (VPC) to which the database instance belongs.

Response parameters

Parameter Type Example Description
ErrorCode String UnknownError

The error code.

ErrorMessage String UnknownError

The error message.

RequestId String E9BEBF41-4F69-4605-A5D5-A67955173941

The ID of the request.

Success Boolean false

Indicates whether the request was successful.

Examples

Sample requests


http(s)://[Endpoint]/? Action=UpdateInstance
&<Common request parameters>

Sample success responses

XML format

<RequestId>E9BEBF41-4F69-4605-A5D5-A67955173941</RequestId>
<Success>true</Success>

JSON format

{
	"RequestId":"E9BEBF41-4F69-4605-A5D5-A67955173941",
	"Success":true
}

Error codes

For a list of error codes, visit the API Error Center.