Read RSVP interface and neighbor state for one instance

POST

/tasks/{id}/rsvp/protocol/query

Proxies sequential read-only native interface, neighbor, CPF and local recovery schedule state queries to one named routing agent of a RUNNING task. Optional expected-offset and expected-limit (1..128) must be supplied together to read one bounded, name-sorted PCEP expected-LSP state page with its own observation timestamp. This is not IxNetwork StateCounts: it reports native state from one RSVP instance, with independent observation timestamps.

Contract

Parameter	Value
Section	tasks
Authentication	CookieAuth
Consumes	application/json
Produces	application/json

Parameters

2 parameters

Name	Location	Required	Type	Description
id	path	yes	integer	Canonical positive task ID
request	body	yes	object	Agent hostname and instance ID

Parameter request: object

{
  "agent": "<string>",
  "expected-limit": 0,
  "expected-offset": 0,
  "instance": 0
}

Responses

9 responses

Status	Description	Type
200	OK	object
400	Invalid request	object
401	Session required	object
403	Agent not registered for this task or license denied	object
404	Task or RSVP instance not found	object
409	Task or agent unavailable	object
500	Task lookup failed	object
502	Agent transport or response contract error	object
504	Agent request deadline exceeded	object

Response 200: object

{
  "cpf-state": "<string>",
  "instance": 0,
  "interfaces": [
    {}
  ],
  "interfaces-observed-at": "<string>",
  "label-pool": {
    "label-pool-last-from": 0,
    "label-pool-last-operation-id": "<string>",
    "label-pool-last-to": 0,
    "label-range-size": 0,
    "label-range-start": 0
  },
  "local-recovery": {
    "pending": 0,
    "phase": "<string>",
    "recovery-ms": 0,
    "restart-ms": 0,
    "role": "<string>"
  },
  "local-recovery-schedule": {
    "completed": 0,
    "cycle-pending": true,
    "last-error": "<string>",
    "recovery-ms": 0,
    "restart-ms": 0,
    "start-ms": 0,
    "started": 0,
    "state": "<string>",
    "target": 0,
    "up-ms": 0
  },
  "neighbors": [
    {}
  ],
  "neighbors-observed-at": "<string>",
  "pcep": {
    "expected-initiated-lsps": 0,
    "expected-initiated-matched": 0,
    "expected-initiated-up": 0,
    "initiations-negotiated": true,
    "last-error": "<string>",
    "local-initiations-allowed": true,
    "local-stateful": true,
    "local-updates-allowed": true,
    "pce-initiated-delegated": 0,
    "pce-initiated-lsps": 0,
    "pce-initiated-orphaned": 0,
    "peer-address": "<string>",
    "peer-initiations-allowed": true,
    "peer-port": 0,
    "peer-stateful": true,
    "peer-updates-allowed": true,
    "state": "<string>",
    "stateful-negotiated": true,
    "updates-negotiated": true
  },
  "pcep-expected-observed-at": "<string>",
  "pcep-expected-page": {
    "items": [
      {
        "delegated": 0,
        "matched": 0,
        "orphaned": 0,
        "state": "<string>",
        "symbolic-path-name": "<string>",
        "up": 0
      }
    ],
    "limit": 0,
    "offset": 0,
    "total": 0
  },
  "runtime-generation": "<string>",
  "snapshot-atomic": true,
  "stats-observed-at": "<string>",
  "task-id": 0
}

{ "data": {}, "error": "<string>" }
{ "data": {}, "error": "<string>" }
{ "data": {}, "error": "<string>" }
{ "data": {}, "error": "<string>" }
{ "data": {}, "error": "<string>" }
{ "data": {}, "error": "<string>" }
{ "data": {}, "error": "<string>" }
{ "data": {}, "error": "<string>" }