Подключиться
Yandex Managed Service for PostgreSQL

Method create

Статья создана

Creates a new PostgreSQL database in the specified cluster.

HTTP request

POST https://mdb.api.cloud.yandex.net/managed-postgresql/v1/clusters/{clusterId}/databases

Path parameters

Parameter Description
clusterId Required. ID of the PostgreSQL cluster to create a database in. To get the cluster ID use a list request. The maximum string length in characters is 50.

Body parameters

{
  "databaseSpec": {
    "name": "string",
    "owner": "string",
    "lcCollate": "string",
    "lcCtype": "string",
    "extensions": [
      {
        "name": "string",
        "version": "string"
      }
    ]
  }
}
Field Description
databaseSpec object

Required. Configuration of the database to create.
databaseSpec.
name		 string

Required. Name of the PostgreSQL database. 1-63 characters long.

The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.
databaseSpec.
owner		 string

Required. Name of the user to be assigned as the owner of the database. To get the list of available PostgreSQL users, make a list request.

The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_]*.
databaseSpec.
lcCollate		 string

POSIX locale for string sorting order. Can only be set at creation time.

Value must match the regular expression |[a-zA-Z_]+.UTF-8|C.
databaseSpec.
lcCtype		 string

POSIX locale for character classification. Can only be set at creation time.

Value must match the regular expression |[a-zA-Z_]+.UTF-8|C.
databaseSpec.
extensions[]		 object

PostgreSQL extensions to be enabled for the database.
databaseSpec.
extensions[].
name		 string

Name of the extension, e.g. pg_trgm or pg_btree. Extensions supported by Managed Service for PostgreSQL are listed in the Developer's Guide.
databaseSpec.
extensions[].
version		 string

Version of the extension.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // end of the list of possible fields

}

An Operation resource. For more information, see Operation.

Field Description
id string

ID of the operation.
description string

Description of the operation. 0-256 characters long.
createdAt string (date-time)

Creation timestamp.

String in RFC3339 text format.
createdBy string

ID of the user or service account who initiated the operation.
modifiedAt string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format.
done boolean (boolean)

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata object

Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error object
The error result of the operation in case of failure or cancellation.
includes only one of the fields error, response

The error result of the operation in case of failure or cancellation.
error.
code		 integer (int32)

Error code. An enum value of google.rpc.Code.
error.
message		 string

An error message.
error.
details[]		 object

A list of messages that carry the error details.
response object
includes only one of the fields error, response

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.
В этой статье: