This API is used to apply a parameter template to one or more instances.
This API supports GeminiDB Cassandra instances.
This API is an asynchronous API. A successful response does not indicate that the parameter template is successfully applied.
PUT https://{Endpoint}/v3/{project_id}/configurations/{config_id}/apply
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
project_id |
Yes |
String |
Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. |
config_id |
Yes |
String |
Parameter template ID. |
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. |
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
instance_ids |
Yes |
Array of strings |
Instance IDs. |
Status code: 200
Parameter |
Type |
Description |
|---|---|---|
job_id |
String |
ID of the asynchronous task that applies the parameter template. |
success |
Boolean |
Whether the task for applying the parameter template is successfully submitted. The value can be:
|
PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06/apply
{
"instance_ids" : [ "73ea2bf70c73497f89ee0ad4ee008aa2in06" ]
}
Status code: 200
Success
{
"job_id" : "463b4b58-d0e8-4e2b-9560-5dea4552fde9",
"success" : true
}
For details, see Status Codes.
For details, see Error Codes.