调用AddHDMInstance接口，将数据库实例接入DAS。

使用该接口需满足以下前提条件：

  • 在使用阿里云SDK时，需要保证aliyun-sdk-core的版本大于4.3.3，建议使用最新版本。
  • 使用DAS的SDK的版本为1.0.2或以上。
  • 在使用SDK调用DAS服务时，需要将地域指定为cn-shanghai。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 AddHDMInstance

系统规定参数。取值：AddHDMInstance。

__context String 否 None

备用参数。
InstanceArea String 否 ECS

实例所属的数据库产品，取值：

  • RDS：云实例。
  • ECS：ECS自建实例。
  • IDC：非公有云自建实例。
说明 IDC为用户数据中心。
InstanceId String 否 rm-2ze1jdv45i7l6****

实例ID。
Ip String 否 rm-2ze1jdv45i7l6****.mysql.rds.aliyuncs.com

待接入实例的内网连接地址。
Port String 否 3306

实例的内网连接端口。
Engine String 否 MySQL

数据库引擎，取值：

  • MySQL
  • PostgreSQL
  • SQLServer
  • PolarDBMySQL
  • PolarDBPostgreSQL
  • Redis
  • MongoDB
  • PolarDBOracle
  • PolarDBX
Username String 否 test****

用户名。
Password String 否 122****

用户名的密码。
InstanceAlias String 否 yuecq--test****

实例名称。
NetworkType String 否 VPC

实例的网络类型。
VpcId String 否 vpc-m5e666n89m2bx8jar****

VPC ID。
Region String 否 cn-hangzhou

实例所属的地域。
FlushAccount String 否 None

备用参数。

返回数据

名称 类型 示例值 描述
Message String Successful

请求返回消息。

说明 请求成功时该参数返回Successful，请求失败时会返回请求异常信息（如错误码等）。
RequestId String B6D17591-B48B-4D31-9CD6-9B9796B2****

请求ID。
Synchro String None

备用参数。
Data Object

详细信息列表，包括信息总数、错误码等。
VpcId String vpc-m5e666n89m2bx8jar****

VPC ID。
Token String 1111111

客户端token（即自定义的唯一随机字符串）。
Ip String rm-de21209****.mysql.rds.aliyuncs.com

实例的IP连接地址。
CallerUid String 11111111111

调用者用户ID。
InstanceId String rm-2ze1jdv45i7l6****

实例的ID。
Port Integer 3306

目标实例的端口。
OwnerId String 325352345

所有者ID。
Uuid String hdm_3063db6792965c080a4bcb6e6304****

实例的唯一标识符号。
Error String InvalidRequestURL

错误消息。
Code Integer 200

返回的状态码。
Role String master

角色信息。
TenantId String L0EPfLS****=SCE00000*****

所属的租户ID。
Code String 200

返回的状态码。
Success String true

请求是否执行成功：

  • true：执行成功。
  • false：执行失败。

示例

请求示例

http(s)://cn-shanghai.aliyuncs.com/?Action=AddHDMInstance
&InstanceArea=RDS
&InstanceId=rm-2ze1jdv45i7l6****
&Ip=rm-2ze1jdv45i7l6****.mysql.rds.aliyuncs.com
&Port=3306
&Engine=MySQL
&Username=test****
&Password=122****
&InstanceAlias=yuecq--test****
&NetworkType=VPC
&VpcId=vpc-m5e666n89m2bx8jar****
&Region=cn-hangzhou
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<AddHDMInstanceResponse>
    <Message>Successful</Message>
    <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>
    <Synchro>None</Synchro>
    <Data>
        <VpcId>vpc-m5e666n89m2bx8jar****</VpcId>
        <Token>1111111</Token>
        <Ip>rm-de21209****.mysql.rds.aliyuncs.com</Ip>
        <CallerUid>11111111111</CallerUid>
        <InstanceId>rm-2ze1jdv45i7l6****</InstanceId>
        <Port>3306</Port>
        <OwnerId>325352345</OwnerId>
        <Uuid>hdm_3063db6792965c080a4bcb6e6304****</Uuid>
        <Error>InvalidRequestURL</Error>
        <Code>200</Code>
        <Role>master</Role>
        <TenantId>L0EPfLS****=SCE00000*****</TenantId>
    </Data>
    <Code>200</Code>
    <Success>true</Success>
</AddHDMInstanceResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Message" : "Successful",
  "RequestId" : "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Synchro" : "None",
  "Data" : {
    "VpcId" : "vpc-m5e666n89m2bx8jar****",
    "Token" : "1111111",
    "Ip" : "rm-de21209****.mysql.rds.aliyuncs.com",
    "CallerUid" : "11111111111",
    "InstanceId" : "rm-2ze1jdv45i7l6****",
    "Port" : 3306,
    "OwnerId" : "325352345",
    "Uuid" : "hdm_3063db6792965c080a4bcb6e6304****",
    "Error" : "InvalidRequestURL",
    "Code" : 200,
    "Role" : "master",
    "TenantId" : "L0EPfLS****=SCE00000*****"
  },
  "Code" : "200",
  "Success" : "true"
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidParams The request parameters are invalid. 请求参数错误

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