Vcenter Network Projects Vpcs list

Vcenter Network Projects Vpcs list

Returns information about VPCs in vCenter matching the Vcenter Network Projects Vpcs FilterSpec.

This operation was added in vSphere API 9.0.0.0.

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

Identifier of the project to which the VPC belongs.

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

Query Parameters
string of array
ids
Optional

Identifiers that VPC must have to match the filter (see Vcenter Network Projects Vpcs VpcInfo.id).

This property was added in vSphere API 9.0.0.0.

If missing or null or empty, VPC with any ID match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.vcenter.network.vpc. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.vcenter.network.vpc.

string of array
names
Optional

Names that VPC must have to match the filter (see Vcenter Network Projects Vpcs VpcInfo.name).

This property was added in vSphere API 9.0.0.0.

If missing or null or empty, VPC with any name match the filter.

string of array
external_ids
Optional

External identifiers that VPC must have to match the filter (see Vcenter Network Projects Vpcs VpcInfo.external_id).

This property was added in vSphere API 9.0.0.0.

If missing or null or empty, VPC with any external identifier match the filter.

Authentication
This operation uses the following authentication methods.
Responses
200

Commonly used information about the VPC matching the Vcenter Network Projects Vpcs FilterSpec.

Returns Vcenter Network Projects Vpcs ListResult of type(s) application/json 
{
    "vpcs": [
        {
            "vpc": {
                "id": "string",
                "name": "string",
                "external_id": "string"
            },
            "project": {
                "id": "string",
                "name": "string",
                "external_id": "string"
            }
        }
    ]
}
array of object
vpcs
Required

Info(s) of VPC.

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"

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
On This Page
Vcenter Operations
GET
Vcenter Network Projects Vpcs list
GET
Vcenter Network Projects Vpcs get