流控信息
请求参数
| 字段名称 | 字段详情 |
|---|---|
InstanceIdstring | 实例 ID。您可调用 ListInstances 或 GetInstance 接口获取该参数的值。 示例值:183****参考取值来源: GetInstance ListInstances |
Tidinteger<int64> | |
InstanceTypestring | 数据库类型，取值请参见 DbType 参数说明。 示例值:MySQL参考取值来源: GetInstance AddInstance RegisterInstance ListInstances |
InstanceSourcestring | 实例来源，取值如下：展开详情 示例值:RDS参考取值来源: GetInstance RegisterInstance AddInstance ListInstances |
NetworkTypestring | 网络类型，取值如下：展开详情 示例值:VPC |
EnvTypestring | 环境类型，取值如下：展开详情 示例值:dev |
EcsInstanceIdstring | ECS 的实例 ID。展开详情 示例值:i-2zei9gs1t7h8l7ac****参考取值来源: ListInstances GetInstance |
VpcIdstring | 实例 VPC ID。展开详情 示例值:vpc-bp10wnlcmor**** |
EcsRegionstring | 实例所在地域。展开详情 示例值:cn-hangzhou |
Hoststring | 实例连接地址。 示例值:192.XXX.0.56 |
Portinteger<int32> | 实例访问端口。 示例值:3306 |
Sidstring | 实例 Sid。展开详情 示例值:testSid |
DatabaseUserstring | 数据库账号。 示例值:testsdb
|
DatabasePasswordstring | 数据库密码。 示例值:test***
|
InstanceAliasstring | 实例别名，帮助用户快速区分定位该实例。 示例值:instance_test参考取值来源: ListInstances AddInstance RegisterInstance GetInstance |
DbaIdinteger<int64> | 实例 DBA 角色的用户 ID，可调用接口 ListUsers 或 GetInstance 获取该参数的值。 注意
该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。 示例值:27**** |
QueryTimeoutinteger<int32> | 查询超时时间，单位：s（秒）。 示例值:7200 |
ExportTimeoutinteger<int32> | 导出超时时间，单位：s（秒）。 示例值:86400 |
EnableSellTruststring | 实例是否需要开启安全托管。展开详情 示例值:Y |
EnableSellStablestring | 实例是否需要开通稳定变更功能。展开详情 示例值:NULL |
EnableSellCommonstring | 实例是否需要开通安全协同功能。展开详情 示例值:Y |
SafeRulestring | 若您需要开通安全协同功能包，则需要为该实例设置安全规则集（GroupName）。您可调用 ListStandardGroups 或 GetInstance 接口获取该参数的值。 示例值:金融线-生产 |
EnableSellSitdstring | 是否需要为该实例开启敏感数据保护功能。展开详情 示例值:Y |
DataLinkNamestring | 输入跨库查询 datalink 名称。展开详情 示例值:dblink_test |
DdlOnlineinteger<int32> | 是否开启结构变更优先，取值如下：展开详情 示例值:2枚举值:012 |
UseDsqlinteger<int32> | 是否启用跨实例查询，取值如下：展开详情 示例值:1枚举值:01 |
SkipTestboolean | 实例是否忽略测试连通性。取值如下：展开详情 示例值:false |
TemplateIdinteger<int64> | 分类分级模板 ID。您可调用 ListClassificationTemplates 接口获取该参数的值。 注意
该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。 示例值:31***参考取值来源: AddAuthorityTemplateItems UpdateAuthorityTemplate ListAuthorityTemplate CreateAuthorityTemplate GetClassificationTemplate |
TemplateTypestring | 分类分级模板类型。您可调用 ListClassificationTemplates 获取该参数的值。 示例值:INNER参考取值来源: GetClassificationTemplate ListClassificationTemplates |
UseSslinteger<int32> | 选择是否开启 SSL 连接，开启后，DMS 将通过 SSL 连接到数据库。使用该参数的前提是数据库已开启 SSL 连接，当前支持如下选项：展开详情 示例值:0取值 <= 1 |
返回参数
| 字段名称 | 字段详情 |
|---|---|
RequestIdstring | 请求的 ID。用于定位日志，排查问题。 示例值:0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931 |
ErrorCodestring | 错误码。 示例值:UnknownError |
ErrorMessagestring | 错误信息。 示例值:UnknownError |
Successboolean | 请求是否成功，返回值如下：展开详情 示例值:true |
返回示例
变更历史
| 变更时间 | 变更内容概要 | 操作 | |
|---|---|---|---|
| 2024-03-20 |