Подключиться
Language / Region
© 2021 ООО «Яндекс.Облако»
Yandex Data Transfer

Method update

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

HTTP request

PATCH https://datatransfer.api.cloud.yandex.net/v1/endpoint/{endpointId}

Path parameters

Parameter Description
endpointId

Body parameters

{
  "name": "string",
  "description": "string",
  "settings": {

    // `settings` includes only one of the fields `mysqlSource`, `postgresSource`, `mysqlTarget`, `postgresTarget`
    "mysqlSource": {
      "connection": {

        // `settings.mysqlSource.connection` includes only one of the fields `mdbClusterId`, `onPremise`
        "mdbClusterId": "string",
        "onPremise": {
          "hosts": [
            "string"
          ],
          "port": "string",
          "tlsMode": {

            // `settings.mysqlSource.connection.onPremise.tlsMode` includes only one of the fields `disabled`, `enabled`
            "disabled": "object",
            "enabled": {
              "caCertificate": "string"
            },
            // end of the list of possible fields`settings.mysqlSource.connection.onPremise.tlsMode`

          },
          "subnetId": "string"
        },
        // end of the list of possible fields`settings.mysqlSource.connection`

      },
      "database": "string",
      "user": "string",
      "password": {
        "raw": "string"
      },
      "includeTablesRegex": [
        "string"
      ],
      "excludeTablesRegex": [
        "string"
      ],
      "timezone": "string",
      "objectTransferSettings": {
        "view": "string",
        "routine": "string",
        "trigger": "string"
      }
    },
    "postgresSource": {
      "connection": {

        // `settings.postgresSource.connection` includes only one of the fields `mdbClusterId`, `onPremise`
        "mdbClusterId": "string",
        "onPremise": {
          "hosts": [
            "string"
          ],
          "port": "string",
          "tlsMode": {

            // `settings.postgresSource.connection.onPremise.tlsMode` includes only one of the fields `disabled`, `enabled`
            "disabled": "object",
            "enabled": {
              "caCertificate": "string"
            },
            // end of the list of possible fields`settings.postgresSource.connection.onPremise.tlsMode`

          },
          "subnetId": "string"
        },
        // end of the list of possible fields`settings.postgresSource.connection`

      },
      "database": "string",
      "user": "string",
      "password": {
        "raw": "string"
      },
      "includeTables": [
        "string"
      ],
      "excludeTables": [
        "string"
      ],
      "slotByteLagLimit": "string",
      "serviceSchema": "string",
      "objectTransferSettings": {
        "sequence": "string",
        "sequenceOwnedBy": "string",
        "table": "string",
        "primaryKey": "string",
        "fkConstraint": "string",
        "defaultValues": "string",
        "constraint": "string",
        "index": "string",
        "view": "string",
        "function": "string",
        "trigger": "string",
        "type": "string",
        "rule": "string",
        "collation": "string",
        "policy": "string",
        "cast": "string"
      }
    },
    "mysqlTarget": {
      "connection": {

        // `settings.mysqlTarget.connection` includes only one of the fields `mdbClusterId`, `onPremise`
        "mdbClusterId": "string",
        "onPremise": {
          "hosts": [
            "string"
          ],
          "port": "string",
          "tlsMode": {

            // `settings.mysqlTarget.connection.onPremise.tlsMode` includes only one of the fields `disabled`, `enabled`
            "disabled": "object",
            "enabled": {
              "caCertificate": "string"
            },
            // end of the list of possible fields`settings.mysqlTarget.connection.onPremise.tlsMode`

          },
          "subnetId": "string"
        },
        // end of the list of possible fields`settings.mysqlTarget.connection`

      },
      "database": "string",
      "user": "string",
      "password": {
        "raw": "string"
      },
      "sqlMode": "string",
      "skipConstraintChecks": true,
      "timezone": "string"
    },
    "postgresTarget": {
      "connection": {

        // `settings.postgresTarget.connection` includes only one of the fields `mdbClusterId`, `onPremise`
        "mdbClusterId": "string",
        "onPremise": {
          "hosts": [
            "string"
          ],
          "port": "string",
          "tlsMode": {

            // `settings.postgresTarget.connection.onPremise.tlsMode` includes only one of the fields `disabled`, `enabled`
            "disabled": "object",
            "enabled": {
              "caCertificate": "string"
            },
            // end of the list of possible fields`settings.postgresTarget.connection.onPremise.tlsMode`

          },
          "subnetId": "string"
        },
        // end of the list of possible fields`settings.postgresTarget.connection`

      },
      "database": "string",
      "user": "string",
      "password": {
        "raw": "string"
      }
    },
    // end of the list of possible fields`settings`

  }
}
Field Description
name string
description string
settings object
settings.
mysqlSource		 object
settings includes only one of the fields mysqlSource, postgresSource, mysqlTarget, postgresTarget
settings.
mysqlSource.
connection		 object

