Get Fabric Compute

Get Fabric Compute

Get fabric compute with a given id

Request
URI
GET
https://vra-interop-222-139.lvn.broadcom.net/iaas/api/fabric-computes/{id}
COPY
Path Parameters
string
id
Required

The ID of the fabric compute.

Query Parameters
string
apiVersion
Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about


Authentication
This operation uses the following authentication methods.
Responses
200

Successful operation

Returns FabricCompute of type(s) application/json
{
    "id": "9.0E49",
    "createdAt": "2012-09-27",
    "updatedAt": "2012-09-27",
    "owner": "[email protected]",
    "ownerType": "ad_group",
    "orgId": "42413b31-1716-477e-9a88-9dc1c3cb1cdf",
    "_links": {
        "empty": false
    },
    "name": "my-name",
    "description": "my-description",
    "externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
    "externalZoneId": "us-east-1a",
    "externalRegionId": "us-east-1",
    "tags": [
        [
            {
                "key": "ownedBy",
                "value": "Rainpole"
            }
        ]
    ],
    "type": "Availability Zone",
    "lifecycleState": "PROVISIONING, READY, SUSPEND, STOPPED, RETIRED",
    "powerState": "ON, OFF, GUEST_OFF, UNKNOWN, SUSPEND",
    "customProperties": {
        "customProperties": "string"
    },
    "maximumAllowedMemoryAllocationPercent": 120,
    "maximumAllowedCpuAllocationPercent": 120
}
string
id
Required

The id of this resource instance

string
createdAt
Optional

Date when the entity was created. The date is in ISO 8601 and UTC.

string
updatedAt
Optional

Date when the entity was last updated. The date is ISO 8601 and UTC.

string
owner
Optional

Email of the user or display name of the group that owns the entity.

string
ownerType
Optional

Type of a owner(user/ad_group) that owns the entity.

string
orgId
Optional

The id of the organization this entity belongs to.

object
_links
Optional

HATEOAS of the entity

string
name
Optional

A human-friendly name used as an identifier in APIs that support this option.

string
description
Optional

A human-friendly description.

string
externalId
Optional

External entity Id on the provider side.

string
externalZoneId
Optional

The external zoneId of the compute.

string
externalRegionId
Required

The external regionId of the compute

array of object
tags
Optional

A set of tag keys and optional values that were set on this resource instance.

string
type
Optional

Type of the compute instance

string
lifecycleState
Optional

Lifecycle status of the compute instance

string
powerState
Optional

Power state of compute instance

object
customProperties
Optional

Custom properties of the compute instance

integer As int32 As int32
maximumAllowedMemoryAllocationPercent
Optional

What percent of the total available memory on the compute will be used for VM provisioning. This value can be more than 100. e.g. If the compute has 100gb of memory and this value is set to 80, then VMware Aria Automation will act as if this compute has only 80gb. If it is 120, then VMware Aria Automation will act as if this compute has 120gb thus allowing 20gb overallocation. Applies only for private cloud computes.

integer As int32 As int32
maximumAllowedCpuAllocationPercent
Optional

What percent of the total available vCPU on the compute will be used for VM provisioning. This value can be more than 100. e.g. If the compute has 100 vCPUs and this value is set to 80, then VMware Aria Automation will act as if this compute has only 80 vCPUs. If it is 120, then VMware Aria Automation will act as if this compute has 120 vCPUs thus allowing 20 vCPU overallocation. Applies only for private cloud computes.


403

Forbidden

Returns ServiceErrorResponse of type(s) application/json
"ServiceErrorResponse Object"
string
message
Optional

message

string
messageId
Optional

messageId

array of string
stackTrace
Optional

stackTrace

integer As int32 As int32
statusCode
Optional

statusCode

integer As int32 As int32
errorCode
Optional

errorCode

array of string
details
Optional

details

string
serverErrorId
Optional

serverErrorId

string
documentKind
Optional

documentKind

integer As int32 As int32
internalErrorCode
Optional

internalErrorCode


404

Not found

Returns ServiceErrorResponse of type(s) application/json
"ServiceErrorResponse Object"
string
message
Optional

message

string
messageId
Optional

messageId

array of string
stackTrace
Optional

stackTrace

integer As int32 As int32
statusCode
Optional

statusCode

integer As int32 As int32
errorCode
Optional

errorCode

array of string
details
Optional

details

string
serverErrorId
Optional

serverErrorId

string
documentKind
Optional

documentKind

integer As int32 As int32
internalErrorCode
Optional

internalErrorCode


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/iaas/api/fabric-computes/{id}