EventRouter Service, REST: Connector.Get
Returns the specified bus.
To get the list of all available connectors, make a List request.
HTTP request
GET https://serverless-eventrouter.api.yandexcloud.kz/eventrouter/v1/connectors/{connectorId}
Path parameters
|
Field |
Description |
|
connectorId |
string Required field. ID of the connector to return. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"busId": "string",
"folderId": "string",
"cloudId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"source": {
// Includes only one of the fields `dataStream`, `messageQueue`, `timer`, `eventServiceSource`, `auditTrails`
"dataStream": {
"database": "string",
"streamName": "string",
"consumer": "string",
"serviceAccountId": "string"
},
"messageQueue": {
"queueArn": "string",
"serviceAccountId": "string",
"visibilityTimeout": "string",
"batchSize": "string",
"pollingTimeout": "string"
},
"timer": {
"cronExpression": "string",
"timeZone": "string",
"payload": "string"
},
"eventServiceSource": "object",
"auditTrails": "object"
// end of the list of possible fields
},
"deletionProtection": "boolean",
"status": "string"
}
|
Field |
Description |
|
id |
string ID of the connector. |
|
busId |
string ID of the bus that the connector belongs to. |
|
folderId |
string ID of the folder that the connector resides in. |
|
cloudId |
string ID of the cloud that the connector resides in. |
|
createdAt |
string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
name |
string Name of the connector. |
|
description |
string Description of the connector. |
|
labels |
object (map<string, string>) Resource labels as |
|
source |
Source of the connector. |
|
deletionProtection |
boolean Deletion protection. |
|
status |
enum (Status) Status of the connector.
|
Source
|
Field |
Description |
|
dataStream |
Includes only one of the fields |
|
messageQueue |
Includes only one of the fields |
|
timer |
Includes only one of the fields |
|
eventServiceSource |
object Includes only one of the fields |
|
auditTrails |
object Includes only one of the fields |
DataStream
|
Field |
Description |
|
database |
string Required field. Stream database. |
|
streamName |
string Required field. Stream name, absolute or relative. |
|
consumer |
string Required field. Consumer name. |
|
serviceAccountId |
string Required field. Service account which has read permission on the stream. |
MessageQueue
|
Field |
Description |
|
queueArn |
string Required field. Queue ARN. |
|
serviceAccountId |
string Required field. Service account which has read access to the queue. |
|
visibilityTimeout |
string (duration) Queue visibility timeout override. |
|
batchSize |
string (int64) Batch size for polling. |
|
pollingTimeout |
string (duration) Queue polling timeout. |
Timer
|
Field |
Description |
|
cronExpression |
string Required field. cron expression, with second precision |
|
timeZone |
string time zone, e.g. Europe/Moscow |
|
payload |
string payload to send to target |