Skip to main content

Get Subnet

GET 

/projects/:projectId/providers/Aruba.Network/vpcs/:vpcId/subnets/:id

Get Subnet

Request

Path Parameters

    projectId stringrequired

    unique identifier of the project CMP

    vpcId stringrequired

    unique identifier of the vpc in which the subnet has been created

    id stringrequired

    unique identifier of the subnet to retrieve

Query Parameters

    ignoreDeletedStatus boolean

    if the resource exists in status "Deleted", returns NotFound according to the value of this flag

    Default value: false
    api-version string

    The requested API version

    Default value: 1.0

Responses

Success

Schema

    metadata

    object

    nullable

    idstringnullable
    uristringnullable
    namestringnullable

    location

    object

    nullable

    codestringnullable
    countrystringnullable
    citystringnullable
    namestringnullable
    valuestringnullable

    project

    object

    nullable

    idstringnullable
    tagsstring[]nullable

    category

    object

    nullable

    namestringnullable
    providerstringnullable

    typology

    object

    nullable

    idstringnullable
    namestringnullable
    creationDatedate-timenullable
    createdBystringnullable
    updateDatedate-timenullable
    updatedBystringnullable
    versionstringnullable
    createdUserstringnullable
    updatedUserstringnullable

    status

    object

    nullable

    statestringnullable
    creationDatedate-timenullable

    disableStatusInfo

    object

    nullable

    isDisabledboolean
    reasonsstring[]nullable

    previousStatus

    object

    nullable

    statestringnullable
    creationDatedate-timenullable
    failureReasonstringnullable

    properties

    object

    nullable

    linkedResources

    object[]

    nullable

  • Array [

  • uristringnullable
    strictCorrelationboolean
  • ]

  • vpc

    object

    nullable

    the vpc where the subnet belongs

    uristringnullable
    typeSubnetType (string)

    type of the subnet

    Possible values: [Basic, Advanced]

    defaultboolean

    Indicates if the security group is the default one within the vpc

    network

    object

    nullable

    Details of the network

    addressstringnullable

    Address of the network in CIDR Notation

    gatewaystringnullable

    IP address of the gateway

    dhcp

    object

    nullable

    Details of the dhcp

    enabledboolean

    True if dhcp is enables

    range

    object

    nullable

    Range values for ip addresses

    startstringnullable

    First ip address

    countint32

    Number of available ip addresses

    laststringnullable

    Last ip address

    routes

    object[]

    nullable

    List of routes

  • Array [

  • addressstringnullable

    Ip address of the route

    gatewaystringnullable

    Gateway

  • ]

  • dnsstring[]nullable

    List of dns