更新实例信息，同时检查该实例连通性。
接口说明
调用 UpdateInstance 更新实例信息前，请先通过调用接口 GetInstance 或 ListInstances 获取实例的完整信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dms:UpdateInstance | update | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Tid | long | 否 | 租户 ID，可通过调用接口 GetUserActiveTenant 获取该参数的值。 | 3*** |
| InstanceType | string | 是 | 数据库类型，取值请参见 DbType 参数说明。 | mysql |
| InstanceSource | string | 是 | 数据库实例来源，取值如下：
| ECS_OWN |
| EnvType | string | 是 | 环境类型，取值如下：
| product |
| EcsInstanceId | string | 否 | ECS 的实例 ID。 说明
如果 InstanceSource 取值为 ECS_OWN，此值必填。
| i-2zei9gs1t7h8l7ac**** |
| VpcId | string | 否 | 实例 VPC ID。 说明
如果 InstanceSource 取值为 VPC_IDC 时，此值必填。
| vpc-xxx |
| EcsRegion | string | 否 | 实例所在地域。 说明
如果 InstanceSource 取值为 RDS、ECS_OWN 或 VPC_IDC，此值必填。
| cn-hangzhou |
| Host | string | 是 | 实例连接地址。 | 192.XXX.0.56 |
| Port | integer | 是 | 实例访问端口。 | 3306 |
| Sid | string | 否 | 实例 Sid。 说明
如果 InstanceType 为 ORACLE，此项必填。
| XXX |
| DatabaseUser | string | 是 | 数据库账号。 | dbuser |
| DatabasePassword | string | 是 | 数据库访问密码。 | ****** |
| InstanceAlias | string | 是 | 实例别名，帮助用户快速区分定位该实例。 | instance_test |
| DbaId | string | 是 | 实例 DBA 角色的用户 ID，可通过调用接口 ListUsers 或 GetInstance 获取该参数的值。 | 27**** |
| SafeRuleId | string | 是 | 实例的安全规则集（GroupName），可通过调用接口 ListStandardGroups 或 GetInstance 获取该参数的值。 | 3**** |
| QueryTimeout | integer | 是 | 实例查询超时时间。 | 60 |
| ExportTimeout | integer | 是 | 实例导出超时时间。 | 600 |
| DataLinkName | string | 否 | 输入跨库查询 datalink 名称。 说明
| datalink_test |
| DdlOnline | integer | 否 | 实例是否开启无锁结构变更，取值如下：
| 0 |
| UseDsql | integer | 否 | 是否启用跨实例查询，取值如下：
说明
支持的数据库类型：MySQL、SQL Server、PostgreSQL、PolarDB PostgreSQL 版（兼容 Oracle）、Redis。
| 0 |
| InstanceId | string | 是 | 实例 ID，可通过调用接口 GetInstance 获取该参数的值。 | 126**** |
| SkipTest | boolean | 否 | 实例是否忽略测试连通性。取值如下：
| false |
| EnableSellSitd | string | 否 |
| Y |
| TemplateId | long | 否 | 更新分类分级模板 ID。您可以调用 ListClassificationTemplates 接口获取该参数的值。 | 3*** |
| TemplateType | string | 否 | 更新分类分级模板类型。您可以调用 ListClassificationTemplates 接口获取该参数的值。 | INNER |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "E9BEBF41-4F69-4605-A5D5-A67955173941",
"ErrorCode": "UnknownError",
"ErrorMessage": "UnknownError",
"Success": false
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|