Document Database Service

Compare Parameter Groups

2025-07-25 06:41:09
API Introduction

Call compareParameterGroup to compare parameter group information.

API Restrictions

None

URI
POST /v1/parameterGroupOpenApi/compareParameterGroup

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

parameterGroupSrc

Yes

String

Compare parameter group names

group-one


parameterGroupDst

Yes

String

Name of the parameter group to be compared

Default-Mongo-4.0


Response Parameter

Parameter

Required or Not

Parameter Type

Description


Lower-level Object

statusCode

Yes

Integer

Response Code

Value range: 800 indicates success, 900 indicates failure

800


message

Yes

String

Response information

The host alarm rules of the MongoDB instance are queried successfully


returnObj

Yes

Object[]

Return object array


returnObj

Table returnObj

Parameter

Required or Not

Parameter Type

Description

Example

Lower-level Object

valueOne

No

String

Compare the values of different parameters in a parameter group

800


valueTwo

No

String

The values of different parameters in the parameter group being compared

600


parameterName

No

String

Two groups of parameters with different values

connPoolMaxConnsPerHost


Sample Request

Request Header

None

Request Body

{
    "parameterGroupSrc":"group-one",
    "parameterGroupDst":"Default-Mongo-4.0"
}
Response Example
{
    "statusCode": 800,
    "message": "the parameter group is compared successfully",
    "returnObj": [
        {
            "valueOne": "800",
            "valueTwo": "600",
            "parameterName": "connPoolMaxConnsPerHost"
        },
        {
            "valueOne": "800000",
            "valueTwo": "600000",
            "parameterName": "cursorTimeoutMillis"
        }
    ]
}
Status Code

Status Code

Description

800

Indicate that the request succeeded

900

Indicates that the request failed

Error Codes

None


E4Tpd35HEWdm