Get connectors in the group

GET 
/sse/connector/v2.0/api/connector-groups/:oid/connectors

Retrieve a list of all the connectors in the specified connector group.

Request

Path Parameters

oid stringrequired

Object ID

Responses

200

OK

application/json

Schema

Schema

connectors object
limit numberrequired
The offset that points to the beginning of the next page. May be same as total.
offset numberrequired
Starting entity for Pagination (0-based. i.e. first entity starts at 0)
total numberrequired
Total number of entries available
data object[]required
Array [
description string
group stringrequired
Oid of connector group
name stringrequired
oid stringrequired
block_id number
cgnx_element_id string
cgnx_element_serial_no string
cgnx_fabric_route_id string
cgnx_internet_circuit_id string
cgnx_ipsec_intf_id string
cgnx_ipsec_profile string
cgnx_lan_intf_id string
cgnx_machine_id string
cgnx_nat_policyset string
cgnx_nat_setstack string
cgnx_nat_zone string
cgnx_site_id string
cgnx_snat_rule string
cgnx_sw_version string
cgnx_tenant_id string
cgnx_vion_ip string
cgnx_wan_intf_id string
cidr string
error object
fabric_address_cidr string
is_autoscaled boolean
latitude string
local_ip string
longitude string
peer_id string
pool_id number
psk string
sc_id string
Service Connection ID
scaled_down_time string
site string
state number
state_bits number
tenant_id string
token_active string
token_secret string
tun_mon_ip string
created_time string
updated_time string
]
group object

description string

is_autoscale booleanrequired

name stringrequired

oid stringrequired

Connector Group ID

Example (from schema)

{
  "connectors": {
    "limit": 0,
    "offset": 0,
    "total": 0,
    "data": [
      {
        "description": "string",
        "group": "string",
        "name": "string",
        "oid": "string",
        "block_id": 0,
        "cgnx_element_id": "string",
        "cgnx_element_serial_no": "string",
        "cgnx_fabric_route_id": "string",
        "cgnx_internet_circuit_id": "string",
        "cgnx_ipsec_intf_id": "string",
        "cgnx_ipsec_profile": "string",
        "cgnx_lan_intf_id": "string",
        "cgnx_machine_id": "string",
        "cgnx_nat_policyset": "string",
        "cgnx_nat_setstack": "string",
        "cgnx_nat_zone": "string",
        "cgnx_site_id": "string",
        "cgnx_snat_rule": "string",
        "cgnx_sw_version": "string",
        "cgnx_tenant_id": "string",
        "cgnx_vion_ip": "string",
        "cgnx_wan_intf_id": "string",
        "cidr": "string",
        "error": {},
        "fabric_address_cidr": "string",
        "is_autoscaled": true,
        "latitude": "string",
        "local_ip": "string",
        "longitude": "string",
        "peer_id": "string",
        "pool_id": 0,
        "psk": "string",
        "sc_id": "string",
        "scaled_down_time": "string",
        "site": "string",
        "state": 0,
        "state_bits": 0,
        "tenant_id": "string",
        "token_active": "string",
        "token_secret": "string",
        "tun_mon_ip": "string",
        "created_time": "string",
        "updated_time": "string"
      }
    ]
  },
  "group": {
    "description": "string",
    "is_autoscale": true,
    "name": "string",
    "oid": "string"
  }
}

400

Bad Request because an oid required by specific endpoint is missing from request

application/json

Schema

Schema

error object
oneOf
google.rpc.Code.InvalidArgument
code number
Possible values: [3]
details object[]
Array [
anyOf
Retry Info
@type string
Possible values: [type.googleapis.com/google.rpc.RetryInfo]
retry_delay object
nanos number
seconds number
Debug Info
@type string
Possible values: [type.googleapis.com/google.rpc.DebugInfo]
detail string
stack_entries string[]
Quota Failure
@type string
Possible values: [type.googleapis.com/google.rpc.QuotaFailure]
violations object[]
Array [
description string
subject string
]
Error Info
@type string
Possible values: [type.googleapis.com/google.rpc.ErrorInfo]
domain string
metadata object
property name* string
reason string
Precondition Failure
@type string
Possible values: [type.googleapis.com/google.rpc.PreconditionFailure]
violations object[]
Array [
description string
subject string
type string
]
Bad Request
@type string
Possible values: [type.googleapis.com/google.rpc.BadRequest]
field_violations object[]
Array [
description string
field string
]
Request Info
@type string
Possible values: [type.googleapis.com/google.rpc.RequestInfo]
request_id string
serving_data string
Resource Info
@type string
Possible values: [type.googleapis.com/google.rpc.ResourceInfo]
description string
owner string
resource_name string
resource_type string
Help
@type string
Possible values: [type.googleapis.com/google.rpc.Help]
links object[]
Array [
description string
url string
]
Localized Message
@type string
Possible values: [type.googleapis.com/google.rpc.LocalizedMessage]
locale string
message string
Cause Info
@type stringrequired
Possible values: [google-cloud-api/CauseInfo]
causes object[]required
Array [
causes
message stringrequired
module string
]
]
message string
google.rpc.Code.FailedPrecondition
code number
Possible values: [9]
details object[]
Array [
anyOf
Retry Info
@type string
Possible values: [type.googleapis.com/google.rpc.RetryInfo]
retry_delay object
nanos number
seconds number
Debug Info
@type string
Possible values: [type.googleapis.com/google.rpc.DebugInfo]
detail string
stack_entries string[]
Quota Failure
@type string
Possible values: [type.googleapis.com/google.rpc.QuotaFailure]
violations object[]
Array [
description string
subject string
]
Error Info
@type string
Possible values: [type.googleapis.com/google.rpc.ErrorInfo]
domain string
metadata object
property name* string
reason string
Precondition Failure
@type string
Possible values: [type.googleapis.com/google.rpc.PreconditionFailure]
violations object[]
Array [
description string
subject string
type string
]
Bad Request
@type string
Possible values: [type.googleapis.com/google.rpc.BadRequest]
field_violations object[]
Array [
description string
field string
]
Request Info
@type string
Possible values: [type.googleapis.com/google.rpc.RequestInfo]
request_id string
serving_data string
Resource Info
@type string
Possible values: [type.googleapis.com/google.rpc.ResourceInfo]
description string
owner string
resource_name string
resource_type string
Help
@type string
Possible values: [type.googleapis.com/google.rpc.Help]
links object[]
Array [
description string
url string
]
Localized Message
@type string
Possible values: [type.googleapis.com/google.rpc.LocalizedMessage]
locale string
message string
Cause Info
@type stringrequired
Possible values: [google-cloud-api/CauseInfo]
causes object[]required
Array [
causes
message stringrequired
module string
]
]
message string

