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

调用UpdateInstance更新实例信息前，请先通过调用接口GetInstance或ListInstances获取实例的完整信息。

调试

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

请求参数

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

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

Tid Long 是 3***

租户ID，可通过调用接口GetUserActiveTenant获取该参数的值。

InstanceType String 是 mysql

数据库类型，取值请参见DbType参数说明。

InstanceSource String 是 ECS_OWN

数据库实例来源，取值如下：

  • PUBLIC_OWN：代表公网自建实例
  • RDS：代表RDS实例
  • ECS_OWN：代表ECS自建实例
  • VPC_IDC：代表VPC IDC自建实例
EnvType String 是 product

环境类型，取值如下：

  • product：生产环境
  • dev：开发环境
  • pre：预发环境
  • test：测试环境
  • sit：SIT环境
  • uat：UAT环境
  • pet：压测环境
  • stag：STAG环境
EcsInstanceId String 否 i-2zei9gs1t7h8l7ac****

ECS的实例ID。

说明 如果InstanceSource取值为ECS_OWN，此值必填。
VpcId String 否 vpc-xxx

实例VPC ID。

说明 如果InstanceSource取值为VPC_IDC时，此值必填。
EcsRegion String 否 cn-hangzhou

实例所在地域。

说明 如果InstanceSource取值为RDS、ECS_OWN或VPC_IDC，此值必填。
Host String 是 192.XXX.0.56

实例连接地址。
Port Integer 是 3306

实例访问端口。
Sid String 否 XXX

实例Sid。

说明 如果InstanceType为ORACLE，此项必填。
DatabaseUser String 是 dbuser

数据库账号。
DatabasePassword String 是 ******

数据库访问密码。
InstanceAlias String 是 instance_test

实例别名，帮助用户快速区分定位该实例。
DbaId String 是 27****

实例DBA角色的用户ID，可通过调用接口ListUsers或GetInstance获取该参数的值。

SafeRuleId String 是 3****

实例的安全规则集（GroupName），可通过调用接口ListStandardGroups或GetInstance获取该参数的值。

QueryTimeout Integer 是 60

实例查询超时时间。
ExportTimeout Integer 是 600

实例导出超时时间。
DataLinkName String 否 datalink_test

输入跨库查询datalink名称。

说明
  • 如果UseDsql取值为1，此值必填。
  • DBLink名称只能使用小写字母和下划线（_）。
  • DBLink名称需要在租户内保持全局唯一性。
DdlOnline Integer 否 0

实例是否开启无锁结构变更，取值如下：

  • 0 ：不使用
  • 1 ：原生Online DDL优先
  • 2 ：DMS无锁表结构变更优先
UseDsql Integer 否 0

是否启用跨实例查询，取值如下：

  • 0：不开启
  • 1：开启
说明 支持的数据库类型：MySQL、SQL Server、PostgreSQL、PolarDB O引擎、Redis。
InstanceId String 是 126****

实例ID，可通过调用接口GetInstance获取该参数的值。

SkipTest Boolean 否 false

实例是否忽略测试连通性。取值如下：

  • true：忽略
  • false：不忽略
EnableSellSitd String 否 Y
  • Y：开启敏感数据保护
  • N：关闭敏感数据保护
  • NULL或其它：不更新敏感数据保护的状态，即保持原始的开启或关闭状态。
TemplateId Long 否 3***

更新分类分级模板ID。您可以调用ListClassificationTemplates接口获取该参数的值。

TemplateType String 否 INNER

更新分类分级模板类型。您可以调用ListClassificationTemplates接口获取该参数的值。

返回数据

名称 类型 示例值 描述
RequestId String E9BEBF41-4F69-4605-A5D5-A67955173941

请求ID。
ErrorCode String UnknownError

错误码。
ErrorMessage String UnknownError

错误信息。
Success Boolean false

请求是否成功，返回值如下：

  • true：请求成功
  • false：请求失败

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=UpdateInstance
&Tid=3***
&InstanceType=mysql
&InstanceSource=ECS_OWN
&EnvType=product
&Host=192.XXX.0.56
&Port=3306
&DatabaseUser=dbuser
&DatabasePassword=******
&InstanceAlias=instance_test
&DbaId=27****
&SafeRuleId=3****
&QueryTimeout=60
&ExportTimeout=600
&InstanceId=126****
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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