接入数据库实例的API接口_数据库自治服务(DAS)-阿里云帮助中心

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

接口说明

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

使用阿里云或 DAS 的 SDK 时，建议使用最新版本。
在使用 SDK 调用 DAS 服务时，需要将地域指定为 cn-shanghai。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
__context	string	否	备用参数。	None
InstanceArea	string	是	实例所属的数据库产品，取值： RDS：云实例。 ECS：ECS 自建实例。 IDC：非公有云自建实例。说明 IDC 为用户数据中心。	ECS
InstanceId	string	否	实例 ID。	rm-2ze1jdv45i7l6****
Ip	string	否	待接入实例的内网连接地址。	rm-2ze1jdv45i7l6****.mysql.rds.aliyuncs.com
Port	string	否	实例的内网连接端口。	3306
Engine	string	否	数据库引擎，取值： MySQL PostgreSQL SQLServer PolarDBMySQL PolarDBPostgreSQL Redis MongoDB PolarDBOracle PolarDBX	MySQL
Username	string	否	用户名。	test****
Password	string	否	用户名的密码。	122****
InstanceAlias	string	否	实例名称。	yuecq--test****
NetworkType	string	否	实例的网络类型。	VPC
VpcId	string	否	VPC ID。	vpc-m5e666n89m2bx8jar****
Region	string	否	实例所属的地域。	cn-hangzhou
FlushAccount	string	否	备用参数。	None

返回参数

名称	类型	描述	示例值
	object
Message	string	请求返回消息。说明请求成功时该参数返回 Successful，请求失败时会返回请求异常信息（如错误码等）。	Successful
RequestId	string	请求 ID。	B6D17591-B48B-4D31-9CD6-9B9796B2****
Synchro	string	备用参数。	None
Data	object	详细信息列表，包括信息总数、错误码等。
VpcId	string	VPC ID。	vpc-m5e666n89m2bx8jar****
Token	string	客户端 token（即自定义的唯一随机字符串）。	tokenID
Ip	string	实例的 IP 连接地址。	rm-de21209****.mysql.rds.aliyuncs.com
CallerUid	string	调用者用户 ID。	31063db679****
InstanceId	string	实例的 ID。	rm-2ze1jdv45i7l6****
Port	integer	目标实例的端口。	3306
OwnerId	string	所有者 ID。	325352345
Uuid	string	实例的唯一标识符号。	hdm_3063db6792965c080a4bcb6e6304****
Error	string	错误消息。	InvalidRequestURL
Code	integer	返回的状态码。	200
Role	string	角色信息。	master
TenantId	string	所属的租户 ID。	L0EPfLS**=SCE00000***
Code	string	返回的状态码。	200
Success	string	请求是否执行成功： true：执行成功。 false：执行失败。	true

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParams	The request parameters are invalid.	请求参数错误
403	NoPermission	You are not authorized to do this action.	没有权限执行该操作

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史