[{"label":"Latest (V1)","version":"latest"}]

horizon-cloud-nextgen

Get Image Copies

Description

Get all image copies.

Request

URL

get

https://cloud.vmwarehorizon.com/imagemgmt/v1/image-copies

Copy

Query Parameters

string

org_id Optional

org_id

string

page Optional

Page number to retrieve.

string

search Optional

Search Criteria. Please see model definition for list of searchable fields.

search example

"providerInstanceId $eq provider-instance-id-1"

string

size Optional

Size of each page.

array of string

sort Optional

Ascending/Descending. Format is property,{asc|desc} and default is ascending.

Parameter Serialization Style: form Explode:true

Authentication

This operation uses the following authentication methods.

Bearer

Response

200 OK Response Body>

Response Body

200 OK

Returns PageAssetTO of type application/json

Successfully retrieved image copies

{
	"content": [
		{
			"assetDetails": {
				"assetType": "AKKA_IMAGE_IN_RG",
				"data": {}
			},
			"createdAt": "string",
			"credentialId": "0123456789",
			"errorCode": "AZURE_FAILED_TO_ENABLE_RDS",
			"errorDetails": "string",
			"errorDetailsParameters": {
				"key": "string"
			},
			"errorsHistory": [
				{
					"cause": "ErrorDetail Object",
					"code": "string",
					"detail": "string",
					"domain": "string",
					"message": "string",
					"parameters": {
						"key": "string"
					},
					"severity": "string",
					"timestampInUtc": "string"
				}
			],
			"gpuType": "AMD, NVIDIA",
			"id": "0123456789",
			"imageId": "0123456789",
			"multiSession": false,
			"orgId": "0123456789",
			"osType": "WINDOWS, LINUX",
			"providerInstanceId": "0123456789",
			"providerLabel": "0123456789",
			"state": "PUBLISHED",
			"status": "GENERALIZING",
			"updatedAt": "string",
			"version": 0,
			"versionId": "0123456789",
			"warningDetails": "string",
			"warningDetailsParameters": {
				"key": "string"
			}
		}
	],
	"empty": false,
	"first": false,
	"last": false,
	"number": 0,
	"numberOfElements": 0,
	"pageable": {
		"offset": 0,
		"pageNumber": 0,
		"pageSize": 0,
		"paged": false,
		"sort": {
			"empty": false,
			"sorted": false,
			"unsorted": false
		},
		"unpaged": false
	},
	"size": 0,
	"sort": {
		"empty": false,
		"sorted": false,
		"unsorted": false
	},
	"totalElements": 0,
	"totalPages": 0
}

array of AssetTO

content Optional

Searchable fields are “providerInstanceId”, “orgId”

boolean

empty Optional

boolean

first Optional

boolean

last Optional

integer as int32

number Optional

integer as int32

numberOfElements Optional

Pageable

pageable Optional

integer as int32

size Optional

Sort

sort Optional

integer as int64

totalElements Optional

integer as int32

totalPages Optional

204 No Content Response Body>

Response Body

204 No Content

Returns PageAssetTO of type application/json

No markers exists for the criteria

{
	"content": [
		{
			"assetDetails": {
				"assetType": "AKKA_IMAGE_IN_RG",
				"data": {}
			},
			"createdAt": "string",
			"credentialId": "0123456789",
			"errorCode": "AZURE_FAILED_TO_ENABLE_RDS",
			"errorDetails": "string",
			"errorDetailsParameters": {
				"key": "string"
			},
			"errorsHistory": [
				{
					"cause": "ErrorDetail Object",
					"code": "string",
					"detail": "string",
					"domain": "string",
					"message": "string",
					"parameters": {
						"key": "string"
					},
					"severity": "string",
					"timestampInUtc": "string"
				}
			],
			"gpuType": "AMD, NVIDIA",
			"id": "0123456789",
			"imageId": "0123456789",
			"multiSession": false,
			"orgId": "0123456789",
			"osType": "WINDOWS, LINUX",
			"providerInstanceId": "0123456789",
			"providerLabel": "0123456789",
			"state": "PUBLISHED",
			"status": "GENERALIZING",
			"updatedAt": "string",
			"version": 0,
			"versionId": "0123456789",
			"warningDetails": "string",
			"warningDetailsParameters": {
				"key": "string"
			}
		}
	],
	"empty": false,
	"first": false,
	"last": false,
	"number": 0,
	"numberOfElements": 0,
	"pageable": {
		"offset": 0,
		"pageNumber": 0,
		"pageSize": 0,
		"paged": false,
		"sort": {
			"empty": false,
			"sorted": false,
			"unsorted": false
		},
		"unpaged": false
	},
	"size": 0,
	"sort": {
		"empty": false,
		"sorted": false,
		"unsorted": false
	},
	"totalElements": 0,
	"totalPages": 0
}

array of AssetTO

content Optional

Searchable fields are “providerInstanceId”, “orgId”

boolean

empty Optional

boolean

first Optional

boolean

last Optional

integer as int32

number Optional

integer as int32

numberOfElements Optional

Pageable

pageable Optional

integer as int32

size Optional

Sort

sort Optional

integer as int64

totalElements Optional

integer as int32

totalPages Optional

Errors

ErrorResponse

401

Unauthorized

ErrorResponse

403

Forbidden

ErrorResponse

500

Failed to retrieve image copies

Code Samples

cURL Command

curl https://cloud.vmwarehorizon.com/imagemgmt/v1/image-copies

[{"label":"Latest (V1)","version":"latest"}]

horizon-cloud-nextgen

Images Operations

get

Get Copies

get

Get Copy

get

Get Image Copies

Get Image Copies

Request

URL

Query Parameters

search example

Authentication

Bearer

Response

Response Body

200 OK

Response Body

204 No Content

Errors

Code Samples

cURL Command

On This Page

Images Operations

Was this page helpful?