调用UpdateInstance更新实例信息,同时会检查连通性。

调用UpdateInstance更新实例,请先通过GetInstance API获取对应实例的完整信息,再根据具体需要修改的内容进行设置,然后再调用此API

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String UpdateInstance

系统规定参数。取值:UpdateInstance。

DatabasePassword String ******

数据库账号密码。

DatabaseUser String dbuser

数据库账号。

DbaId String 1

实例DBA ID,与ListUsers接口中的ID对应。

EnvType String test

实例所属环境。

ExportTimeout Integer 600

实例导出超时时间。

Host String xxxx.mysql.rds.aliyuncs.com

实例连接地址。

InstanceAlias String test

实例别名。

InstanceId String 1

实例ID,与GetInstance API中返回的ID对应。

InstanceSource String RDS

实例来源,取值可参考RegisterInstance API中的提示。

InstanceType String MySQL

实例DB类型,取值可参考RegisterInstance API中的提示。

Port Integer 3306

实例端口。

QueryTimeout Integer 60

实例查询超时时间。

SafeRuleId String 1

实例所属安全规则ID。

Tid Long -1

租户ID。

说明 取自系统右上角头像处悬停展示的租户ID信息,详情请参见查看租户信息
EcsInstanceId String xxx

实例所属EcsInstanceId,描述请参考RegisterInstance API。

VpcId String xxx

实例所属VPC ID。

EcsRegion String cn-hangzhou

实例所属Region。

Sid String xxx

实例sid。

DataLinkName String datalink_test

实例dataLinkName。

DdlOnline Integer 1

实例onlineddl设置,取值请参考RegisterInstance API。

UseDsql Integer 1

实例是否启用跨库查询。

返回数据

名称 类型 示例值 描述
ErrorCode String UnknownError

错误码。

ErrorMessage String UnknownError

错误信息。

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

API请求ID。

Success Boolean false

更新实例是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=UpdateInstance
&<公共请求参数>

正常返回示例

XML 格式

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

JSON 格式

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

错误码

访问错误中心查看更多错误码。