Changing Specifications of an Instance¶

Function¶

This API is used to change specifications of an instance.

Note

Services will be interrupted for 5 to 10 minutes when you change specifications of an instance. Exercise caution when performing this operation.

This API supports GeminiDB Cassandra instances.

This API can be used to scale up or down specifications of an instance.

The new specifications cannot be the same as the original specifications.

Specifications can be modified only when the instance status is normal.

If specifications cannot meet the requirements for running the instance, the specifications cannot be changed.

PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/resize

**Table 1** Path parameters¶
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.
instance_id	Yes	String	Instance ID.

**Table 2** Request header parameters¶
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token.

**Table 3** Request body parameters¶
Parameter	Mandatory	Type	Description
resize	Yes	ResizeInstanceOption object	Target specification information.

**Table 4** ResizeInstanceOption¶
Parameter	Mandatory	Type	Description
target_spec_code	Yes	String	Target resource specification code. For the code, see the value of response parameter flavors.spec_code in Querying Instance Specifications.

Status code: 202

**Table 5** Response body parameters¶
Parameter	Type	Description
job_id	String	Task ID.

URI example

PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/resize

Changing instance specifications to 16 vCPUs | 64 GB

{
  "resize" : {
    "target_spec_code" : "geminidb.cassandra.4xlarge.4"
  }
}

Status code: 202

Accepted

{
  "job_id" : "3711e2ad-5787-49bc-a47f-3f0b066af9f5"
}

For details, see Status Codes.

For details, see Error Codes.

last updated: 2024-11-13 14:49 UTC - commit: 926560bde336673fdc92f38b4d1379235820f13a