通过AccessHDMInstance接口接入实例。

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

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

请求参数

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

系统规定参数。取值:AccessHDMInstance

Uid String hdm_df02bbfd3bd64c7bb1982e5323a6****

账号ID,您可在阿里云账号管理安全设置页面获取登录账号的ID。

accessKey String None

备用参数。

signature String None

备用参数。

timestamp String None

备用参数。

__context String None

备用参数。

skipAuth String None

备用参数。

UserId String None

备用参数。

InstanceArea String RDS

实例所属的数据库产品,取值:

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

实例ID。

Ip String rm-2ze1jdv45i7l6****.mysql.rds.aliyuncs.com

待接入实例的内网连接地址,您可调用DescribeDBInstances接口查询实例的IP地址。

Port String 3306

实例的内网连接端口,您可调用DescribeDBInstances接口查询实例的端口。

Engine String MySQL

数据库引擎,取值:

  • MySQL
  • PostgreSQL
  • PolarDB MySQL
  • PolarDB PostgreSQL
  • Redis
  • MongoDB
  • PolarDB O
  • PolarDB X
Username String test****

用户名。

Password String 122****

密码。

InstanceAlias String yuecq--test****

实例名称。

NetworkType String VPC

实例的网络类型。

VpcId String vpc-m5e666n89m2bx8jar****

VPC ID。

Region String cn-hangzhou

实例所属的地域。

CallerBid String 26842

调用者业务ID。

TenantId String L0EPfLS****=SCE00000*****

所属的租户ID。

OwnerIdSignature String 119059297981****

所有者ID的签名。

CallerType String sub

账号类型。取值:

  • sub:RAM用户。
  • parent:阿里云账号。
CallerUid String 111111111111

调用者用户ID。

Target String rm-2ze1jdv45i7l6****

目标实例。

Product String DAS

数据库产品。

External String Null

其他信息。

返回数据

名称 类型 示例值 描述
RequestId String B6D17591-B48B-4D31-9CD6-9B9796B2****

请求ID。

Message String Successful

请求返回消息。

说明 请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。
Synchro String None

备用参数。

Data String "Data": { "total": 1, "list":[...] }, "Code": 200, "Success": true }

详细信息列表,包括信息总数、错误码等。

Code String 200

返回的状态码。

Success String true

请求是否执行成功:

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

示例

请求示例

http(s)://das.cn-shanghai.aliyuncs.com/?Action=AccessHDMInstance
&Uid=hdm_df02bbfd3bd64c7bb1982e5323a6****
&accessKey=None
&signature=None
&timestamp=None
&__context=None
&skipAuth=None
&UserId=None
&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
&CallerBid=26842
&TenantId=L0EPfLS****=SCE00000*****
&OwnerIdSignature=119059297981****
&CallerType=sub
&CallerUid=111111111111
&Target=rm-2ze1jdv45i7l6****
&Product=DAS
&External=Null
&公共请求参数

正常返回示例

XML格式

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

<AccessHDMInstanceResponse>
    <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>
    <Message>Successful</Message>
    <Synchro>None</Synchro>
    <Data>"Data": { "total": 1, "list":[...] }, "Code": 200, "Success": true }</Data>
    <Code>200</Code>
    <Success>true</Success>
</AccessHDMInstanceResponse>

JSON格式

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

{
  "RequestId" : "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Message" : "Successful",
  "Synchro" : "None",
  "Data" : "\"Data\": { \"total\": 1, \"list\":[...] }, \"Code\": 200, \"Success\": true }",
  "Code" : "200",
  "Success" : "true"
}

错误码

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

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