Getting Subnet by Name

In this article

    You can get information about a subnet with the specified name within Amazon Virtual Private Cloud (Amazon VPC) with the specified ID.

    Request

    GET https://<hostname>:4443/v6/EC2Resources/VirtualPrivateCloud/{id}/Subnets/{subnetName}

    Request Headers

    The request header must contain an authorization token of the current session.

    Request Parameters

    The following parameters must be specified in the URL of the request:

    Parameter

    Type

    Description

    id

    string

    Specifies the Amazon Virtual Private Cloud (Amazon VPC) ID. For more information on how to get this parameter, see Getting Virtual Private Cloud.

    subnetName

    string

    Specifies the subnet name. For more information on how to get this parameter, see Getting Subnets.

    accountId

    string

    Specifies the identification number of a cloud account. For more information on how to get this parameter, see Getting Accounts.

    regionId

    string

    Specifies the region ID of Amazon S3 object storage.

    For more information, see this Amazon article.

    Request Body

    None.

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns a response code 200 OK.

    Response Headers

    The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

    Header

    Description

    Content-length

    The length of the response body.

    Content-type

    The media type and syntax of the response body message: application/json; charset=utf-8

    Response Body

    The response body contains the following properties:

    Property

    Type

    Description

    id

    string

    Specifies the subnet ID.

    name

    string

    Specifies the subnet name.

    CIDR

    string

    Specifies a range of IPv4 addresses for the subnet in the form of a Classless Inter-Domain Routing (CIDR) block.

    Note: The IPv4 CIDR block for the subnet is a subset of the Amazon VPC CIDR block.

    For more information, see this Amazon article.

    Example

    The example shows how to get information about the Subnet2 subnet within Amazon Virtual Private Cloud with the ID vpc-831c72ea.

    Request:

    GET https://abc.tech.local:4443/v6/EC2Resources/VirtualPrivateCloud/vpc-831c72ea/Subnets/Subnet2?accountId=c0f030cb-a43a-4713-8da8-717c62a0b4f7&regionId=us-east-2

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

    [

     {

       "id": "subnet-093422c8c63446766",

       "name": "Subnet2",

       "cidr": "172.31.128.0/28"

     }

    ]