[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen

Get Copy

Description

Get image copy by image id, version id and copy id.

Request

Request

URL

URL


get
https://cloud.vmwarehorizon.com/imagemgmt/v1/images/{imageId}/versions/{versionId}/copies/{copyId}
Copy

Path Parameters

Path Parameters

string
copyId Required

copyId


string
imageId Required

imageId


string
versionId Required

versionId


Query Parameters

Query Parameters

string
org_id Optional

org_id


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns AssetTO of type application/json

Successfully retrieved Image copy

{
    "credentialId": "0123456789",
    "errorCode": "AZURE_FAILED_TO_ENABLE_RDS",
    "gpuType": "AMD, NVIDIA",
    "id": "0123456789",
    "orgId": "0123456789",
    "osType": "WINDOWS, LINUX",
    "providerInstanceId": "0123456789",
    "providerLabel": "0123456789",
    "state": "PUBLISHED",
    "status": "GENERALIZING",
    "versionId": "0123456789"
}
assetDetails Optional

string as date-time
createdAt Optional

Timestamp of record creation


string
credentialId Optional

ID of the credential storing the sensitive data of provider instance


string
errorCode Optional

Error code for failed Asset

Possible values are: AGENT_DETAILS_FETCH_FAILEDAGENT_FEATURES_VERIFICATION_FAILEDAGENT_INSTALL_TYPE_NOT_FOUNDAIMS_CLONE_CALL_FAILEDAIMS_COPY_CALL_FAILEDAIMS_DELETE_ASSET_CALL_FAILEDAIMS_DELETE_ASSET_FAILEDAIMS_IMPORT_CALL_FAILEDAIMS_PUBLISH_CALL_FAILEDAIMS_REPUBLISH_CALL_FAILEDAPPLICATION_SCAN_DETAILS_MISSINGAPPLICATION_SCAN_IS_NOT_APPLICABLEAZURE_CONNECTION_FAILEDAZURE_FAILED_TO_ALLOW_RDP_AND_ENABLE_RDSAZURE_FAILED_TO_AllOW_RDPAZURE_FAILED_TO_COPY_SIG_IMAGE_VERSIONAZURE_FAILED_TO_CREATE_IMAGE_IN_SIGAZURE_FAILED_TO_CREATE_NETWORK_SECURITY_GROUPAZURE_FAILED_TO_CREATE_PUBLIC_IPAZURE_FAILED_TO_CREATE_RESOURCE_GROUPAZURE_FAILED_TO_CREATE_SIGAZURE_FAILED_TO_DEALLOCATE_VMAZURE_FAILED_TO_DELETE_CUSTOM_SCRIPT_EXTENSIONAZURE_FAILED_TO_DELETE_VMAZURE_FAILED_TO_FETCH_SIG_IMAGE_DETAILSAZURE_FAILED_TO_FETCH_SIG_IMAGE_VERSIONAZURE_FAILED_TO_GENERALIZE_VMAZURE_FAILED_TO_GET_NSGAZURE_FAILED_TO_INITIATE_SIG_REPLICATIONAZURE_FAILED_TO_PROVISION_VMAZURE_FAILED_TO_REPLICATION_IMAGEAZURE_FAILED_TO_RESTART_VMAZURE_FAILED_TO_RUN_SYSPREP_ON_VMAZURE_INVALID_SIG_ID_FORMATAZURE_NETWORK_NOT_FOUNDAZURE_RESOURCE_NOT_FOUNDAZURE_SUBNET_NOT_FOUNDAZURE_VM_NOT_FOUNDBAD_REQUESTCREDENTIALS_DELETE_FAILEDCREDENTIALS_FETCH_FAILEDCREDENTIALS_NOT_FOUNDCREDENTIAL_CREATION_FAILEDCREDENTIAL_ID_MISSINGDELETE_STREAM_NOT_SUPPORTEDFAILED_TO_INSTALL_AGENTFORBIDDENGOLDPATTERN_INVALID_DATAGOLDPATTERN_MISSING_FIELDSHORIZON_AGENT_FEATURES_MISSINGILLEGAL_SOURCE_TYPE_FOR_GIVEN_PROVIDERIMAGE_ALREADY_EXISTSIMAGE_DISCOVERY_FAILEDIMAGE_EVENT_VALIDATION_FAILEDINITATE_IMAGE_IMPORT_FAILEDINITIATE_VERSION_PUBLISH_FAILEDINITIATE_VERSION_REPUBLISH_FAILEDINVALID_GPU_TYPEINVALID_ORG_IDINVALID_OS_CUSTOMIZATION_OPTIONINVALID_OS_TYPEINVALID_RESOURCE_STATEINVALID_SEARCH_USAGEINVALID_VERSION_TYPEPROVIDER_INSTANCE_FETCH_FAILEDPROVIDER_INSTANCE_NOT_OF_SAME_ORGPROVIDER_LABEL_MISSINGRESOURCE_ALREADY_EXISTSRESOURCE_DELETE_FROM_DB_FAILEDRESOURCE_FETCH_FROM_DB_FAILEDRESOURCE_NOT_FOUNDRESOURCE_SAVE_TO_DB_FAILEDRETRY_AGENT_INSTALLSIMULATED_EXCEPTIONUNKNOWN_EXCEPTIONUNSUPPORTED_COLLECTION_FOR_LOCATIONUNSUPPORTED_EXCEPTIONUNSUPPORTED_METHODUNSUPPORTED_OPERATIONUNSUPPORTED_PROVIDERVALIDATION_FAILEDVERSION_IN_USEVERSION_IN_USE_AS_CLONE_SOURCE


string
errorDetails Optional

Specific error details based on the failure


map of string
errorDetailsParameters Optional

The parameters for the error detail.


string
gpuType Optional

Identifies the GPU type of the asset

Possible values are: AMDNONENVIDIA


string
id Optional

Unique record ID


boolean
multiSession Optional

Identifies if the asset is to be used for single-session or multi-session templates


string
orgId Optional

Org ID that owns this record


string
osType Optional

Identifies the osType of the asset

Possible values are: CLIENTLINUXSERVERWINDOWSWVD


string
providerInstanceId Optional

ProviderInstance ID that identifies the provider and related details


string
providerLabel Optional

ProviderLabel identifies the provider type - Azure, vSphere and so on


string
state Optional

Identifies state of the asset

Possible values are: NOT_READYPUBLISHEDUNPUBLISHED


string
status Optional

Indicates the status of the asset based on its stage in import or publish workflow

Possible values are: AVAILABLEDELETINGDELETION_FAILEDDELETION_RETRY_PENDINGDEPLOYING_VMDISABLEDENABLING_RDSGENERALIZINGIMPORT_COMPLETEIMPORT_FAILEDIMPORT_FAILED_TIMEOUTIMPORT_PENDINGIMPORT_RETRY_PENDINGINSTALLING_AGENTSPUBLISH_COMPLETEPUBLISH_FAILEDPUBLISH_RETRY_PENDINGREPLICATINGREPLICATION_COMPLETEREPLICATION_FAILEDREPLICATION_FAILED_TIMEOUTRESTARTING_VMSCANNING_APPSSHUTTING_DOWN_VMSYSPREPING


string as date-time
updatedAt Optional

Timestamp of last record modification


integer as int64
version Optional

Record version (internal)


string
versionId Optional

Version ID that this asset belongs to


string
warningDetails Optional

Warning details.


map of string
warningDetailsParameters Optional

The parameters for the warning detail.

Errors

Errors

400

Bad request - unsupported provider type


401

Unauthorized


403

Forbidden


404

Image copy is not found for given copyId, versionId and imageId

Code Samples

Code Samples

cURL Command

curl https://cloud.vmwarehorizon.com/imagemgmt/v1/images/{imageId}/versions/{versionId}/copies/{copyId}


[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen
Feedback

Was this page helpful?