Operate on SR policy data list - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"Operate on SR policy data list","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/b95772dc6c621d9842faced8610ee58b0cb9cb02/3d89d4b5-ca39-3db6-845a-ca999a1058d3","info":{"description":"This API provides operations for managing Segment Routing (SR) policies, including creation, modification, deletion, and dry-run simulations.","version":"7.1.0","title":"Cisco Crosswork SR Policy Operations API","contact":{"name":"API Support","url":"https://www.cisco.com/support","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"}},"swagger":"2.0","host":"localhost:30603","basePath":"/crosswork/nbi/optimization/v3/restconf","securityDefinitions":{"api_key":{"description":"Authentication: Bearer $JWT","type":"apiKey","name":"api_key","in":"header"}}},"spec":{"operationId":"srDatalistOper","tags":["cisco-crosswork-optimization-engine-sr-policy-operations"],"summary":"Operate on SR policy data list","description":"Performs operations on the SR policy data list, including retrieval and updates.","parameters":[{"in":"body","name":"sr.policy.operations.srdatalistoper.Input.body-param","description":"Input parameters for SR policy data list operation.","required":false,"schema":{"type":"object","properties":{"input":{"type":"object","properties":{"not-pce-initiated":{"type":"boolean","description":"indicating whether this orphan list is not for lsps initiated by pce."},"last-update-time":{"type":"integer","format":"int32","description":"Last update time, timestamp in Unix Epoch. For datalist query"},"offset":{"type":"integer","format":"int64","description":"offset of the list (start from 0). if it's not 0 for GET, the list should start from offset, not from beginning"},"action":{"description":"Action type of this request","type":"string","enum":["GET","SAVE","DELETE","RESPONSE","SYNC_START","SYNC_DONE"],"$$ref":"#/definitions/common.ActionEnumeration"},"end-of-list":{"type":"boolean","description":"Whether this is the last pieceof the list"},"application-id":{"type":"string","description":"Application id"},"is-orphan":{"type":"boolean","description":"indicating whether this is an orphan list or not"},"source-app-id":{"type":"string","description":"Filter based on source app id"},"sr-policy-datalist":{"type":"array","items":{"type":"object","properties":{"disjoint-type":{"description":"Disjoint type.","type":"string","enum":["UNRECOGNIZED_TYPE","LINK","NODE","SRLG","SRLGNODE4"],"$$ref":"#/definitions/common.DisjointType"},"binding-sid":{"type":"integer","format":"int64","description":"binding sid."},"include-all":{"type":"integer","format":"int64","description":"Include all."},"description":{"type":"string","description":"Policy description"},"bandwidth-mbps":{"type":"integer","format":"int64","description":"Bandwidth percentage."},"optimization-objective":{"description":"Optimization-objective.","type":"string","enum":["igp-metric","te-metric","delay","hop-count"],"$$ref":"#/definitions/common.OptimizationObjective"},"association-group":{"type":"integer","format":"int64","description":"AssociationGroup."},"include-any":{"type":"integer","format":"int64","description":"Include any."},"protected":{"type":"boolean","description":"Path is protected."},"profile_id":{"type":"integer","format":"int64","description":"Profile Id."},"deployment-status":{"description":"Deployment status.","type":"string","enum":["NOT_SET","INITIATED","ACTIVE","FAILED"],"$$ref":"#/definitions/common.DeploymentStatusEnumeration"},"exclude-any":{"type":"integer","format":"int64","description":"Exclude any."},"association-subgroup":{"type":"integer","format":"int64","description":"AssociationSubGroup."},"source-app-id":{"type":"string","description":"Source applicatoin id."},"policy-path-type":{"description":"Policy path type.","type":"string","enum":["EXPLICIT","DYNAMIC","BW_ON_DEMAND"],"$$ref":"#/definitions/common.PathType"},"head-end":{"type":"string","description":"Policy head end IP address string or host name"},"sid-algo":{"type":"integer","format":"int64","description":"sid algo."},"color":{"type":"integer","format":"int64","description":"Color associated with the policy"},"end-point":{"type":"string","description":"Policy end point IP address or host name"},"path_name":{"type":"string","description":"Path name"}},"description":"SR Policy properties","$$ref":"#/definitions/common.srpolicydatalistinfo.SrPolicyDatalist"}}},"$$ref":"#/definitions/sr.policy.operations.srdatalistoper.Input"}}}}],"responses":{"200":{"description":"Correct response","schema":{"type":"object","properties":{"output":{"type":"object","properties":{"not-pce-initiated":{"type":"boolean","description":"indicating whether this orphan list is not for lsps initiated by pce."},"last-update-time":{"type":"integer","format":"int32","description":"Last update time, timestamp in Unix Epoch. For datalist query"},"offset":{"type":"integer","format":"int64","description":"offset of the list (start from 0). if it's not 0 for GET, the list should start from offset, not from beginning"},"action":{"description":"Action type of this request","type":"string","enum":["GET","SAVE","DELETE","RESPONSE","SYNC_START","SYNC_DONE"],"$$ref":"#/definitions/common.ActionEnumeration"},"end-of-list":{"type":"boolean","description":"Whether this is the last pieceof the list"},"application-id":{"type":"string","description":"Application id"},"is-orphan":{"type":"boolean","description":"indicating whether this is an orphan list or not"},"source-app-id":{"type":"string","description":"Filter based on source app id"},"p2mp-datalist":{"type":"array","items":{"type":"object","properties":{"disjoint-type":{"description":"Disjoint type.","type":"string","enum":["UNRECOGNIZED_TYPE","LINK","NODE","SRLG","SRLGNODE4"],"$$ref":"#/definitions/common.DisjointType"},"binding-sid":{"type":"integer","format":"int64","description":"binding sid."},"include-all":{"type":"integer","format":"int64","description":"Include all."},"description":{"type":"string","description":"Policy description"},"bandwidth-mbps":{"type":"integer","format":"int64","description":"Bandwidth percentage."},"optimization-objective":{"description":"Optimization-objective.","type":"string","enum":["igp-metric","te-metric","delay","hop-count"],"$$ref":"#/definitions/common.OptimizationObjective"},"association-group":{"type":"integer","format":"int64","description":"AssociationGroup."},"include-any":{"type":"integer","format":"int64","description":"Include any."},"protected":{"type":"boolean","description":"Path is protected."},"profile_id":{"type":"integer","format":"int64","description":"Profile Id."},"deployment-status":{"description":"Deployment status.","type":"string","enum":["NOT_SET","INITIATED","ACTIVE","FAILED"],"$$ref":"#/definitions/common.DeploymentStatusEnumeration"},"exclude-any":{"type":"integer","format":"int64","description":"Exclude any."},"association-subgroup":{"type":"integer","format":"int64","description":"AssociationSubGroup."},"source-app-id":{"type":"string","description":"Source applicatoin id."},"name":{"type":"string","description":"Name of p2mp policy."},"root-node":{"type":"string","description":"String of root nodes."},"lfa-frr":{"type":"boolean","description":"LFA FRR enabled or not."},"leaf-nodes":{"type":"string","description":"String of leaf nodes."},"treesid-label":{"type":"integer","format":"int64","description":"Label of Tree Sid."}},"description":"SR Policy properties","$$ref":"#/definitions/common.p2mpdatalistinfo.P2mpDatalist"}},"rsvp-datalist":{"type":"array","items":{"type":"object","properties":{"disjoint-type":{"description":"Disjoint type.","type":"string","enum":["UNRECOGNIZED_TYPE","LINK","NODE","SRLG","SRLGNODE4"],"$$ref":"#/definitions/common.DisjointType"},"binding-sid":{"type":"integer","format":"int64","description":"binding sid."},"include-all":{"type":"integer","format":"int64","description":"Include all."},"description":{"type":"string","description":"Policy description"},"bandwidth-mbps":{"type":"integer","format":"int64","description":"Bandwidth percentage."},"optimization-objective":{"description":"Optimization-objective.","type":"string","enum":["igp-metric","te-metric","delay","hop-count"],"$$ref":"#/definitions/common.OptimizationObjective"},"association-group":{"type":"integer","format":"int64","description":"AssociationGroup."},"include-any":{"type":"integer","format":"int64","description":"Include any."},"protected":{"type":"boolean","description":"Path is protected."},"profile_id":{"type":"integer","format":"int64","description":"Profile Id."},"deployment-status":{"description":"Deployment status.","type":"string","enum":["NOT_SET","INITIATED","ACTIVE","FAILED"],"$$ref":"#/definitions/common.DeploymentStatusEnumeration"},"exclude-any":{"type":"integer","format":"int64","description":"Exclude any."},"association-subgroup":{"type":"integer","format":"int64","description":"AssociationSubGroup."},"source-app-id":{"type":"string","description":"Source applicatoin id."},"head-end":{"type":"string","description":"Policy head end IP address string or host name"},"end-point":{"type":"string","description":"Policy end point IP address or host name"},"path-name":{"type":"string","description":"Path name"},"frr-enabled":{"type":"boolean","description":"FRR enabled or not."},"signaled-bandwidth":{"type":"integer","format":"int32","description":"Signaled Bandwidth."},"setup-priority":{"type":"integer","format":"int64","description":"Setup Priority."},"hold-priority":{"type":"integer","format":"int64","description":"Hold Priority."},"tunnel-path-type":{"description":"Tunnel path type.","type":"string","enum":["EXPLICIT","DYNAMIC","BW_ON_DEMAND"],"$$ref":"#/definitions/common.PathType"}},"description":"SR Policy properties","$$ref":"#/definitions/common.rsvpdatalistinfo.RsvpDatalist"}},"message":{"type":"string","description":"The details of state above, for failure or degraded"},"state":{"description":"The result for the policy datalist operation","type":"string","enum":["success","failure","degraded"],"$$ref":"#/definitions/common.StateEnumeration"},"sr-policy-datalist":{"type":"array","items":{"type":"object","properties":{"disjoint-type":{"description":"Disjoint type.","type":"string","enum":["UNRECOGNIZED_TYPE","LINK","NODE","SRLG","SRLGNODE4"],"$$ref":"#/definitions/common.DisjointType"},"binding-sid":{"type":"integer","format":"int64","description":"binding sid."},"include-all":{"type":"integer","format":"int64","description":"Include all."},"description":{"type":"string","description":"Policy description"},"bandwidth-mbps":{"type":"integer","format":"int64","description":"Bandwidth percentage."},"optimization-objective":{"description":"Optimization-objective.","type":"string","enum":["igp-metric","te-metric","delay","hop-count"],"$$ref":"#/definitions/common.OptimizationObjective"},"association-group":{"type":"integer","format":"int64","description":"AssociationGroup."},"include-any":{"type":"integer","format":"int64","description":"Include any."},"protected":{"type":"boolean","description":"Path is protected."},"profile_id":{"type":"integer","format":"int64","description":"Profile Id."},"deployment-status":{"description":"Deployment status.","type":"string","enum":["NOT_SET","INITIATED","ACTIVE","FAILED"],"$$ref":"#/definitions/common.DeploymentStatusEnumeration"},"exclude-any":{"type":"integer","format":"int64","description":"Exclude any."},"association-subgroup":{"type":"integer","format":"int64","description":"AssociationSubGroup."},"source-app-id":{"type":"string","description":"Source applicatoin id."},"policy-path-type":{"description":"Policy path type.","type":"string","enum":["EXPLICIT","DYNAMIC","BW_ON_DEMAND"],"$$ref":"#/definitions/common.PathType"},"head-end":{"type":"string","description":"Policy head end IP address string or host name"},"sid-algo":{"type":"integer","format":"int64","description":"sid algo."},"color":{"type":"integer","format":"int64","description":"Color associated with the policy"},"end-point":{"type":"string","description":"Policy end point IP address or host name"},"path_name":{"type":"string","description":"Path name"}},"description":"SR Policy properties","$$ref":"#/definitions/common.srpolicydatalistinfo.SrPolicyDatalist"}}},"$$ref":"#/definitions/sr.policy.operations.srdatalistoper.Output"}}}},"204":{"description":"No response"},"400":{"description":"Internal error"}},"__originalOperationId":"srDatalistOper","consumes":["application/yang-data+json"],"produces":["application/yang-data+json"],"method":"post","path":"/operations/cisco-crosswork-optimization-engine-sr-policy-operations:sr-datalist-oper"}}