Document Database Service

Create a New Parameter Group

2025-07-25 06:31:45
API Introduction

Call createParameterGroup to create a new parameter group.

API Restrictions

None

URI
POST /v1/parameterGroupOpenApi/createParameterGroup

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

parameterGroupName

Yes

String

Parameter group name

group-one


engine

Yes

String

Engine version, enter 3.4 or 4.0

4.0


description

No

String

Parameter group description

4.0 Custom parameter group


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.


returnObj

Table returnObj

Parameter

Required or Not

Parameter Type

Description

Example

Lower-level Object

CreateResult

No

String

Creation result

success


ParameterGroupName

No

String

Parameter group name

group-one


Sample Request

Request Header

None

Request Body

{
    "parameterGroupName":"group-one",
    "engine":"4.0",
    "description":"4.0 custom parameter group"
}
Response Example
{
    "statusCode": 800,
    "message": "the new parameter group is created successfully",
    "returnObj": {
        "CreateResult": "success",
        "ParameterGroupName": "group-one"
    }
}
Status Code

Status Code

Description

800

Indicate that the request succeeded

900

Indicates that the request failed

Error Codes

None


6822iwmg.j0T