Get Resource Requirements

Get Resource Requirements

Get VCF Resource Requirement.

Request
URI
POST
https://vcf.broadcom.com/fleet-lcm/v1/components/resource-requirements
COPY
Request Body
ComponentResourceRequirementsSpecs of type(s) application/json
Optional 
{
    "specs": [
        {
            "componentType": "componentType",
            "formFactor": "formFactor",
            "useExistingDeployment": true,
            "numberOfNodes": 0
        }
    ]
}
array of object
specs
Optional

specs

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ComponentsResourceRequirements of type(s) application/json 
{
    "totalStorage": 5,
    "components": [
        {
            "minInstances": 2,
            "componentType": "componentType",
            "memory": 7.061401241503109,
            "ipCountLimit": 1,
            "numberOfCores": 5,
            "storage": 9,
            "ipCountRecommended": 1,
            "workersCount": 1,
            "numberOfInstances": 3,
            "deploymentType": "OVA",
            "cpuCores": 2.3021358869347655,
            "workerNodeRequirement": "workerNodeRequirement",
            "ipCount": 7,
            "maxInstances": 4
        },
        {
            "minInstances": 2,
            "componentType": "componentType",
            "memory": 7.061401241503109,
            "ipCountLimit": 1,
            "numberOfCores": 5,
            "storage": 9,
            "ipCountRecommended": 1,
            "workersCount": 1,
            "numberOfInstances": 3,
            "deploymentType": "OVA",
            "cpuCores": 2.3021358869347655,
            "workerNodeRequirement": "workerNodeRequirement",
            "ipCount": 7,
            "maxInstances": 4
        }
    ],
    "totalMemory": 1.4658129805029452,
    "totalNumberOfCores": 0,
    "totalCpuCores": 6.027456183070403
}
integer
totalNumberOfCores
Optional

Total number of vCPU cores

number As double As double
totalCpuCores
Optional

Total amount of vCPU cores. Fractional amounts are supported.

number As double As double
totalMemory
Optional

totalMemory

integer As int64 As int64
totalStorage
Optional

totalStorage

array of object
components
Optional

components


400

Bad request.

Returns ErrorResponse of type(s) application/json 
{
    "code": "code",
    "detail": "detail",
    "message": {
        "args": {
            "cloudProxyFqdn": "cloudProxy1.vsphere.local"
        },
        "localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
        "defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
        "id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
    },
    "resolution": {
        "args": {
            "cloudProxyFqdn": "cloudProxy1.vsphere.local"
        },
        "localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
        "defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
        "id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
    },
    "referenceId": "referenceId",
    "timestamp": "2000-01-23T04:56:07.000Z"
}
string
code
Required  

Unique error code for programmatic identification.

object
message
Required  

message

object
resolution
Required  

resolution

string
referenceId
Required  

An identifier for tracing the error in the logs.

string As date-time As date-time
timestamp
Required  

The date and time when the error occurred.

string
detail
Optional

Freeform extra information, such as raw error payloads or additional context.


401

Unauthorized

Returns ErrorResponse of type(s) application/json 
{
    "code": "code",
    "detail": "detail",
    "message": {
        "args": {
            "cloudProxyFqdn": "cloudProxy1.vsphere.local"
        },
        "localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
        "defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
        "id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
    },
    "resolution": {
        "args": {
            "cloudProxyFqdn": "cloudProxy1.vsphere.local"
        },
        "localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
        "defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
        "id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
    },
    "referenceId": "referenceId",
    "timestamp": "2000-01-23T04:56:07.000Z"
}
string
code
Required  

Unique error code for programmatic identification.

object
message
Required  

message

object
resolution
Required  

resolution

string
referenceId
Required  

An identifier for tracing the error in the logs.

string As date-time As date-time
timestamp
Required  

The date and time when the error occurred.

string
detail
Optional

Freeform extra information, such as raw error payloads or additional context.


500

Internal server error

Returns ErrorResponse of type(s) application/json 
"ErrorResponse Object"
string
code
Required  

Unique error code for programmatic identification.

object
message
Required  

message

object
resolution
Required  

resolution

string
referenceId
Required  

An identifier for tracing the error in the logs.

string As date-time As date-time
timestamp
Required  

The date and time when the error occurred.

string
detail
Optional

Freeform extra information, such as raw error payloads or additional context.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/fleet-lcm/v1/components/resource-requirements
On This Page
Resources Operations
POST
Get Resource Requirements
GET
Get Resource Sizes