Vcenter Network Projects Vpcs Subnets get

Vcenter Network Projects Vpcs Subnets get

Returns information about a certain subnet in vCenter

This operation was added in vSphere API 9.0.0.0.

Request
URI
GET
https://{api_host}/api/vcenter/network/projects/{project}/vpcs/{vpc}/subnets/{subnet}
COPY
Path Parameters
string
project
Required

Identifier of the project to which the subnet belongs.

The parameter must be an identifier for the resource type: com.vmware.vcenter.network.subnet.

string
vpc
Required

Identifier of the VPC to which the subnet belongs.

The parameter must be an identifier for the resource type: com.vmware.vcenter.network.subnet.

string
subnet
Required

Identifier of the subnet.

The parameter must be an identifier for the resource type: com.vmware.vcenter.network.subnet.

Authentication
This operation uses the following authentication methods.
Responses
200

Commonly used information about this certain subnet matching project, vpc and subnet.

Returns Vcenter Network Projects Vpcs Subnets Info of type(s) application/json 
{
    "subnet": {
        "id": "string",
        "name": "string",
        "external_id": "string"
    },
    "vpc": {
        "id": "string",
        "name": "string",
        "external_id": "string"
    },
    "project": {
        "id": "string",
        "name": "string",
        "external_id": "string"
    }
}
subnet
Required

Details of the subnet.

This property was added in vSphere API 9.0.0.0.

vpc
Required

Details of the VPC.

This property was added in vSphere API 9.0.0.0.

project
Required

Details of the project.

This property was added in vSphere API 9.0.0.0.


401

if the user can not be authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0 
"Vapi Std Errors Unauthenticated Object"
string
challenge
Optional

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.


403

if the user doesn't have the required privileges.

Returns Vapi Std Errors Unauthorized of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthorized0 
"Vapi Std Errors Unauthorized Object"

404

if no matching subnet found.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0 
"Vapi Std Errors NotFound Object"

503

if the system is unable to communicate with a service to complete the request.

Returns Vapi Std Errors ServiceUnavailable of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors ServiceUnavailable0 
"Vapi Std Errors ServiceUnavailable Object"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/network/projects/{project}/vpcs/{vpc}/subnets/{subnet}
On This Page
Vcenter Operations
GET
Vcenter Network Projects Vpcs Subnets list
GET
Vcenter Network Projects Vpcs Subnets get