Get Compute Policies | VMware Cloud Director OpenAPI

Get Compute Policies

Retrieves all compute policies of a vDC

Request

URI

GET

https://{api_host}/cloudapi/1.0.0/vdcs/{orgVdcId}/computePolicies

COPY

Path Parameters

string

orgVdcId

Required

orgVdcId

string

orgVdcId

Required

orgVdcId

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

Page to fetch, zero offset.

integer

pageSize

Required

Results per page to fetch.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns VdcComputePolicies2 of type(s) application/json;version=39.0

This response body class contains all of the following: Page , InlineVdcComputePolicies21

{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "description": "This is an example payload to create a policy of type VdcKubernetesPolicy.\nFollow /1.0.0/vdcComputePolicies example to know payload to create a VdcVmPolicy type\nof compute policy. Note that policyType field will have to be added to the payload taken\nfrom /1.0.0/vdcComputePolicies example, if you are using /2.0.0/vdcComputePolicies.\n",
            "policyType": "VdcKubernetesPolicy",
            "name": "myPolicy",
            "pvdcComputePolicy": {
                "name": "nameOfPvdcPolicy",
                "id": "urn:vcloud:pvdcComputePolicy:494f4a50-09ce-4ba7-913b-3fde593bc7ef"
            },
            "kubernetesConfig": {
                "storageClasses": [
                    {
                        "storageClass": "gold",
                        "limit": 20480
                    },
                    {
                        "storageClass": "silver",
                        "limit": 10240
                    }
                ],
                "virtualMachineClasses": [
                    "best-effort-xsmall",
                    "best-effort-small"
                ],
                "namespaceResourceSpec": {
                    "cpuLimit": 1000,
                    "memoryLimit": 1024,
                    "memoryReservationGuarantee": 1,
                    "cpuReservationGuarantee": 1
                }
            },
            "vdc": {
                "name": "vdc1",
                "id": "urn:vcloud:vdc:f8dfe02d-47e5-4e3c-ba71-f0d67810d0ef"
            }
        }
    ]
}

Availability

Added in 33.0

Deprecated in 35.0

With alternative: see

2.0.0 version of API

Removed in 39.0

On This Page

Description

Request

Path Parameters

Query Parameters

Authentication