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
Object ID
Responses
- 200
- 400
- 401
- 404
OK
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
connectors object
The offset that points to the beginning of the next page. May be same as total.
Starting entity for Pagination (0-based. i.e. first entity starts at 0)
Total number of entries available
data object[]required
Oid of connector group
Service Connection ID
group object
Connector Group ID
{
"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"
}
}
Bad Request because an oid required by specific endpoint is missing from request
- application/json
- Schema
- Example (from schema)
Schema
- google.rpc.Code.InvalidArgument
- google.rpc.Code.FailedPrecondition
- Array [
- Retry Info
- Debug Info
- Quota Failure
- Error Info
- Precondition Failure
- Bad Request
- Request Info
- Resource Info
- Help
- Localized Message
- Cause Info
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- ]
- Array [
- Retry Info
- Debug Info
- Quota Failure
- Error Info
- Precondition Failure
- Bad Request
- Request Info
- Resource Info
- Help
- Localized Message
- Cause Info
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- ]
error object
Possible values: [3
]
details object[]
Possible values: [type.googleapis.com/google.rpc.RetryInfo
]
retry_delay object
Possible values: [type.googleapis.com/google.rpc.DebugInfo
]
Possible values: [type.googleapis.com/google.rpc.QuotaFailure
]
violations object[]
Possible values: [type.googleapis.com/google.rpc.ErrorInfo
]
metadata object
Possible values: [type.googleapis.com/google.rpc.PreconditionFailure
]
violations object[]
Possible values: [type.googleapis.com/google.rpc.BadRequest
]
field_violations object[]
Possible values: [type.googleapis.com/google.rpc.RequestInfo
]
Possible values: [type.googleapis.com/google.rpc.ResourceInfo
]
Possible values: [type.googleapis.com/google.rpc.Help
]
links object[]
Possible values: [type.googleapis.com/google.rpc.LocalizedMessage
]
Possible values: [google-cloud-api/CauseInfo
]
causes object[]required
Possible values: [9
]
details object[]
Possible values: [type.googleapis.com/google.rpc.RetryInfo
]
retry_delay object
Possible values: [type.googleapis.com/google.rpc.DebugInfo
]
Possible values: [type.googleapis.com/google.rpc.QuotaFailure
]
violations object[]
Possible values: [type.googleapis.com/google.rpc.ErrorInfo
]
metadata object
Possible values: [type.googleapis.com/google.rpc.PreconditionFailure
]
violations object[]
Possible values: [type.googleapis.com/google.rpc.BadRequest
]
field_violations object[]
Possible values: [type.googleapis.com/google.rpc.RequestInfo
]
Possible values: [type.googleapis.com/google.rpc.ResourceInfo
]
Possible values: [type.googleapis.com/google.rpc.Help
]
links object[]
Possible values: [type.googleapis.com/google.rpc.LocalizedMessage
]
Possible values: [google-cloud-api/CauseInfo
]
causes object[]required
{
"error": {}
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- not_authenticated
- token_expired
Schema
- Array [
- Retry Info
- Debug Info
- Quota Failure
- Error Info
- Precondition Failure
- Bad Request
- Request Info
- Resource Info
- Help
- Localized Message
- Cause Info
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- ]
error object
Possible values: [16
]
details object[]
Possible values: [type.googleapis.com/google.rpc.RetryInfo
]
retry_delay object
Possible values: [type.googleapis.com/google.rpc.DebugInfo
]
Possible values: [type.googleapis.com/google.rpc.QuotaFailure
]
violations object[]
Possible values: [type.googleapis.com/google.rpc.ErrorInfo
]
metadata object
Possible values: [type.googleapis.com/google.rpc.PreconditionFailure
]
violations object[]
Possible values: [type.googleapis.com/google.rpc.BadRequest
]
field_violations object[]
Possible values: [type.googleapis.com/google.rpc.RequestInfo
]
Possible values: [type.googleapis.com/google.rpc.ResourceInfo
]
Possible values: [type.googleapis.com/google.rpc.Help
]
links object[]
Possible values: [type.googleapis.com/google.rpc.LocalizedMessage
]
Possible values: [google-cloud-api/CauseInfo
]
causes object[]required
{
"error": {
"code": 16,
"details": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"message": "string"
}
}
{
"error": {
"code": 16,
"message": "Not Authenticated"
}
}
{
"error": {
"code": 16,
"message": "Token Expired"
}
}
404 Not Found
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Retry Info
- Debug Info
- Quota Failure
- Error Info
- Precondition Failure
- Bad Request
- Request Info
- Resource Info
- Help
- Localized Message
- Cause Info
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- ]
error object
Possible values: [5
]
details object[]
Possible values: [type.googleapis.com/google.rpc.RetryInfo
]
retry_delay object
Possible values: [type.googleapis.com/google.rpc.DebugInfo
]
Possible values: [type.googleapis.com/google.rpc.QuotaFailure
]
violations object[]
Possible values: [type.googleapis.com/google.rpc.ErrorInfo
]
metadata object
Possible values: [type.googleapis.com/google.rpc.PreconditionFailure
]
violations object[]
Possible values: [type.googleapis.com/google.rpc.BadRequest
]
field_violations object[]
Possible values: [type.googleapis.com/google.rpc.RequestInfo
]
Possible values: [type.googleapis.com/google.rpc.ResourceInfo
]
Possible values: [type.googleapis.com/google.rpc.Help
]
links object[]
Possible values: [type.googleapis.com/google.rpc.LocalizedMessage
]
Possible values: [google-cloud-api/CauseInfo
]
causes object[]required
{
"error": {
"code": 5,
"details": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"message": "string"
}
}