NVnvidia
VPC Peering

Retrieve a VPC peering

Changed on

Get details of a VPC peering by ID.

Tenant Admin can get a peering if at least one VPC belongs to their tenant. Provider Admin can get a peering if it is in a site provided by their org.

User must have authorization role with TENANT_ADMIN or PROVIDER_ADMIN suffix.

get/v2/org/{org}/nico/vpc-peering/{id}

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-peering/{id}
  • Auth
    HTTP bearer

Query parameters

includeRelation'Vpc1' | 'Vpc2' | 'Site' | 'Tenant'

Related entity to expand

Response

OK

idstring uuid

Unique identifier of the VPC peering

vpc1Idstring uuid

ID of the first VPC in the peering

vpc2Idstring uuid

ID of the second VPC in the peering

siteIdstring uuid

ID of the Site where the peering exists

tenantIdstring uuid

ID of the tenant that created the VPC peering.

isMultiTenantboolean

Indicates if this is a multi-tenant peering (VPCs from different tenants)

status'Pending' | 'Configuring' | 'Requested' | 'Ready' | 'Deleting' | 'Error'

Status values for VPC peering objects. Deleting means removal is pending; wait until the peering's GET endpoint returns 404 before deleting either VPC.

createdstring date-time

Date and time when the VPC peering was created

updatedstring date-time

Date and time when the VPC peering was last updated

Example response

{
  "site": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "San Jose Central 4",
    "infrastructureProviderId": "5f2cc306-76e9-4fca-9186-950c9ef9a74e",
    "isSerialConsoleEnabled": true,
    "isOnline": false,
    "capabilities": {
      "nativeNetworking": false,
      "networkSecurityGroup": true,
      "nvLinkPartition": false,
      "flow": false,
      "imageBasedOperatingSystem": false,
      "vpcSlaac": false
    },
    "status": "Pending"
  },
  "tenant": {
    "capabilities": {
      "targetedInstanceCreation": true
    }
  }
}

Changes

  • 04bf8e76558fRevision changes
    • info

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

  • 273aadbf1c41Revision changes
    • info

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

    • info

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