Connection settings

Database connection settings
settings.
mysqlSource.
connection.
mdbClusterId		 string
settings.mysqlSource.connection includes only one of the fields mdbClusterId, onPremise

MDB cluster

Yandex.Cloud Managed MySQL cluster ID
settings.
mysqlSource.
connection.
onPremise		 object
On-premise Connection options for on-premise MySQL
settings.mysqlSource.connection includes only one of the fields mdbClusterId, onPremise
settings.
mysqlSource.
connection.
onPremise.
hosts[]		 string
settings.
mysqlSource.
connection.
onPremise.
port		 string (int64)

Database port

Will be used if the cluster ID is not specified. Default: 6432.
settings.
mysqlSource.
connection.
onPremise.
tlsMode		 object

TLS mode

TLS settings for server connection. Disabled by default.
settings.
mysqlSource.
connection.
onPremise.
tlsMode.
disabled		 object
settings.mysqlSource.connection.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.
settings.
mysqlSource.
connection.
onPremise.
tlsMode.
disabled.
disabled		 object
settings.mysqlSource.connection.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.
settings.
mysqlSource.
connection.
onPremise.
tlsMode.
enabled		 object
settings.mysqlSource.connection.onPremise.tlsMode includes only one of the fields disabled, enabled
settings.
mysqlSource.
connection.
onPremise.
tlsMode.
enabled.
caCertificate		 string

CA certificate

X.509 certificate of the certificate authority which issued the server's certificate, in PEM format. When CA certificate is specified TLS is used to connect to the server.
settings.
mysqlSource.
connection.
onPremise.
subnetId		 string

Network interface for endpoint

Default: public IPv4.
settings.
mysqlSource.
database		 string

Database name

You can leave it empty, then it will be possible to transfer tables from several databases at the same time from this source.
settings.
mysqlSource.
user		 string

Username

User for database access.
settings.
mysqlSource.
password		 object

Password

Password for database access.
settings.
mysqlSource.
password.
raw		 string

Password
settings.
mysqlSource.
includeTablesRegex[]		 string
settings.
mysqlSource.
excludeTablesRegex[]		 string
settings.
mysqlSource.
timezone		 string

Database timezone

Is used for parsing timestamps for saving source timezones. Accepts values from IANA timezone database. Default: local timezone.
settings.
mysqlSource.
objectTransferSettings		 object

Schema migration

Select database objects to be transferred during activation or deactivation.
settings.
mysqlSource.
objectTransferSettings.
view		 string

Views

CREATE VIEW ...
settings.
mysqlSource.
objectTransferSettings.
routine		 string

Routines

CREATE PROCEDURE ... ; CREATE FUNCTION ... ;
settings.
mysqlSource.
objectTransferSettings.
trigger		 string

Triggers

CREATE TRIGGER ...
settings.
postgresSource		 object
settings includes only one of the fields mysqlSource, postgresSource, mysqlTarget, postgresTarget
settings.
postgresSource.
connection		 object

Connection settings

Database connection settings
settings.
postgresSource.
connection.
mdbClusterId		 string
settings.postgresSource.connection includes only one of the fields mdbClusterId, onPremise

MDB cluster

Yandex.Cloud Managed PostgreSQL cluster ID
settings.
postgresSource.
connection.
onPremise		 object
On-premise Connection options for on-premise PostgreSQL
settings.postgresSource.connection includes only one of the fields mdbClusterId, onPremise
settings.
postgresSource.
connection.
onPremise.
hosts[]		 string
settings.
postgresSource.
connection.
onPremise.
port		 string (int64)

Database port

Will be used if the cluster ID is not specified. Default: 6432.
settings.
postgresSource.
connection.
onPremise.
tlsMode		 object

TLS mode

