TrafficPolicy

List traffic policies

Changed on
get/api/v1/trafficpolicies

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/trafficpolicies
  • Auth: none declared

Query parameters

ownerstring

Admin-only owner filter.

qstring

Fuzzy keyword.

mode'weighted' | 'canary'
phase'Creating' | 'Pending' | 'Ready' | 'Degraded' | 'Failed' | 'Deleting' | 'Deleted'
limitinteger

Page size (default 50, max 200).

continuestring

Opaque continue token from the previous response.

Headers

X-Axisml-Tenantstring

Active tenant for the request (fallback for the axisml.tenant cookie).

Response

A page of traffic policies.

continueTokenstring

Opaque token to fetch the next page.

countinteger required

Number of policies in this page.

partialboolean

True if the list was truncated by an upstream limit.

Example response

{
  "continueToken": "",
  "count": 1,
  "items": [
    {
      "accessUrl": "https://infer.axisml.io/services/team-vision/resnet-serving/",
      "backends": [
        {
          "actualPct": 90,
          "ready": true,
          "role": "stable",
          "serviceName": "resnet-serving-v1",
          "weight": 90
        },
        {
          "actualPct": 10,
          "ready": true,
          "role": "canary",
          "serviceName": "resnet-serving-v2",
          "weight": 10
        }
      ],
      "canaryPercent": 10,
      "createdAt": "2026-06-20T08:00:00Z",
      "description": "Canary traffic split for the ResNet-50 online inference service.",
      "displayName": "ResNet inference traffic",
      "endpoint": {
        "hostname": "infer.axisml.io",
        "path": "/services/team-vision/resnet-serving/"
      },
      "id": "d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90",
      "message": "Routing 90/10 between stable and canary.",
      "mode": "canary",
      "name": "resnet-serving",
      "namespace": "team-vision",
      "owner": "li.wei",
      "ownerId": "3a2b1c0d-4e5f-6789-abcd-ef0123456789",
      "phase": "Ready",
      "tenantDisplayName": "Vision Team",
      "tenantName": "team-vision",
      "updatedAt": "2026-06-28T09:30:00Z"
    }
  ],
  "partial": false
}

Changes

  • d51e2e0e6970Revision changes
    • breaking

      the //// response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from object to no type for status

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from string to no type for status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • info

      added to the //// response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      removed the Creating enum value from the // response property for the response status

    • info

      removed the Degraded enum value from the // response property for the response status

    • info

      removed the Deleted enum value from the // response property for the response status

    • info

      removed the Deleting enum value from the // response property for the response status

    • info

      removed the Failed enum value from the // response property for the response status

    • info

      removed the Pending enum value from the // response property for the response status

    • info

      removed the Ready enum value from the // response property for the response status

    • info

      removed the canary enum value from the //// response property for the response status

    • info

      removed the canary enum value from the // response property for the response status

    • info

      removed the member enum value from the //// response property for the response status

    • info

      removed the stable enum value from the //// response property for the response status

    • info

      removed the weighted enum value from the // response property for the response status