Skip to main content

Start a finite RSVP-TE traffic measurement

POST
/tasks/{id}/rsvp/measurement/start

Persists admission before forwarding one request to the registered routing agent of a RUNNING task. Uses the existing native MPLS streams and agent journal. Defaults for zero or omitted duration/settle/quiet/quiesce are 1000/1000/100/5000 ms. All scopes are validated by the agent before mutation. No automatic retry or redirects. Keep the same measurement ID after an uncertain response. A saved terminal duplicate is returned without contacting the agent.

Contract

Parameter
Value
Sectiontasks
AuthenticationCookieAuth
Consumesapplication/json
Producesapplication/json

Parameters

2 parameters

Name
Location
Required
Type
Description
idpathyesintegerPositive task ID
requestbodyyesobjectNamed agent and sealed measurement identity; at most 64 KiB
  • {
      "agent": "<string>",
      "duration-ms": 0,
      "identities": [
        {
          "accept-detour": true,
          "endpoint": "<string>",
          "ext-tunnel-id": "<string>",
          "instance": 0,
          "kind": "p2p",
          "lsp-id": 0,
          "p2mp-id": 0,
          "send-detour": true,
          "sender": "<string>",
          "tunnel-id": 0
        }
      ],
      "measurement-id": "<string>",
      "quiesce-timeout-ms": 0,
      "quiet-ms": 0,
      "runtime-generation": "<string>",
      "settle-ms": 0
    }

Responses

11 responses

Status
Description
Type
200
Persisted record; sync-error means saved nonterminal status may be staleobject
202
Accepted asynchronously; record saved before this responseobject
400
Invalid JSON, identity, ID or timingobject
401
Session requiredobject
403
Agent is not a routing agent of this task, or agent license deniedobject
404
Task or measurement not foundobject
409
Task, process, agent registration or idempotency conflictobject
500
Database error; post-dispatch persistence failure explicitly requires queryobject
502
Agent authentication, address, transport, redirect, bounded response or contract errorobject
504
Mutation deadline exceeded; outcome uncertain, query the same IDobject
default
Other validated agent HTTP errors are preserved on mutationobject
  • {
      "agent": "<string>",
      "measurement-id": "<string>",
      "record": {},
      "runtime-generation": "<string>",
      "saved": true,
      "status": "<string>",
      "sync-error": "<string>",
      "terminal": true,
      "updated-at": "<string>"
    }
  • {
      "agent": "<string>",
      "measurement-id": "<string>",
      "record": {},
      "runtime-generation": "<string>",
      "saved": true,
      "status": "<string>",
      "sync-error": "<string>",
      "terminal": true,
      "updated-at": "<string>"
    }
  • {
      "data": {},
      "error": "<string>"
    }
  • {
      "data": {},
      "error": "<string>"
    }
  • {
      "data": {},
      "error": "<string>"
    }
  • {
      "data": {},
      "error": "<string>"
    }
  • {
      "data": {},
      "error": "<string>"
    }
  • {
      "data": {},
      "error": "<string>"
    }
  • {
      "data": {},
      "error": "<string>"
    }
  • {
      "data": {},
      "error": "<string>"
    }
  • {}