全部产品
Search

搜索本产品

    数据管理 DMS：ModifyInstance - 修改实例信息

    文档中心

    数据管理 DMS：ModifyInstance - 修改实例信息

    更新时间：Aug 28, 2026

    当您需要修改实例的托管模式、数据库账密、功能包等基本信息，及环境类型、实例在DMS的名称、查询和导出数据的超时时间等高级信息时，可调用该API。

    调试

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

    调试

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    dms:ModifyInstance

    update

    *全部资源

    *

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    InstanceId

    string

    是

    实例 ID。您可调用 ListInstances 或 GetInstance 接口获取该参数的值。

    183****
    Tid

    integer

    否

    租户的 ID。

    说明

    取自 DMS 控制台页面右上角头像处悬停展示的租户 ID 信息。

    23****

    InstanceType

    string

    否

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

    MySQL
    InstanceSource

    string

    否

    实例来源，取值如下：

    • PUBLIC_OWN：表示公网自建实例。

    • RDS：表示 RDS 实例。

    • ECS_OWN：表示 ECS 自建实例。

    • VPC_IDC：表示 VPC IDC 自建实例。

    RDS
    NetworkType

    string

    否

    网络类型，取值如下：

    • CLASSIC：经典网络。

    • VPC：VPC 网络。

    VPC
    EnvType

    string

    否

    环境类型，取值如下：

    • product：生产环境。

    • dev：开发环境。

    • pre：预发环境。

    • test：测试环境。

    • sit：SIT 环境。

    • uat：UAT 环境。

    • pet：压测环境。

    • stag：STAG 环境。

    dev
    EcsInstanceId

    string

    否

    ECS 的实例 ID。

    说明

    如果 InstanceSource 取值为 ECS_OWN，此值必填。

    i-2zei9gs1t7h8l7ac****
    VpcId

    string

    否

    实例 VPC ID。

    说明

    如果 InstanceSource 取值为 VPC_IDC 时，此值必填。

    vpc-bp10wnlcmor****
    EcsRegion

    string

    否

    实例所在地域。

    说明

    如果 InstanceSource 取值为 RDS、ECS_OWN 或 VPC_IDC，此值必填。

    cn-hangzhou
    Host

    string

    否

    实例连接地址。

    192.XXX.0.56
    Port

    integer

    否

    实例访问端口。

    3306
    Sid

    string

    否

    实例 Sid。

    说明

    如果 InstanceType 为 ORACLE，此项必填。

    testSid
    DatabaseUser

    string

    否

    数据库账号。

    testsdb

    DatabasePassword

    string

    否

    数据库密码。

    test***

    InstanceAlias

    string

    否

    实例别名，帮助用户快速区分定位该实例。

    instance_test
    DbaId

    integer

    否

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

    27****
    QueryTimeout

    integer

    否

    查询超时时间，单位：s（秒）。

    7200
    ExportTimeout

    integer

    否

    导出超时时间，单位：s（秒）。

    86400
    EnableSellTrust

    string

    否

    实例是否需要开启安全托管。

    • Y：开启安全托管模式。

    • N：不开启安全托管模式。

    Y
    EnableSellStable

    string

    否

    实例是否需要开通稳定变更功能。

    • Y：开通。

    • N：不开通。

    N
    EnableSellCommon

    string

    否

    实例是否需要开通安全协同功能。

    • Y：开启。

    • N：不开启。

    Y
    SafeRule

    string

    否

    若您需要开通安全协同功能包，则需要为该实例设置安全规则集（GroupName）。您可调用 ListStandardGroups 或 GetInstance 接口获取该参数的值。

    Finance-production
    EnableSellSitd

    string

    否

    是否需要为该实例开启敏感数据保护功能。

    • Y：开启敏感数据保护。

    • N：不开启敏感数据保护。

    Y
    DataLinkName

    string

    否

    输入跨库查询 datalink 名称。

    说明

    • 如果 UseDsql 取值为 1，此值必填。

    • DBLink 名称只能使用小写字母和下划线（_）。

    • DBLink 名称需要在租户内保持全局唯一性。

    dblink_test
    DdlOnline

    integer

    否

    是否开启结构变更优先，取值如下：

    • 0 ：不使用。

    • 1 ：原生 Online DDL 优先。

    • 2 ：DMS 无锁表结构变更优先。

    说明

    支持的数据库类型：RDS MySQL、PolarDB MySQL 引擎、MyBase MySQL、其他来源 MySQL。

    2
    UseDsql

    integer

    否

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

    • 0：不开启。

    • 1：开启。

    说明

    支持的数据库类型：MySQL、SQL Server、PostgreSQL、PolarDB O 引擎、Redis。

    1
    SkipTest

    boolean

    否

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

    • true：忽略。

    • false：不忽略。

    false
    TemplateId

    integer

    否

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

    31***
    TemplateType

    string

    否

    分类分级模板类型。您可调用 ListClassificationTemplates 获取该参数的值。

    INNER
    UseSsl

    integer

    否

    选择是否开启 SSL 连接，开启后，DMS 将通过 SSL 连接到数据库。使用该参数的前提是数据库已开启 SSL 连接，当前支持如下选项：

    • 0：默认值（DMS 与数据库服务自动协商是否开启）系统将自动识别目标数据库是否已开启 SSL 连接，若数据库已开启 SSL 连接，则 DMS 将通过 SSL 连接数据库；若数据库未开启 SSL 连接，则通过普通方式进行连接。

    • 1：开启 SSL 连接。若数据库未开启 SSL 连接，则该参数无效。

    • -1：关闭 SSL 连接。

    说明

    • 该配置项仅在数据库为 MySQL 或 Redis 时出现。

    • SSL（Secure Sockets Layer）能在传输层对网络连接进行加密，提升通信数据的安全性和完整性，但会增加网络连接响应时间。

    0

    返回参数

    名称

    类型

    描述

    示例值

    object

    RequestId

    string

    请求的 ID。用于定位日志，排查问题。

    0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
    ErrorCode

    string

    错误码。

    UnknownError
    ErrorMessage

    string

    错误信息。

    UnknownError
    Success

    boolean

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

    • true：请求成功。

    • false：请求失败。

    true

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

    错误码

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

    变更历史

    更多信息，参考变更详情。