RegisterInstance

As the DMS of , administrator or DBA Enterprise Edition users You can call this operation to add database instances to your enterprise. For more information, see the administrator and DBA roles in the system management> user management section.

Request parameters

Response parameters

Examples

Sample request

     http(s)://[Endpoint]/? Action=RegisterInstance &Tid=-1 &InstanceType=MySQL &InstanceSource=RDS &NetworkType=VPC &EnvType=product &Host=dmstest.rds.aliyun.com &Port=3306 &DatabaseUser=dmstest &DatabasePassword=password &InstanceAlias=test instance&DbaUid=12345678 &SafeRule=Test Usage&QueryTimeout=60&expouce=port600&<common request parameters> 
   

Sample success responses

XML format

     <RegisterInstanceResponse> <RequestId>D4F02899-CE79-4DFD-9893-5217DA70B363</RequestId> <Success>true</Success> </RegisterInstanceResponse> 
   

JSON

     { "RequestId": "F4E2A94B-604F-43FF-93E7-F4EE3DCF412E", "Success": true } 
   

Error codes

For more information about error codes, see error center.

Python SDK example

The following example shows how to add a database instance in VPC.

     # coding=utf-8 from aliyunsdkcore.client import AcsClient from aliyunsdkdms_enterprise.request.v20181101.RegisterInstanceRequest import RegisterInstanceRequest client = AcsClient( "<your-access-key-id> <your-access-key-secret>", "<your-region-id>")# Example for registering a VPC_IDC instance: request = RegisterInstanceRequest() # tenant ID request.set_Tid(1) # instance host request.set_Host("192.168.16.113")# instance port request.set_Port(3314) # instance db type such as: MySQL request.set_InstanceType("MySQL")# instance Source: VPC_IDC request.set_InstanceSource("VPC_IDC") # network type: type: eg : VPC request.set_NetworkType("VPC") request.set_EnvType("PRODUCT") # request.set_EcsInstanceId()# instance vpc id request.set_VpcId("VPC ID") # instance ecs region eg: cn-hangzhou request.set_EcsRegion("ecs region") # request.set_Sid(); # Logon username request.set_DatabaseUser for the instance db ("instance db logon username") # logon password request.set_DatabasePassword for the instance ("instance db logon password") # The alias of the instance. This function is used to distinguish instance request.set_InstanceAlias("instance Alias") in the DMS enterprise console.# The Alibaba Cloud uid of the dba of the database instance. This user must be added in the DMS enterprise console or through the DMS Enterprise API in advance. request.set_DbaUid(-1) request.set_SafeRule("The rule name ") request.set_QueryTimeout(60) request.set_ExportTimeout(600) response = client.do_action_with_exception(request) print response of the security rule configured in DMS Enterprise