RegisterInstanceRequest (dms_enterprise20181101 1.68.1 API)

java.lang.Object
- com.aliyun.tea.TeaModel
- - com.aliyun.dms_enterprise20181101.models.RegisterInstanceRequest

public class RegisterInstanceRequest
extends com.aliyun.tea.TeaModel

字段概要

字段
限定符和类型	字段和说明
`String`	`databasePassword` The password that is used to log on to the database.
`String`	`databaseUser` The account that is used to log on to the database.
`String`	`dataLinkName` The name of the database link for cross-database queries.
`Long`	`dbaUid` The ID of the user who assumes the DBA role of the database instance.
`String`	`dbaUidByString` The ID of the user who assumes the DBA role of the database instance.
`Integer`	`ddlOnline` Specifies whether to enable the lock-free schema change feature for the database instance.
`String`	`ecsInstanceId` The ID of the ECS instance on which the database instance is deployed.
`String`	`ecsRegion` The ID of the region in which the database instance resides.
`String`	`enableSellSitd` Y: enables the sensitive data protection feature NULL or other: disables the sensitive data protection feature example: Y
`String`	`envType` The type of the environment in which the database instance is deployed.
`Integer`	`exportTimeout` The timeout period for exporting data from the database instance.
`String`	`host` The host address that is used to connect to the database instance.
`String`	`instanceAlias` The alias of the database instance.
`String`	`instanceSource` The source of the database instance.
`String`	`instanceType` The type of the database.
`String`	`networkType` The network type of the database instance.
`Integer`	`port` The port that is used to connect to the database instance.
`Integer`	`queryTimeout` The timeout period for querying data in the database instance.
`String`	`safeRule` The name of the security rule set (GroupName) for the database instance.
`String`	`sid` The system ID (SID) of the database.
`Boolean`	`skipTest` Specifies whether to skip the connectivity test.
`Long`	`templateId` The ID of the classification template.
`String`	`templateType` The type of the classification template.
`Long`	`tid` The ID of the tenant.
`Integer`	`useDsql` Specifies whether to enable the cross-database query feature for the database instance.
`String`	`vpcId` The ID of the VPC to which the database instance belongs.

构造器概要

构造器
构造器和说明

RegisterInstanceRequest()

构造器
构造器和说明
`RegisterInstanceRequest()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static RegisterInstanceRequest`	`build(Map<String,?> map)`
`String`	`getDatabasePassword()`
`String`	`getDatabaseUser()`
`String`	`getDataLinkName()`
`Long`	`getDbaUid()`
`String`	`getDbaUidByString()`
`Integer`	`getDdlOnline()`
`String`	`getEcsInstanceId()`
`String`	`getEcsRegion()`
`String`	`getEnableSellSitd()`
`String`	`getEnvType()`
`Integer`	`getExportTimeout()`
`String`	`getHost()`
`String`	`getInstanceAlias()`
`String`	`getInstanceSource()`
`String`	`getInstanceType()`
`String`	`getNetworkType()`
`Integer`	`getPort()`
`Integer`	`getQueryTimeout()`
`String`	`getSafeRule()`
`String`	`getSid()`
`Boolean`	`getSkipTest()`
`Long`	`getTemplateId()`
`String`	`getTemplateType()`
`Long`	`getTid()`
`Integer`	`getUseDsql()`
`String`	`getVpcId()`
`RegisterInstanceRequest`	`setDatabasePassword(String databasePassword)`
`RegisterInstanceRequest`	`setDatabaseUser(String databaseUser)`
`RegisterInstanceRequest`	`setDataLinkName(String dataLinkName)`
`RegisterInstanceRequest`	`setDbaUid(Long dbaUid)`
`RegisterInstanceRequest`	`setDbaUidByString(String dbaUidByString)`
`RegisterInstanceRequest`	`setDdlOnline(Integer ddlOnline)`
`RegisterInstanceRequest`	`setEcsInstanceId(String ecsInstanceId)`
`RegisterInstanceRequest`	`setEcsRegion(String ecsRegion)`
`RegisterInstanceRequest`	`setEnableSellSitd(String enableSellSitd)`
`RegisterInstanceRequest`	`setEnvType(String envType)`
`RegisterInstanceRequest`	`setExportTimeout(Integer exportTimeout)`
`RegisterInstanceRequest`	`setHost(String host)`
`RegisterInstanceRequest`	`setInstanceAlias(String instanceAlias)`
`RegisterInstanceRequest`	`setInstanceSource(String instanceSource)`
`RegisterInstanceRequest`	`setInstanceType(String instanceType)`
`RegisterInstanceRequest`	`setNetworkType(String networkType)`
`RegisterInstanceRequest`	`setPort(Integer port)`
`RegisterInstanceRequest`	`setQueryTimeout(Integer queryTimeout)`
`RegisterInstanceRequest`	`setSafeRule(String safeRule)`
`RegisterInstanceRequest`	`setSid(String sid)`
`RegisterInstanceRequest`	`setSkipTest(Boolean skipTest)`
`RegisterInstanceRequest`	`setTemplateId(Long templateId)`
`RegisterInstanceRequest`	`setTemplateType(String templateType)`
`RegisterInstanceRequest`	`setTid(Long tid)`
`RegisterInstanceRequest`	`setUseDsql(Integer useDsql)`
`RegisterInstanceRequest`	`setVpcId(String vpcId)`