TLS settings for server connection. Disabled by default.
settings.
postgresSource.
connection.
onPremise.
tlsMode.
disabled		 object
settings.postgresSource.connection.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.
settings.
postgresSource.
connection.
onPremise.
tlsMode.
disabled.
disabled		 object
settings.postgresSource.connection.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.
settings.
postgresSource.
connection.
onPremise.
tlsMode.
enabled		 object
settings.postgresSource.connection.onPremise.tlsMode includes only one of the fields disabled, enabled
settings.
postgresSource.
connection.
onPremise.
tlsMode.
enabled.
caCertificate		 string

CA certificate

X.509 certificate of the certificate authority which issued the server's certificate, in PEM format. When CA certificate is specified TLS is used to connect to the server.
settings.
postgresSource.
connection.
onPremise.
subnetId		 string

Network interface for endpoint

Default: public IPv4.
settings.
postgresSource.
database		 string

Database name
settings.
postgresSource.
user		 string

Username

User for database access.
settings.
postgresSource.
password		 object

Password

Password for database access.
settings.
postgresSource.
password.
raw		 string

Password
settings.
postgresSource.
includeTables[]		 string

List of tables

If none or empty list is presented, all tables are replicated. Can contain regular expression.
settings.
postgresSource.
excludeTables[]		 string

Excluded tables

If none or empty list is presented, all tables are replicated. Can contain regular expression.
settings.
postgresSource.
slotByteLagLimit		 string (int64)

Maximum WAL size for the replication slot

Maximum WAL size held by the replication slot. Exceeding this limit will result in a replication failure and deletion of the replication slot. Unlimited by default.
settings.
postgresSource.
serviceSchema		 string

Database schema for service table

Default: public. Here created technical tables (__consumer_keeper, __data_transfer_mole_finder).
settings.
postgresSource.
objectTransferSettings		 object

Schema migration

Select database objects to be transferred during activation or deactivation.
settings.
postgresSource.
objectTransferSettings.
sequence		 string

Sequences

CREATE SEQUENCE ...
settings.
postgresSource.
objectTransferSettings.
sequenceOwnedBy		 string

Owned sequences

CREATE SEQUENCE ... OWNED BY ...
settings.
postgresSource.
objectTransferSettings.
table		 string

Tables

CREATE TABLE ...
settings.
postgresSource.
objectTransferSettings.
primaryKey		 string

Primary keys

ALTER TABLE ... ADD PRIMARY KEY ...
settings.
postgresSource.
objectTransferSettings.
fkConstraint		 string

Foreign keys

ALTER TABLE ... ADD FOREIGN KEY ...
settings.
postgresSource.
objectTransferSettings.
defaultValues		 string

Default values

ALTER TABLE ... ALTER COLUMN ... SET DEFAULT ...
settings.
postgresSource.
objectTransferSettings.
constraint		 string

Constraints

ALTER TABLE ... ADD CONSTRAINT ...
settings.
postgresSource.
objectTransferSettings.
index		 string

Indexes

CREATE INDEX ...
settings.
postgresSource.
objectTransferSettings.
view		 string

Views

CREATE VIEW ...
settings.
postgresSource.
objectTransferSettings.
function		 string

Functions

CREATE FUNCTION ...
settings.
postgresSource.
objectTransferSettings.
trigger		 string

Triggers

CREATE TRIGGER ...
settings.
postgresSource.
objectTransferSettings.
type		 string

Types

CREATE TYPE ...
settings.
postgresSource.
objectTransferSettings.
rule		 string

Rules

CREATE RULE ...
settings.
postgresSource.
objectTransferSettings.
collation		 string

Collations

CREATE COLLATION ...
settings.
postgresSource.
objectTransferSettings.
policy		 string

Policies

CREATE POLICY ...
settings.
postgresSource.
objectTransferSettings.
cast		 string

Casts

CREATE CAST ...
settings.
mysqlTarget		 object
settings includes only one of the fields mysqlSource, postgresSource, mysqlTarget, postgresTarget
settings.
mysqlTarget.
connection		 object

Connection settings

Database connection settings
settings.
mysqlTarget.
connection.
mdbClusterId		 string
settings.mysqlTarget.connection includes only one of the fields mdbClusterId, onPremise

MDB cluster

Yandex.Cloud Managed MySQL cluster ID
settings.
mysqlTarget.
connection.
onPremise		 object
On-premise Connection options for on-premise MySQL
settings.mysqlTarget.connection includes only one of the fields mdbClusterId, onPremise
settings.
mysqlTarget.
connection.
onPremise.
hosts[]		 string
settings.
mysqlTarget.
connection.
onPremise.
port		 string (int64)

