文档

ModifyInstance - 修改实例信息

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdstring

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

183****
Tidlong

租户 ID。

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

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

MySQL
InstanceSourcestring

实例来源,取值如下:

  • PUBLIC_OWN:表示公网自建实例。
  • RDS:表示 RDS 实例。
  • ECS_OWN:表示 ECS 自建实例。
  • VPC_IDC:表示 VPC IDC 自建实例。
RDS
NetworkTypestring

网络类型,取值如下:

  • CLASSIC:经典网络。
  • VPC:VPC 网络。
VPC
EnvTypestring

环境类型,取值如下:

  • product:生产环境。
  • dev:开发环境。
  • pre:预发环境。
  • test:测试环境。
  • sit:SIT 环境。
  • uat:UAT 环境。
  • pet:压测环境。
  • stag:STAG 环境。
dev
EcsInstanceIdstring

ECS 的实例 ID。

说明 如果 InstanceSource 取值为 ECS_OWN,此值必填。
i-2zei9gs1t7h8l7ac****
VpcIdstring

实例 VPC ID。

说明 如果 InstanceSource 取值为 VPC_IDC 时,此值必填。
vpc-bp10wnlcmor****
EcsRegionstring

实例所在地域。

说明 如果 InstanceSource 取值为 RDS、ECS_OWN 或 VPC_IDC,此值必填。
cn-hangzhou
Hoststring

实例连接地址。

192.XXX.0.56
Portinteger

实例访问端口。

3306
Sidstring

实例 Sid。

说明 如果 InstanceType 为 ORACLE,此项必填。
testSid
DatabaseUserstring

数据库账号。

testsdb
DatabasePasswordstring

数据库密码。

test***
InstanceAliasstring

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

instance_test
DbaIdlong

实例 DBA 角色的用户 ID,可调用接口 ListUsersGetInstance 获取该参数的值。

27****
QueryTimeoutinteger

查询超时时间,单位:s(秒)。

7200
ExportTimeoutinteger

导出超时时间,单位:s(秒)。

86400
EnableSellTruststring

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

  • Y:开启安全托管模式。
  • NULL 或其它:不开启安全托管模式。
Y
EnableSellStablestring

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

  • Y:开通。
  • NULL 或其它:不开通。
NULL
EnableSellCommonstring

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

  • Y:开启。
  • NULL 或其它:不开启。
Y
SafeRulestring

若您需要开通安全协同功能包,则需要为该实例设置安全规则集(GroupName)。您可调用 ListStandardGroupsGetInstance 接口获取该参数的值。

金融线-生产
EnableSellSitdstring

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

  • Y:开启敏感数据保护。
  • NULL 或其它:不开启敏感数据保护。
Y
DataLinkNamestring

输入跨库查询 datalink 名称。

说明
  • 如果 UseDsql 取值为 1,此值必填。
  • DBLink 名称只能使用小写字母和下划线(_)。
  • DBLink 名称需要在租户内保持全局唯一性。
  • dblink_test
    DdlOnlineinteger

    是否开启结构变更优先,取值如下:

    • 0 :不使用。
    • 1 :原生 Online DDL 优先。
    • 2 :DMS 无锁表结构变更优先。
    说明 支持的数据库类型:RDS MySQL、PolarDB MySQL 引擎、MyBase MySQL、其他来源 MySQL。
    2
    UseDsqlinteger

    是否启用跨实例查询,取值如下:

    • 0:不开启。
    • 1:开启。
    说明 支持的数据库类型:MySQL、SQL Server、PostgreSQL、PolarDB O 引擎、Redis。
    1
    SkipTestboolean

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

    • true:忽略。
    • false:不忽略。
    false
    TemplateIdlong

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

    31***
    TemplateTypestring

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

    INNER
    UseSslinteger

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

    • 0:默认值(DMS 与数据库服务自动协商是否开启)系统将自动识别目标数据库是否已开启 SSL 连接,若数据库已开启 SSL 连接,则 DMS 将通过 SSL 连接数据库;若数据库未开启 SSL 连接,则通过普通方式进行连接。
    • 1:开启 SSL 连接。若数据库未开启 SSL 连接,则该参数无效。
    • -1:关闭 SSL 连接。
    说明
  • 该配置项仅在数据库为 MySQL 或 Redis 时出现。
  • SSL(Secure Sockets Layer)能在传输层对网络连接进行加密,提升通信数据的安全性和完整性,但会增加网络连接响应时间。
  • 0

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

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

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

    错误码。

    UnknownError
    ErrorMessagestring

    错误信息。

    UnknownError
    Successboolean

    请求是否成功,返回值如下:

    • true:请求成功。
    • false:请求失败。
    true

    示例

    正常返回示例

    JSON格式

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

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2024-03-20OpenAPI 入参发生变更查看变更详情