从类继承的方法 com.aliyun.tea.TeaModel
build, buildMap, confirmType, confirmType, parseObject, toMap, toMap, toModel, validate, validateParams

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - dataLinkName
```
@NameInMap(value="DataLinkName")
public String dataLinkName
```
    The name of the database link for cross-database queries.
    - This parameter is required if UseDsql is set to 1.
    - The name can contain only lowercase letters and underscores (_).
    - The name must be unique within a tenant.
    example:
    dblink_test
  - databasePassword
```
@NameInMap(value="DatabasePassword")
public String databasePassword
```
    The password that is used to log on to the database.
    
    This parameter is required.
    example:
  - databaseUser
```
@NameInMap(value="DatabaseUser")
public String databaseUser
```
    The account that is used to log on to the database.
    
    This parameter is required.
    example:
    dmstest
  - dbaUid
```
@NameInMap(value="DbaUid")
public Long dbaUid
```
    The ID of the user who assumes the DBA role of the database instance. You can call the ListUsers or GetInstance operation to query the user ID.
    
    This parameter is required.
    example:
    22275482072787****
  - dbaUidByString
```
@NameInMap(value="DbaUidByString")
public String dbaUidByString
```
    The ID of the user who assumes the DBA role of the database instance. If the user ID is a non-numeric value such as a role or an account, you can use this parameter to replace DbaUid.
    example:
    22275482072787****
  - ddlOnline
```
@NameInMap(value="DdlOnline")
public Integer ddlOnline
```
    Specifies whether to enable the lock-free schema change feature for the database instance. Valid values:
    - 0: disables the lock-free schema change feature.
    - 1: uses the online DDL of MySQL first.
    - 2: uses the lock-free schema change feature of DMS first.
    Supported database types: ApsaraDB RDS for MySQL, PolarDB for MySQL, ApsaraDB MyBase for MySQL, and third-party MySQL databases.
    
    example:
    2
  - ecsInstanceId
```
@NameInMap(value="EcsInstanceId")
public String ecsInstanceId
```
    The ID of the ECS instance on which the database instance is deployed.
    
    This parameter is required if the InstanceSource parameter is set to ECS_OWN.
    
    example:
    i-2zei9gs1t7h8l7ac****
  - ecsRegion
```
@NameInMap(value="EcsRegion")
public String ecsRegion
```
    The ID of the region in which the database instance resides.
    
    This parameter is required if the InstanceSource parameter is set to RDS, ECS_OWN, or VPC_IDC.
    
    example:
    cn-hangzhou
  - enableSellSitd
```
@NameInMap(value="EnableSellSitd")
public String enableSellSitd
```
    - Y: enables the sensitive data protection feature
    - NULL or other: disables the sensitive data protection feature
    example:
    Y
  - envType
```
@NameInMap(value="EnvType")
public String envType
```
    The type of the environment in which the database instance is deployed. Valid values:
    - product: production environment
    - dev: development environment
    - pre: pre-release environment
    - test: test environment
    - sit: system integration testing (SIT) environment
    - uat: user acceptance testing (UAT) environment
    - pet: stress testing environment
    - stag: staging environment
    This parameter is required.
    example:
    product
  - exportTimeout
```
@NameInMap(value="ExportTimeout")
public Integer exportTimeout
```
    The timeout period for exporting data from the database instance. Unit: seconds.
    
    This parameter is required.
    example:
    600
  - host
```
@NameInMap(value="Host")
public String host
```
    The host address that is used to connect to the database instance.
    
    This parameter is required.
    example:
    172.XX.XXX.254
  - instanceAlias
```
@NameInMap(value="InstanceAlias")
public String instanceAlias
```
    The alias of the database instance. Specify an alias that can help you identify the database instance in DMS.
    
    This parameter is required.
    example:
    Test instance
  - instanceSource
