VPC

Retrieve VPC routing profile

Changed on

Read the VPC's persisted routing profile, active VNI, version, and any retained allocation directly from Core. This is not the effective routing profile or evidence of DPU or fabric convergence. The ordinary VPC GET uses inventory and may lag this response.

Org must have an Infrastructure Provider entity that owns both the VPC and its Site. The VPC must belong to that Site, and the Site must be registered. User must have authorization role with PROVIDER_ADMIN suffix. Tenant administrator authorization alone is insufficient.

Inspection supports VPCs with valid pool ownership even when no named profile is stored or their virtualization type cannot support profile changes. Missing or inconsistent allocation ownership returns 412. A Site-global VNI override is not reflected in this response.

get/v2/org/{org}/nico/vpc/{vpcId}/routing-profile

Request

  • Base URL
    https://nico-rest-api.nico.svc.cluster.local
  • URL
    https://nico-rest-api.nico.svc.cluster.local/v2/org/{org}/nico/vpc/{vpcId}/routing-profile
  • Auth
    HTTP bearer

Response

Authoritative persisted routing state and VNI allocations

vpcIdstring uuid required

REST ID of the VPC selected in the request, which may differ from its Site-local Core ID.

versionstring required

Core VPC version observed with these allocations. Use this exact value when approving release of the observed inactive VNI; it is not a DPU-applied version.

routingProfilestring nullable required

Persisted profile name, or null when no named profile is stored. Known Core names are returned as the REST aliases external, internal, and privileged-internal; other names are unchanged. The name can be returned even when its Site definition is unavailable.

activeVniinteger required

Persisted active VNI verified against pool ownership. Inspection accepts nonnegative values, including zero and values outside the profile-change range; successful inspection does not imply a profile change is supported.

Example response

{
  "vpcId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "version": "V2-T1789147200000000",
  "routingProfile": "external",
  "activeVni": 51000,
  "retainedAllocation": {
    "poolName": "vpc-vni",
    "vni": 12001
  }
}

Changes

  • 293dc126ab73Revision changes
    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

  • 78f3b35615a5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status