Create Vdc Compute Policy

Create Vdc Compute Policy

Creates a new VDC compute policy. if PolicyType is VdcKubernetesPolicy, then the response is a 202 with task URL in location header. For VdcVmPolicy type, the response is 201 with created policy in response body.

Request
URI
POST
https://{api_host}/cloudapi/2.0.0/vdcComputePolicies
COPY
Request Body
VdcComputePolicy2 of type(s) application/json
Optional
{
    "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"
    }
}
string
id
Optional

UUID for vDC compute policy. This is immutable.

string
description
Optional

description

string
policyType
Required

The discriminator type is used to differentiate among various sub policy types.

string
name
Required

Display name.

pvdcComputePolicy
Optional

pvdcComputePolicy

array of string
compatibleVdcTypes
Optional

A list of read-only compatible vDC types for this policy.

boolean
isSizingOnly
Optional

This field cannot be updated and is a read-only field in the client after creation. It defines whether the policy is SIZING_ONLY or if it also contains affinity information.

boolean
hasSizingInfo
Optional

This field cannot be updated and is a read-only field in the client after creation. It defines whether the policy has sizing details.

string
pvdcId
Optional

URN for Provider vDC.

boolean
isAutoGenerated
Optional

It is a read-only field. It indicates whether the policy is auto-generated.

Authentication
This operation uses the following authentication methods.
Responses
201

Created

Returns VdcComputePolicy2 of type(s) application/json;version=37.1
{
    "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"
    }
}
string
id
Optional

UUID for vDC compute policy. This is immutable.

string
description
Optional

description

string
policyType
Required

The discriminator type is used to differentiate among various sub policy types.

string
name
Required

Display name.

pvdcComputePolicy
Optional

pvdcComputePolicy

array of string
compatibleVdcTypes
Optional

A list of read-only compatible vDC types for this policy.

boolean
isSizingOnly
Optional

This field cannot be updated and is a read-only field in the client after creation. It defines whether the policy is SIZING_ONLY or if it also contains affinity information.

boolean
hasSizingInfo
Optional

This field cannot be updated and is a read-only field in the client after creation. It defines whether the policy has sizing details.

string
pvdcId
Optional

URN for Provider vDC.

boolean
isAutoGenerated
Optional

It is a read-only field. It indicates whether the policy is auto-generated.


202

The request have been accepted and the task to monitor the request is in the Location header.

Operation doesn't return any data structure

400

Invalid configuration.

Returns Error of type(s) application/json;version=37.1
{
    "minorErrorCode": "string",
    "message": "string",
    "stackTrace": "string"
}
string
minorErrorCode
Required

minorErrorCode

string
message
Required

message

string
stackTrace
Optional

stackTrace