```
@NameInMap(value="InstanceSource")
public String instanceSource
```
    The source of the database instance. Valid values:
    - PUBLIC_OWN: a self-managed database instance that is deployed on the Internet
    - RDS: an ApsaraDB RDS instance
    - ECS_OWN: a self-managed database that is deployed on an Elastic Compute Service (ECS) instance
    - VPC_IDC: a self-managed database instance that is deployed in a data center connected over a virtual private cloud (VPC)
    This parameter is required.
    example:
    RDS
  - instanceType
```
@NameInMap(value="InstanceType")
public String instanceType
```
    The type of the database. For more information about the valid values of this parameter, see DbType parameter.
    
    This parameter is required.
    example:
    MySQL
  - networkType
```
@NameInMap(value="NetworkType")
public String networkType
```
    The network type of the database instance. Valid values:
    - CLASSIC: classic network
    - VPC: VPC
    This parameter is required.
    example:
    VPC
  - port
```
@NameInMap(value="Port")
public Integer port
```
    The port that is used to connect to the database instance.
    
    This parameter is required.
    example:
    3306
  - queryTimeout
```
@NameInMap(value="QueryTimeout")
public Integer queryTimeout
```
    The timeout period for querying data in the database instance. Unit: seconds.
    
    This parameter is required.
    example:
    60
  - safeRule
```
@NameInMap(value="SafeRule")
public String safeRule
```
    The name of the security rule set (GroupName) for the database instance. You can call the ListStandardGroups or GetInstance operation to query the name of the security rule set.
    
    This parameter is required.
    example:
    Test
  - sid
```
@NameInMap(value="Sid")
public String sid
```
    The system ID (SID) of the database.
    
    This parameter is required if the InstanceType parameter is set to ORACLE.
    
    example:
    XXX
  - skipTest
```
@NameInMap(value="SkipTest")
public Boolean skipTest
```
    Specifies whether to skip the connectivity test. Valid values:
    - true: skips the connectivity test
    - false: does not skip the connectivity test
    example:
    true
  - templateId
```
@NameInMap(value="TemplateId")
public Long templateId
```
    The ID of the classification template. You can call the ListClassificationTemplates operation to query the template ID.
    example:
    31***
  - templateType
```
@NameInMap(value="TemplateType")
public String templateType
```
    The type of the classification template. You can call the ListClassificationTemplates operation to query the template type.
    example:
    INNER
  - tid
```
@NameInMap(value="Tid")
public Long tid
```
    The ID of the tenant. You can call the GetUserActiveTenant operation to query the tenant ID.
    example:
    3***
  - useDsql
```
@NameInMap(value="UseDsql")
public Integer useDsql
```
    Specifies whether to enable the cross-database query feature for the database instance. Valid values:
    - 0: disables the cross-database query feature.
    - 1: enables the cross-database query feature.
    Supported database types: MySQL, SQL Server, PostgreSQL, PolarDB for PostgreSQL (compatible with Oracle), and ApsaraDB for Redis.
    
    example:
    1
  - vpcId
```
@NameInMap(value="VpcId")
public String vpcId
```
    The ID of the VPC to which the database instance belongs.
    
    This parameter is required if the InstanceSource parameter is set to VPC_IDC.
    
    example:
    vpc-xxxxxxxxxxxxxxxxxxxxx
- 构造器详细资料
  - RegisterInstanceRequest
```
public RegisterInstanceRequest()
```
- 方法详细资料
  - build
```
public static RegisterInstanceRequest build(Map<String,?> map)
                                     throws Exception
```
    抛出:
    
    Exception
  - setDataLinkName
```
public RegisterInstanceRequest setDataLinkName(String dataLinkName)
```
  - getDataLinkName
```
public String getDataLinkName()
```
  - setDatabasePassword
```
public RegisterInstanceRequest setDatabasePassword(String databasePassword)
```
  - getDatabasePassword
```
public String getDatabasePassword()
```
  - setDatabaseUser
```
public RegisterInstanceRequest setDatabaseUser(String databaseUser)
```
  - getDatabaseUser
```
public String getDatabaseUser()
```
  - setDbaUid
```
public RegisterInstanceRequest setDbaUid(Long dbaUid)
```
  - getDbaUid
```
public Long getDbaUid()
```
  - setDbaUidByString
```
public RegisterInstanceRequest setDbaUidByString(String dbaUidByString)
```
  - getDbaUidByString
```
public String getDbaUidByString()
```
  - setDdlOnline
```
public RegisterInstanceRequest setDdlOnline(Integer ddlOnline)
```
  - getDdlOnline
```
public Integer getDdlOnline()
```
  - setEcsInstanceId
