SpectrumX Partition

Retrieve all SpectrumX Partitions

Changed on

Retrieve all SpectrumX Partitions for the org

Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix.

get/v2/org/{org}/nico/spectrumx-partition

Request

  • Base URL
    https://nico-rest-api.nico.svc.cluster.local
  • URL
    https://nico-rest-api.nico.svc.cluster.local/v2/org/{org}/nico/spectrumx-partition
  • Auth
    HTTP bearer

Query parameters

siteIdstring uuid

Filter Partitions by Site. Repeat the parameter to match multiple Sites.

status'Pending' | 'Provisioning' | 'Ready' | 'Error' | 'Deleting'

Filter Partitions by Status. Repeat the parameter to match multiple Statuses.

querystring

Search for matches across all SpectrumX Partitions. Input will be matched against name, description, status and labels fields

includeRelation'Site' | 'Tenant'

Related entity to expand

pageNumberinteger

One-indexed page number.

Page number for pagination query

pageSizeinteger
Example:20

Page size for pagination query

orderBy'NAME_ASC' | 'NAME_DESC' | 'STATUS_ASC' | 'STATUS_DESC' | 'CREATED_ASC' | 'CREATED_DESC' | 'UPDATED_ASC' | 'UPDATED_DESC'

Ordering for pagination query. Defaults to CREATED_ASC.

Response

OK

idstring uuid required

Unique UUID v4 identifier for the SpectrumX Partition

namestring required

Name of the SpectrumX Partition

descriptionstring nullable

Description of the SpectrumX Partition

siteIdstring uuid required

ID of the Site the Partition belongs to

tenantIdstring uuid required

ID of the Tenant that owns the Partition

vniinteger nullable

VXLAN Network Identifier for the Partition. Allocated by the Site when the create request omits it

labelsLabels

Label keys must not be empty or whitespace-only. Keys and values may contain at most 255 characters and must not contain the Unicode NUL character (U+0000). Empty values are allowed.

status'Pending' | 'Provisioning' | 'Ready' | 'Error' | 'Deleting' required

Status of the SpectrumX Partition. A Partition becomes Ready once the Site reports it in inventory

createdstring date-time

ISO datetime string for when the SpectrumX Partition was created

updatedstring date-time

ISO datetime string for when the SpectrumX Partition was last updated

Example response

[
  {
    "id": "8e6f2a1c-9b3d-4e5f-a6b7-c8d9e0f1a2b3",
    "name": "east-west-net",
    "description": "SpectrumX Partition for east-west training traffic",
    "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
    "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    "vni": 10200,
    "labels": {
      "environment": "production",
      "team": "devops"
    },
    "status": "Ready",
    "statusHistory": [
      {
        "status": "Ready",
        "message": "SpectrumX Partition is ready for use",
        "created": "2019-08-24T14:15:22Z",
        "updated": "2019-08-24T14:15:22Z"
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "updated": "2019-08-24T14:15:22Z"
  }
]

Changes

  • 04bf8e76558fRevision changes
    • info

      the response optional property /// became read-only for the status

  • 293dc126ab73Revision changes
    • info

      removed the nico enum value from the response property for the response status