Get Vdc Groups
Get a list of vDC Groups. To find all vDC Groups that contains a specific Organization vDC, user can use the filter "participatingOrgVdcs.vdcRef.id" key.
Request
URI
GET
https://{api_host}/cloudapi/1.0.0/vdcGroups
COPY
Query Parameters
string
filter
Optional
Filter for a query. FIQL format.
string
sortAsc
Optional
Field to use for ascending sort
string
sortDesc
Optional
Field to use for descending sort
integer
page
Required
Constraints:
minimum: 1
default: 1
Page to fetch, zero offset.
integer
pageSize
Required
Constraints:
minimum: 0
maximum: 128
default: 25
Results per page to fetch.
Responses
200
OK
Returns
VdcGroups
of type(s)
application/json;version=39.1
This response body class contains all of the following:
InlineVdcGroups0 ,
InlineVdcGroups1
{
"resultTotal": 0,
"pageCount": 0,
"page": 0,
"pageSize": 0,
"associations": [
{
"entityId": "string",
"associationId": "string"
}
],
"values": [
{
"id": "string",
"orgId": "string",
"name": "string",
"description": "string",
"localEgress": false,
"participatingOrgVdcs": [
{
"id": "string",
"vdcRef": {
"name": "string",
"id": "string"
},
"orgRef": {
"name": "string",
"id": "string"
},
"siteRef": {
"name": "string",
"id": "string"
},
"networkProviderScope": "string",
"faultDomainTag": "string",
"remoteOrg": false,
"status": {}
}
],
"participatingOrgVdcCount": 0,
"universalNetworkingEnabled": false,
"networkPoolUniversalId": "string",
"networkPoolId": "string",
"status": {},
"type": "string",
"networkProviderType": "string",
"dfwEnabled": false,
"errorMessage": "string",
"networkingTenancyEnabled": false
}
]
}
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/cloudapi/1.0.0/vdcGroups?page=value&pageSize=v