Database port

Will be used if the cluster ID is not specified. Default: 6432.
settings.
mysqlTarget.
connection.
onPremise.
tlsMode		 object

TLS mode

TLS settings for server connection. Disabled by default.
settings.
mysqlTarget.
connection.
onPremise.
tlsMode.
disabled		 object
settings.mysqlTarget.connection.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.
settings.
mysqlTarget.
connection.
onPremise.
tlsMode.
disabled.
disabled		 object
settings.mysqlTarget.connection.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.
settings.
mysqlTarget.
connection.
onPremise.
tlsMode.
enabled		 object
settings.mysqlTarget.connection.onPremise.tlsMode includes only one of the fields disabled, enabled
settings.
mysqlTarget.
connection.
onPremise.
tlsMode.
enabled.
caCertificate		 string

CA certificate

X.509 certificate of the certificate authority which issued the server's certificate, in PEM format. When CA certificate is specified TLS is used to connect to the server.
settings.
mysqlTarget.
connection.
onPremise.
subnetId		 string

Network interface for endpoint

Default: public IPv4.
settings.
mysqlTarget.
database		 string

Database name

Allowed to leave it empty, then the tables will be created in databases with the same names as on the source. If this field is empty, then you must fill below db schema for service table.
settings.
mysqlTarget.
user		 string

Username

User for database access.
settings.
mysqlTarget.
password		 object

Password

Password for database access.
settings.
mysqlTarget.
password.
raw		 string

Password
settings.
mysqlTarget.
sqlMode		 string

sql_mode

Default: NO_AUTO_VALUE_ON_ZERO,NO_DIR_IN_CREATE,NO_ENGINE_SUBSTITUTION.
settings.
mysqlTarget.
skipConstraintChecks		 boolean (boolean)

Disable constraints checks

Recommend to disable for increase replication speed, but if schema contain cascading operations we don't recommend to disable. This option set FOREIGN_KEY_CHECKS=0 and UNIQUE_CHECKS=0.
settings.
mysqlTarget.
timezone		 string

Database timezone

Is used for parsing timestamps for saving source timezones. Accepts values from IANA timezone database. Default: local timezone.
settings.
postgresTarget		 object
settings includes only one of the fields mysqlSource, postgresSource, mysqlTarget, postgresTarget
settings.
postgresTarget.
connection		 object

Connection settings

Database connection settings
settings.
postgresTarget.
connection.
mdbClusterId		 string
settings.postgresTarget.connection includes only one of the fields mdbClusterId, onPremise

MDB cluster

Yandex.Cloud Managed PostgreSQL cluster ID
settings.
postgresTarget.
connection.
onPremise		 object
On-premise Connection options for on-premise PostgreSQL
settings.postgresTarget.connection includes only one of the fields mdbClusterId, onPremise
settings.
postgresTarget.
connection.
onPremise.
hosts[]		 string
settings.
postgresTarget.
connection.
onPremise.
port		 string (int64)

Database port

Will be used if the cluster ID is not specified. Default: 6432.
settings.
postgresTarget.
connection.
onPremise.
tlsMode		 object

TLS mode

TLS settings for server connection. Disabled by default.
settings.
postgresTarget.
connection.
onPremise.
tlsMode.
disabled		 object
settings.postgresTarget.connection.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.
settings.
postgresTarget.
connection.
onPremise.
tlsMode.
disabled.
disabled		 object
settings.postgresTarget.connection.onPremise.tlsMode includes only one of the fields disabled, enabled

Empty JSON object {}.
settings.
postgresTarget.
connection.
onPremise.
tlsMode.
enabled		 object
settings.postgresTarget.connection.onPremise.tlsMode includes only one of the fields disabled, enabled
settings.
postgresTarget.
connection.
onPremise.
tlsMode.
enabled.
caCertificate		 string

CA certificate

X.509 certificate of the certificate authority which issued the server's certificate, in PEM format. When CA certificate is specified TLS is used to connect to the server.
settings.
postgresTarget.
connection.
onPremise.
subnetId		 string

Network interface for endpoint

Default: public IPv4.
settings.
postgresTarget.
database		 string

Database name
settings.
postgresTarget.
user		 string

Username

User for database access.
settings.
postgresTarget.
password		 object

Password

Password for database access.
settings.
postgresTarget.
password.
raw		 string

Password

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.
Language / Region
© 2021 ООО «Яндекс.Облако»
В этой статье: