Passer au contenu principal
PATCH
Update a PostgreSQL service
Update a Postgres service that belongs to the organization. WARNING: Changing the name also updates the host name and certificates for the service.

Permission

The API key must have the control-plane:postgres-service:manage permission.

Autorisations

Authorization
string
header
requis

Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

Paramètres de chemin

organizationId
string<uuid>
requis

ID of the organization that owns the Postgres service.

postgresId
string<uuid>
requis

ID of the requested Postgres service.

Corps

application/json
ipAccessList
object
name
string

Name of the Postgres service. Alphanumerical string with whitespaces up to 50 characters.

Required string length: 1 - 50
size
enum<string>

The VM size for a Postgres service.

Options disponibles:
c6gd.large,
c6gd.xlarge,
c6gd.2xlarge,
c6gd.4xlarge,
c6gd.8xlarge,
c6gd.16xlarge,
i7i.large,
i7i.xlarge,
i7i.2xlarge,
i7i.4xlarge,
i7i.8xlarge,
i7i.12xlarge,
i7i.16xlarge,
i7i.24xlarge,
i7ie.large,
i7ie.xlarge,
i7ie.2xlarge,
i7ie.3xlarge,
i7ie.6xlarge,
i7ie.12xlarge,
i7ie.18xlarge,
i7ie.24xlarge,
i8g.large,
i8g.xlarge,
i8g.2xlarge,
i8g.4xlarge,
i8g.8xlarge,
i8g.16xlarge,
i8g.24xlarge,
i8ge.large,
i8ge.xlarge,
i8ge.2xlarge,
i8ge.3xlarge,
i8ge.6xlarge,
i8ge.12xlarge,
i8ge.18xlarge,
i8ge.24xlarge,
m6gd.large,
m6gd.xlarge,
m6gd.2xlarge,
m6gd.4xlarge,
m6gd.8xlarge,
m6gd.16xlarge,
m6id.large,
m6id.xlarge,
m6id.2xlarge,
m6id.4xlarge,
m6id.8xlarge,
m6id.16xlarge,
m8gd.large,
m8gd.xlarge,
m8gd.2xlarge,
m8gd.4xlarge,
m8gd.8xlarge,
m8gd.16xlarge,
r6gd.medium,
r6gd.large,
r6gd.xlarge,
r6gd.2xlarge,
r6gd.4xlarge,
r6gd.8xlarge,
r6gd.12xlarge,
r6gd.16xlarge,
r6id.large,
r6id.xlarge,
r6id.2xlarge,
r6id.4xlarge,
r6id.8xlarge,
r6id.12xlarge,
r6id.16xlarge,
r6id.24xlarge,
r6id.32xlarge,
r8gd.medium,
r8gd.large,
r8gd.xlarge,
r8gd.2xlarge,
r8gd.4xlarge,
r8gd.8xlarge,
r8gd.12xlarge,
r8gd.16xlarge,
r8gd.24xlarge,
r8gd.48xlarge,
c4a-highmem-lssd-4,
c4a-highmem-lssd-8,
c4a-highmem-lssd-16,
c4a-highmem-lssd-32,
c4a-highmem-lssd-48,
c4a-highmem-lssd-64,
c4a-highmem-lssd-72,
c4a-standard-lssd-4,
c4a-standard-lssd-8,
c4a-standard-lssd-16,
c4a-standard-lssd-32,
c4a-standard-lssd-48,
c4a-standard-lssd-64,
c4a-standard-lssd-72,
c4-highmem-lssd-4,
c4-highmem-lssd-8,
c4-highmem-lssd-16,
c4-highmem-lssd-24,
c4-highmem-lssd-32,
c4-highmem-lssd-48,
c4-highmem-lssd-96,
c4-highmem-lssd-144,
c4-highmem-lssd-192,
c4-highmem-lssd-288,
c4-standard-lssd-4,
c4-standard-lssd-8,
c4-standard-lssd-16,
c4-standard-lssd-24,
c4-standard-lssd-32,
c4-standard-lssd-48,
c4-standard-lssd-96,
c4-standard-lssd-144,
c4-standard-lssd-192,
c4-standard-lssd-288,
c4d-highmem-lssd-8,
c4d-highmem-lssd-16,
c4d-highmem-lssd-32,
c4d-highmem-lssd-48,
c4d-highmem-lssd-64,
c4d-highmem-lssd-96,
c4d-highmem-lssd-192,
c4d-highmem-lssd-384,
c4d-standard-lssd-8,
c4d-standard-lssd-16,
c4d-standard-lssd-32,
c4d-standard-lssd-48,
c4d-standard-lssd-64,
c4d-standard-lssd-96,
c4d-standard-lssd-192,
c4d-standard-lssd-384,
c3-standard-lssd-4,
c3-standard-lssd-8,
c3-standard-lssd-22,
c3-standard-lssd-44,
c3-standard-lssd-88,
c3-standard-lssd-176,
c3d-highmem-lssd-8,
c3d-highmem-lssd-16,
c3d-highmem-lssd-30,
c3d-highmem-lssd-60,
c3d-highmem-lssd-90,
c3d-highmem-lssd-180,
c3d-highmem-lssd-360,
c3d-standard-lssd-8,
c3d-standard-lssd-16,
c3d-standard-lssd-30,
c3d-standard-lssd-60,
c3d-standard-lssd-90,
c3d-standard-lssd-180,
c3d-standard-lssd-360,
z3-highmem-highlssd-8,
z3-highmem-highlssd-16,
z3-highmem-highlssd-22,
z3-highmem-highlssd-32,
z3-highmem-highlssd-44,
z3-highmem-highlssd-88,
z3-highmem-standardlssd-14,
z3-highmem-standardlssd-22,
z3-highmem-standardlssd-44,
z3-highmem-standardlssd-88,
z3-highmem-standardlssd-176,
n2-highmem-2xlssd-4,
n2-highmem-2xlssd-8,
n2-highmem-2xlssd-16,
n2-highmem-2xlssd-32,
n2-highmem-2xlssd-48,
n2-highmem-2xlssd-64,
n2-highmem-2xlssd-96,
n2-standard-2xlssd-4,
n2-standard-2xlssd-8,
n2-standard-2xlssd-16,
n2-standard-2xlssd-32,
n2-standard-2xlssd-48,
n2-standard-2xlssd-64,
n2-standard-2xlssd-96,
n2-highmem-4xlssd-2,
n2-highmem-4xlssd-4,
n2-highmem-4xlssd-8,
n2-highmem-4xlssd-16,
n2-highmem-4xlssd-32,
n2-highmem-4xlssd-48,
n2-highmem-8xlssd-2,
n2-highmem-8xlssd-4,
n2-highmem-8xlssd-8,
n2-highmem-8xlssd-16,
n2-highmem-8xlssd-32,
n2-highmem-16xlssd-2,
n2-highmem-16xlssd-4,
n2-highmem-16xlssd-8,
n2-highmem-16xlssd-16
haType
enum<string>

Type of high availability: “none” for no replication, “async” for asynchronous replication to a single standby, and “sync” for synchronous replication to the number of standbys in standbyCount (two by default).

Options disponibles:
none,
async,
sync
standbyCount
enum<integer>

Number of hot standby instances. Accepted values and defaults depend on haType:

  • “none”: 0 (default)
  • “async”: 1 (default)
  • “sync”: 1, or 2 (default)

When haType is updated without standbyCount, the default for the new haType applies.

Options disponibles:
0,
1,
2
tags
Postgres Tags · object[]

Tags associated with the Postgres service. Tag keys starting with “chc_” are reserved for internal use.

Maximum array length: 50
deletionProtection
boolean

When true, the service cannot be deleted until deletion protection is turned off. Only available for organizations with deletion protection enabled.

Réponse

Successful response

status
number

HTTP status code.

Exemple:

200

requestId
string<uuid>

Unique id assigned to every request. UUIDv4

result
object