Get Fabric Image

Get Fabric Image

Get enumerated fabric image with a given id. Fabric images are enumerated images from a specific region, which could be used in image mappings.

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

The ID of the image.

Query Parameters
string
apiVersion
Optional

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

string
$select
Optional

Select a subset of properties to include in the response.


Authentication
This operation uses the following authentication methods.
Responses
200

Successful operation

Returns FabricImage 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",
    "osFamily": "linux, win",
    "externalRegionId": "us-east-1",
    "externalRegionName": "us-east-1",
    "customProperties": {
        "prop1": "value1"
    },
    "isPrivate": true,
    "cloudAccountIds": [
        9e+49
    ],
    "cloudAccountId": "/resources/endpoints/{UUID}}",
    "cloudAccountName": "my-cloud-account",
    "diskConfigs": [
        {
            "id": "6496-2000",
            "capacityMBytes": 16384,
            "persistent": false,
            "encrypted": false
        }
    ],
    "networkConfigs": [
        {
            "id": "VirtualPortgroup:dvportgroup-368888",
            "name": "Network adapter 1",
            "resourceSubType": "VmxNet3"
        }
    ]
}
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
Required

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
osFamily
Optional

Operating System family of the image.

string
externalRegionId
Optional

The regionId of the image

string
externalRegionName
Optional

The region name of the image

object
customProperties
Optional

Additional properties that may be used to extend the base type.

boolean
isPrivate
Optional

Indicates whether this fabric image is private. For vSphere, private images are considered to be templates and snapshots and public are Content Library Items

array of string
cloudAccountIds
Optional

Set of ids of the cloud accounts this entity belongs to.

string
cloudAccountId
Optional

Optional link to the endpoint the image belongs to. This will be blanc if the image is public/global Either this property or externalRegionId property will be present

string
cloudAccountName
Optional

Name of the cloud account this entity belongs to.

array of object
diskConfigs
Optional

List of disk config for the image

array of object
networkConfigs
Optional

List of network config for the image


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-images/{id}