ListDatabaseAccessPoint - 获取数据库访问点列表_数据管理(DMS)-阿里云帮助中心

调用此API可以获取数据库访问点列表。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
GatewayId	string	否	网关 ID。	dg-nmz841r7b681****
PageSize	string	是	分页大小。	10
PageNumber	string	是	当前页码。	1
SearchKey	string	否	搜索关键字。	网关。
DbInstanceId	string	否	数据库实例 ID。	dg-db-n2a285spnpy3****
RegionId	string	否	网关所在地域。	cn-hangzhou
Host	string	否	通过网关所在宿主机去访问数据库的地址。	127.0.XX.XX
Port	integer	是	通过网关所在宿主机去访问数据库的端口。	3306
VpcId	string	否	用户数据库访问点所在 VPC 的 ID。	vpc-wz9c473cmu2gg7i7l****

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID，用于定位日志，排查问题。	C9ADD2AA-27E3-5D62-A676-092EDC5303C1
Success	string	请求是否成功，返回值如下： true：请求成功。 false：请求失败。	true
Code	string	响应码。	200
ErrorMsg	string	报错信息。	Gateway exception, please launch local dg first
Count	integer	个数。	1
DbInstanceAccessPointList	array<object>	数据库访问点列表。
	object	数据库访问点。
AccessAddr	string	访问点 IP。	10.0.0.0
AccessPort	integer	访问点端口。	33306
DbInstanceId	string	数据库实例 ID。	dg-db-n2a285spnpy3****
GmtCreate	long	创建网关的时间。	2023-03-09 14:20:04.0
GmtModified	long	修改时间	2023-03-09 14:20:04.0
RouterId	string	网关 ID。	dg-nmz841r7b681****
VpcAzoneId	string	访问点可用区 ID。	cn-hangzhou-j
VpcId	string	访问点所在 VPC 的 ID。	vpc-2ze0612ts436tn0sh****
VswitchId	string	访问点所在 VSW 的 ID。	vsw-8vbgi74rgel72rax4****

示例

正常返回示例

JSON格式

{
  "RequestId": "C9ADD2AA-27E3-5D62-A676-092EDC5303C1",
  "Success": "true",
  "Code": "200",
  "ErrorMsg": "Gateway exception, please launch local dg first",
  "Count": 1,
  "DbInstanceAccessPointList": [
    {
      "AccessAddr": "10.0.0.0",
      "AccessPort": 33306,
      "DbInstanceId": "dg-db-n2a285spnpy3****\n",
      "GmtCreate": 0,
      "GmtModified": 0,
      "RouterId": "dg-nmz841r7b681****",
      "VpcAzoneId": "cn-hangzhou-j",
      "VpcId": "vpc-2ze0612ts436tn0sh****",
      "VswitchId": "vsw-8vbgi74rgel72rax4****"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
500	Error	The requested service is unavailable. Please try again later.	服务异常，请重试

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