当您需要修改实例的托管模式、数据库账密、功能包等基本信息,及环境类型、实例在DMS的名称、查询和导出数据的超时时间等高级信息时,可调用该API。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 实例 ID。您可调用 ListInstances 或 GetInstance 接口获取该参数的值。 | 183**** |
Tid | long | 否 | 租户 ID。 说明
取自 DMS 控制台页面右上角头像处悬停展示的租户 ID 信息。
| 23**** |
InstanceType | string | 否 | 数据库类型,取值请参见 DbType 参数说明。 | MySQL |
InstanceSource | string | 否 | 实例来源,取值如下:
| RDS |
NetworkType | string | 否 | 网络类型,取值如下:
| VPC |
EnvType | string | 否 | 环境类型,取值如下:
| 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 | long | 否 | 实例 DBA 角色的用户 ID,可调用接口 ListUsers 或 GetInstance 获取该参数的值。 | 27**** |
QueryTimeout | integer | 否 | 查询超时时间,单位:s(秒)。 | 7200 |
ExportTimeout | integer | 否 | 导出超时时间,单位:s(秒)。 | 86400 |
EnableSellTrust | string | 否 | 实例是否需要开启安全托管。
| Y |
EnableSellStable | string | 否 | 实例是否需要开通稳定变更功能。
| NULL |
EnableSellCommon | string | 否 | 实例是否需要开通安全协同功能。
| Y |
SafeRule | string | 否 | 若您需要开通安全协同功能包,则需要为该实例设置安全规则集(GroupName)。您可调用 ListStandardGroups 或 GetInstance 接口获取该参数的值。 | 金融线-生产 |
EnableSellSitd | string | 否 | 是否需要为该实例开启敏感数据保护功能。
| Y |
DataLinkName | string | 否 | 输入跨库查询 datalink 名称。 说明
| dblink_test |
DdlOnline | integer | 否 | 是否开启结构变更优先,取值如下:
说明
支持的数据库类型:RDS MySQL、PolarDB MySQL 引擎、MyBase MySQL、其他来源 MySQL。
| 2 |
UseDsql | integer | 否 | 是否启用跨实例查询,取值如下:
说明
支持的数据库类型:MySQL、SQL Server、PostgreSQL、PolarDB O 引擎、Redis。
| 1 |
SkipTest | boolean | 否 | 实例是否忽略测试连通性。取值如下:
| false |
TemplateId | long | 否 | 分类分级模板 ID。您可调用 ListClassificationTemplates 接口获取该参数的值。 | 31*** |
TemplateType | string | 否 | 分类分级模板类型。您可调用 ListClassificationTemplates 获取该参数的值。 | INNER |
UseSsl | integer | 否 | 选择是否开启 SSL 连接,开启后,DMS 将通过 SSL 连接到数据库。使用该参数的前提是数据库已开启 SSL 连接,当前支持如下选项:
说明
| 0 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
"ErrorCode": "UnknownError",
"ErrorMessage": "UnknownError",
"Success": true
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-03-20 | OpenAPI 入参发生变更 | 查看变更详情 |