```
public RegisterInstanceRequest setEcsInstanceId(String ecsInstanceId)
```
  - getEcsInstanceId
```
public String getEcsInstanceId()
```
  - setEcsRegion
```
public RegisterInstanceRequest setEcsRegion(String ecsRegion)
```
  - getEcsRegion
```
public String getEcsRegion()
```
  - setEnableSellSitd
```
public RegisterInstanceRequest setEnableSellSitd(String enableSellSitd)
```
  - getEnableSellSitd
```
public String getEnableSellSitd()
```
  - setEnvType
```
public RegisterInstanceRequest setEnvType(String envType)
```
  - getEnvType
```
public String getEnvType()
```
  - setExportTimeout
```
public RegisterInstanceRequest setExportTimeout(Integer exportTimeout)
```
  - getExportTimeout
```
public Integer getExportTimeout()
```
  - setHost
```
public RegisterInstanceRequest setHost(String host)
```
  - getHost
```
public String getHost()
```
  - setInstanceAlias
```
public RegisterInstanceRequest setInstanceAlias(String instanceAlias)
```
  - getInstanceAlias
```
public String getInstanceAlias()
```
  - setInstanceSource
```
public RegisterInstanceRequest setInstanceSource(String instanceSource)
```
  - getInstanceSource
```
public String getInstanceSource()
```
  - setInstanceType
```
public RegisterInstanceRequest setInstanceType(String instanceType)
```
  - getInstanceType
```
public String getInstanceType()
```
  - setNetworkType
```
public RegisterInstanceRequest setNetworkType(String networkType)
```
  - getNetworkType
```
public String getNetworkType()
```
  - setPort
```
public RegisterInstanceRequest setPort(Integer port)
```
  - getPort
```
public Integer getPort()
```
  - setQueryTimeout
```
public RegisterInstanceRequest setQueryTimeout(Integer queryTimeout)
```
  - getQueryTimeout
```
public Integer getQueryTimeout()
```
  - setSafeRule
```
public RegisterInstanceRequest setSafeRule(String safeRule)
```
  - getSafeRule
```
public String getSafeRule()
```
  - setSid
```
public RegisterInstanceRequest setSid(String sid)
```
  - getSid
```
public String getSid()
```
  - setSkipTest
```
public RegisterInstanceRequest setSkipTest(Boolean skipTest)
```
  - getSkipTest
```
public Boolean getSkipTest()
```
  - setTemplateId
```
public RegisterInstanceRequest setTemplateId(Long templateId)
```
  - getTemplateId
```
public Long getTemplateId()
```
  - setTemplateType
```
public RegisterInstanceRequest setTemplateType(String templateType)
```
  - getTemplateType
```
public String getTemplateType()
```
  - setTid
```
public RegisterInstanceRequest setTid(Long tid)
```
  - getTid
```
public Long getTid()
```
  - setUseDsql
```
public RegisterInstanceRequest setUseDsql(Integer useDsql)
```
  - getUseDsql
```
public Integer getUseDsql()
```
  - setVpcId
```
public RegisterInstanceRequest setVpcId(String vpcId)
```
  - getVpcId
```
public String getVpcId()
```

类 RegisterInstanceRequest

字段概要

构造器概要

方法概要

从类继承的方法 com.aliyun.tea.TeaModel

从类继承的方法 java.lang.Object

字段详细资料

dataLinkName

databasePassword

databaseUser

dbaUid

dbaUidByString

ddlOnline

ecsInstanceId

ecsRegion

enableSellSitd

envType

exportTimeout

host

instanceAlias

instanceSource

instanceType

networkType

port

queryTimeout

safeRule

sid

skipTest

templateId

templateType

tid

useDsql

vpcId

构造器详细资料

RegisterInstanceRequest

方法详细资料

build

setDataLinkName

getDataLinkName

setDatabasePassword

getDatabasePassword

setDatabaseUser

getDatabaseUser

setDbaUid

getDbaUid

setDbaUidByString

getDbaUidByString

setDdlOnline

getDdlOnline

setEcsInstanceId

getEcsInstanceId

setEcsRegion

getEcsRegion

setEnableSellSitd

getEnableSellSitd

setEnvType

getEnvType

setExportTimeout

getExportTimeout

setHost

getHost

setInstanceAlias

getInstanceAlias

setInstanceSource

getInstanceSource

setInstanceType

getInstanceType

setNetworkType

getNetworkType

setPort

getPort

setQueryTimeout

getQueryTimeout

setSafeRule

getSafeRule

setSid

getSid

setSkipTest

getSkipTest

setTemplateId