Skip to main content

Read profile-indexed RSVP-TE protocol sessions

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

Reads all 1-64 RSVP instances of one task-owned routing agent in saved profile order with at most eight concurrent reads. Each index addresses a protocol instance, not an LSP. A failed instance read is marked unavailable while healthy rows remain visible; all reads failing returns 502, and mixed runtime generations return 409. Per-row completion times and local CPF counts describe a non-atomic snapshot; they are not IxNetwork StateCounts.

Contract

Parameter
Value
Sectiontasks
AuthenticationCookieAuth
Consumesapplication/json
Producesapplication/json

Parameters

2 parameters

Name
Location
Required
Type
Description
idpathyesintegerCanonical positive task ID
requestbodyyesobjectTask routing agent hostname
  • {
      "agent": "<string>"
    }

Responses

8 responses

Status
Description
Type
200
OKobject
400
Invalid requestobject
401
Session requiredobject
403
Agent not registered for this taskobject
404
Task not foundobject
409
Task, agent or profile unavailableobject
500
Task lookup failedobject
502
Agent read or response contract errorobject
  • {
      "agent": "<string>",
      "cpf-counts": {
        "aborted": 0,
        "running": 0,
        "stopped": 0,
        "tearing-down": 0,
        "total": 0,
        "unavailable": 0
      },
      "partial": true,
      "profile-revision": "<string>",
      "runtime-generation": "<string>",
      "sessions": [
        {
          "cpf-state": "<string>",
          "index": 0,
          "instance": 0,
          "read-completed-at": "<string>",
          "read-error": "<string>",
          "router-id": "<string>",
          "runtime-generation": "<string>"
        }
      ],
      "snapshot-atomic": true,
      "task-id": 0
    }
  • {
      "data": {},
      "error": "<string>"
    }
  • {
      "data": {},
      "error": "<string>"
    }
  • {
      "data": {},
      "error": "<string>"
    }
  • {
      "data": {},
      "error": "<string>"
    }
  • {
      "data": {},
      "error": "<string>"
    }
  • {
      "data": {},
      "error": "<string>"
    }
  • {
      "data": {},
      "error": "<string>"
    }