Example (from schema)

{
  "error": {}
}

401

Unauthorized

application/json

Schema

Schema

error object
code number
Possible values: [16]
details object[]
Array [
anyOf
Retry Info
@type string
Possible values: [type.googleapis.com/google.rpc.RetryInfo]
retry_delay object
nanos number
seconds number
Debug Info
@type string
Possible values: [type.googleapis.com/google.rpc.DebugInfo]
detail string
stack_entries string[]
Quota Failure
@type string
Possible values: [type.googleapis.com/google.rpc.QuotaFailure]
violations object[]
Array [
description string
subject string
]
Error Info
@type string
Possible values: [type.googleapis.com/google.rpc.ErrorInfo]
domain string
metadata object
property name* string
reason string
Precondition Failure
@type string
Possible values: [type.googleapis.com/google.rpc.PreconditionFailure]
violations object[]
Array [
description string
subject string
type string
]
Bad Request
@type string
Possible values: [type.googleapis.com/google.rpc.BadRequest]
field_violations object[]
Array [
description string
field string
]
Request Info
@type string
Possible values: [type.googleapis.com/google.rpc.RequestInfo]
request_id string
serving_data string
Resource Info
@type string
Possible values: [type.googleapis.com/google.rpc.ResourceInfo]
description string
owner string
resource_name string
resource_type string
Help
@type string
Possible values: [type.googleapis.com/google.rpc.Help]
links object[]
Array [
description string
url string
]
Localized Message
@type string
Possible values: [type.googleapis.com/google.rpc.LocalizedMessage]
locale string
message string
Cause Info
@type stringrequired
Possible values: [google-cloud-api/CauseInfo]
causes object[]required
Array [
causes
message stringrequired
module string
]
]
message string

Example (from schema)

{
  "error": {
    "code": 16,
    "details": [
      {},
      {},
      {},
      {},
      {},
      {},
      {},
      {},
      {},
      {},
      {}
    ],
    "message": "string"
  }
}

not_authenticated

Not Authenticated

{
  "error": {
    "code": 16,
    "message": "Not Authenticated"
  }
}

token_expired

Token Expired

{
  "error": {
    "code": 16,
    "message": "Token Expired"
  }
}

404

404 Not Found

application/json

Schema

Schema

error object
code number
Possible values: [5]
details object[]
Array [
anyOf
Retry Info
@type string
Possible values: [type.googleapis.com/google.rpc.RetryInfo]
retry_delay object
nanos number
seconds number
Debug Info
@type string
Possible values: [type.googleapis.com/google.rpc.DebugInfo]
detail string
stack_entries string[]
Quota Failure
@type string
Possible values: [type.googleapis.com/google.rpc.QuotaFailure]
violations object[]
Array [
description string
subject string
]
Error Info
@type string
Possible values: [type.googleapis.com/google.rpc.ErrorInfo]
domain string
metadata object
property name* string
reason string
Precondition Failure
@type string
Possible values: [type.googleapis.com/google.rpc.PreconditionFailure]
violations object[]
Array [
description string
subject string
type string
]
Bad Request
@type string
Possible values: [type.googleapis.com/google.rpc.BadRequest]
field_violations object[]
Array [
description string
field string
]
Request Info
@type string
Possible values: [type.googleapis.com/google.rpc.RequestInfo]
request_id string
serving_data string
Resource Info
@type string
Possible values: [type.googleapis.com/google.rpc.ResourceInfo]
description string
owner string
resource_name string
resource_type string
Help
@type string
Possible values: [type.googleapis.com/google.rpc.Help]
links object[]
Array [
description string
url string
]
Localized Message
@type string
Possible values: [type.googleapis.com/google.rpc.LocalizedMessage]
locale string
message string
Cause Info
@type stringrequired
Possible values: [google-cloud-api/CauseInfo]
causes object[]required
Array [
causes
message stringrequired
module string
]
]
message string

Example (from schema)

{
  "error": {
    "code": 5,
    "details": [
      {},
      {},
      {},
      {},
      {},
      {},
      {},
      {},
      {},
      {},
      {}
    ],
    "message": "string"
  }
}

Loading...