接口功能介绍
调用接口查询实例所有连接信息。
接口约束
无
URI
GET /v1/open-api/instance/instance-net-info
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
outerProdInstId | 是 | String | 实例ID | 562b89493b1a40e1b97ea05e50dd8170 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回码 | 0 | |
message | 是 | String | 返回消息 | ||
returnObj | 是 | Object | 返回对象 | returnObj |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
vip | 是 | String | 数据库链接地址 | ||
vip6 | 是 | String | 数据库链接地址Ipv6 | ||
readPort | 是 | String | 读端口 | ||
writePort | 是 | String | 写端口 | ||
vpcId | 是 | String | vpcId | ||
subnet | 是 | String | 子网名称 | ||
prodInstFlag | 是 | String | 实例名称 | ||
subnetId | 是 | String | 子网id |
请求示例
请求头header
无
请求体body
无
响应示例
{
"statusCode": 0,
"message": "success",
"returnObj": {
"subnetId": "",
"prodInstFlag": "test",
"subnet": "",
"vpcId": "0",
"writePort": "13049",
"vip": "192.168.11.9",
"vip6": "",
"readPort": "13048"
}
}
状态码
状态码 | 描述 |
---|---|
0 | 请求响应成功 |
错误码
错误码 | 描述 |
---|---|
2001 | 参数异常,失败原因见message |
3001 | 业务异常,失败原因见message |
5001 | 请求响应失败,失败原因见message |