接口功能介绍
调用describeInstanceSSL接口查询MongoDB实例的SSL设置详情。
接口约束
无
URI
GET /v1/openApi/describeInstanceSSL
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
prodInstId | *必填 | String | 文档数据库对外的实例标识 | a649077e15f349cb8b4cde6f7285a568 |
请求参数
请求头header参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
statusCode | 是 | Integer | 响应码 | 800 | |
message | 是 | String | 响应信息 | 查询XXX信息成功 | |
returnObj | 是 | Object | 返回对象 | returnObj |
表returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
SSLStatus | 是 | String | open表示开启，close表示未开启 | close |
请求示例
请求头header
无
请求参数query
/v1/openApi/describeInstanceSSL ?prodInstId=a649077e15f349cb8b4cde6f7285a568
响应示例
{
"statusCode": 800,
"message": "查询文档数据库服务的SSL设置详情成功",
"returnObj": {
"SSLStatus": "close"
}
}状态码
状态码 | 描述 |
800 | 表示请求成功 |
900 | 表示请求失败 |
错误码
无