Help Center/ Document Database Service/ API Reference (Ally Region)/ APIs V3.0 (Recommended)/ Parameter Configuration/ Applying a Parameter Template
Updated on 2026-01-08 GMT+08:00
View PDF
Share

Applying a Parameter Template

Description

This API is used to change a parameter template for a specified DB instance.

URI

  • URI format

    PUT https://{Endpoint}/v3/{project_id}/configurations/{config_id}/apply

Table 1 Path parameters

Name

Type

Mandatory

Description

project_id

String

Yes

Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.

config_id

String

Yes

Parameter template ID.

Request Parameters

Table 2 Request header parameters

Parameter

Type

IN

Mandatory

Description

X-Auth-Token

string

header

Yes

User token
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

entity_ids

Yes

Array of strings
Instance IDs, group IDs, or node IDs. You can call the API used for querying instances and details to obtain the value. If you do not have an instance, you can call the API used for creating an instance.
  • If the DB instance type is cluster and the shard or config parameter template is to be applied, the value is the group ID. If the parameter template of the mongos node is to be applied, the value is the node ID.
  • If the DB instance type is replica set, the value is the instance ID. If the parameter template of a read replica is to be applied, the value is the read replica ID.
  • Request example 
    {
  "entity_ids": [
    "73ea2bf70c73497f89ee0ad4ee008aa2no02"
  ]
}

Response Parameters

Table 4 Response body parameters

Name

Type

Description

job_id

String

Indicates the ID of the asynchronous task for applying a parameter template.
  • Example response 
    { 
  "job_id" : "bf26cf3c-d046-4080-bb45-f114be7afa5f" 
}

Status Code

For details, see Status Code.

Error Code

For details, see Error Code.

Parent topic: Parameter Configuration