Documentation Overview
Getting started with DoubleCloud
Use cases and datasets
ClickHouse®
Apache Kafka®
Apache Airflow
Transfer
Visualization
VPC
API
- Overview
- Get IAM token for service account
- Install SDK
- List of API endpoints
- Tutorials
- API reference
  - Common
  - ClickHouse
  - Kafka
  - Network
  - Transfer
  - Visualization
Administration
Billing
Security

Service doublecloud.transfer.v1.EndpointService

Get

Request

Field	Description
`endpoint_id`	string

Response

Field	Description
`id`	string
`project_id`	string
`name`	string
`description`	string
`labels`	list
`labels[]`	doublecloud.transfer.v1.Endpoint.LabelsEntry
`settings`	doublecloud.transfer.v1.EndpointSettings

List

Request

Field	Description
`project_id`	string Identifier of the folder containing the endpoints to be listed.
`page`	doublecloud.v1.Paging The maximum number of endpoints to be sent in the response message. If the folder contains more endpoints than `page_size`, `next_page_token` will be included in the response message. Include it into the subsequent `ListEndpointRequest` to fetch the next page. Defaults to `100` if not specified. The maximum allowed value for this field is `500`.

Response

Field	Description
`endpoints`	list The list of endpoints. If there are more endpoints in the folder, then `next_page_token` is a non-empty string to be included into the subsequent `ListEndpointsRequest` to fetch the next endpoints page.
`endpoints[]`	doublecloud.transfer.v1.Endpoint
`next_page`	doublecloud.v1.NextPage Opaque value identifying the next endpoints page. This field is empty if there are no more endpoints in the folder. Otherwise, it is non-empty and should be included in the subsequent `ListEndpointsRequest` to fetch the next endpoints page.

Create

Request

Field	Description
`project_id`	string
`name`	string
`description`	string
`labels`	list
`labels[]`	doublecloud.transfer.v1.CreateEndpointRequest.LabelsEntry
`settings`	doublecloud.transfer.v1.EndpointSettings

Response

Field	Description
`id`	string ID of the operation.
`project_id`	string ID of the project where operation performed.
`description`	string Description of the operation.
`created_by`	string ID of the user or service account who initiated the operation.
`metadata`	list Operation metadata (e.g. cluster_id for create cluster operation).
`metadata[]`	doublecloud.v1.Operation.MetadataEntry
`create_time`	google.protobuf.Timestamp The time when the operation was created.
`start_time`	google.protobuf.Timestamp The time when the operation was started.
`finish_time`	google.protobuf.Timestamp The time when the operation was finished.
`status`	doublecloud.v1.Operation.Status The status of the operation.
`error`	google.rpc.Status The error result of the operation in case of failure or cancellation.
`resource_id`	string ID of the resource operation performed on.

Update

Request

Field	Description
`endpoint_id`	string Identifier of the endpoint to be updated.
`name`	string The new endpoint name. Must be unique within the folder.
`description`	string The new description for the endpoint.
`labels`	list
`labels[]`	doublecloud.transfer.v1.UpdateEndpointRequest.LabelsEntry
`settings`	doublecloud.transfer.v1.EndpointSettings The new endpoint name. Must be unique within the folder.

Response

Field	Description
`id`	string ID of the operation.
`project_id`	string ID of the project where operation performed.
`description`	string Description of the operation.
`created_by`	string ID of the user or service account who initiated the operation.
`metadata`	list Operation metadata (e.g. cluster_id for create cluster operation).
`metadata[]`	doublecloud.v1.Operation.MetadataEntry
`create_time`	google.protobuf.Timestamp The time when the operation was created.
`start_time`	google.protobuf.Timestamp The time when the operation was started.
`finish_time`	google.protobuf.Timestamp The time when the operation was finished.
`status`	doublecloud.v1.Operation.Status The status of the operation.
`error`	google.rpc.Status The error result of the operation in case of failure or cancellation.
`resource_id`	string ID of the resource operation performed on.

Delete

Request

Field	Description
`endpoint_id`	string

Response

Field	Description
`id`	string ID of the operation.
`project_id`	string ID of the project where operation performed.
`description`	string Description of the operation.
`created_by`	string ID of the user or service account who initiated the operation.
`metadata`	list Operation metadata (e.g. cluster_id for create cluster operation).
`metadata[]`	doublecloud.v1.Operation.MetadataEntry
`create_time`	google.protobuf.Timestamp The time when the operation was created.
`start_time`	google.protobuf.Timestamp The time when the operation was started.
`finish_time`	google.protobuf.Timestamp The time when the operation was finished.
`status`	doublecloud.v1.Operation.Status The status of the operation.
`error`	google.rpc.Status The error result of the operation in case of failure or cancellation.
`resource_id`	string ID of the resource operation performed on.