Document Database Service

Modify instance SSL configuration

2025-07-25 01:18:31
API Introduction

Call the modifyDBInstanceSSL API to modify the SSL configuration of MongoDB instance.

API Restrictions

None

URI
POST /v1/openApi/modifyDBInstanceSSL

Path Parameter

None

Query Parameter

None

Request Parameters

Request Header Parameter

None

Request Body Parameter

Parameter

Required or Not

Parameter Type

Description

Instance

Lower-level Object

prodInstId

Yes

String

Instance ID

f3687b55b1ce4cb1b781fb567b12ab0b


ssl

Yes

String

Whether to enable ssl, true indicates enabled, false indicates disabled



Response Parameter

Parameter

Required or Not

Parameter Type

Description

Example

Lower-level Object

statusCode

Yes

String

Return code

Value range: 800 indicates success

800


message

Yes

String

Return to Messages



returnObj

Yes

Object

Return object.



Sample Request

Request Body

{
    "prodInstId":"f3687b55b1ce4cb1b781fb567b12ab0b",
    "ssl":"true"
}
Response Example
{
    "statusCode": 800,
    "message": "the SSL configuration of the MongoDB instance is modified successfully",
    "returnObj": null
}
Status Code

Status Code

Description

800

Indicate that the request succeeded

900

Request response failed, see message for reason of failure

Error Codes

None

2jUvixKfYqH1