查询实例连接地址v2
更新时间 2025-11-05 18:06:43
最近更新时间: 2025-11-05 18:06:43
接口功能介绍
查询文档数据库实例的连接地址信息
接口约束
无
URI
GET /DDS2/v2/openApi/describeInstanceConnectionString
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 文档数据库对外的实例标识 | 60d420bffb394************************* |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| project-id | 否 | String | 项目id | 0 | |
| regionId | 是 | String | 资源池id | bb9fdb42056f11eda1610242ac110002 |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 响应码 取值范围：800为成功，900为失败 | 800 | |
| message | String | 响应信息 | 查询文档数据库服务的实例连接地址信息成功 | |
| returnObj | Object | 返回对象 | returnObj | |
| error | String | 错误码。当接口失败时才返回具体错误编码，成功不返回或者为空。 | ||
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| connectUrl | String | mongodb的连接串信息 | ||
| readOnlyConnectUrl | String | mongodb的只读连接串信息 | ||
| ipv6ConnectUrl | String | mongodb的ipv6连接串信息 |
枚举参数
无
请求示例
请求url
/v1/openApi/describeInstanceConnectionString?prodInstId=60d420bffb394*************************
请求头header
project-id=0
regionId=bb9fdb42056f11eda1610242ac110002
请求体body
无
响应示例
{
"statusCode": 800,
"message": "查询文档数据库服务的实例连接地址信息成功",
"returnObj": {
"connectUrl": "mongodb://root:****@172.27.***.***.***.***:8350/admin?authSource=admin",
"readOnlyConnectUrl":null,
"ipv6ConnectUrl":null
}
}
状态码
请参考 状态码
错误码
请参考 错误码
