POST /v2/resource/virtual_desk/get_remote_app

Brief Introduction

Obtain details of a virtual desktop resource in remote app work mode.

Request Parameter

Parameter	Location	Type	Required	Description
id	Body	Int	Y	Resource ID

Response Parameter

Parameter	Location	Type	Required	Description
error_code	Body	Int	Y	Request status
error_message	Body	String	Y	Request result information
data.id	Body	Int	Y	Resource ID
data.icon	Body	String	Y	Icon
data.name	Body	String	Y	Name
data.group_id	Body	Int	Y	Resource group ID
data.description	Body	String	Y	Description. Cannot exceed 48 characters (a Chinese character occupies the width of two half-width characters).
data.enable	Body	Int	Y	Status
data.tpl_id	Body	String	Y	VM template ID
data.tpl_name	Body	String	Y	VM template name
data.deploy_mode	Body	Int	Y	Desktop type. 1: Persistent, 2: Nonpersistent
data.derivative_mode	Body	Int	Y	VM type. 0: Linked Clone, 1: Full Clone
data.cpu_cores	Body	Int	Y	Number of CPU cores
data.memory_size	Body	Int	Y	Enable huge-page memory. 0: Disabled, 1: Enabled
data.enable_huge_page_memory	Body	Int	Y	Enable L3 cache. 0: Disabled, 1: Enabled
data.enable_l3_cache	Body	Int	Y	Enable L3 cache. 0: Disabled, 1: Enabled
data.enable_disk	Body	Int	Y	Private disk. 1: Enabled, 0: Disabled
data.disk_size	Body	Int	Y	Private disk size
data.server_name	Body	String	Y	VM name. Cannot exceed 11 characters (a Chinese character occupies the width of two half-width characters). Can contain letters, digits, and hyphens (-), but cannot contain digits only.
data.vtp_id	Body	Int	Y	HCI cluster ID
data.area_id	Body	Int	Y	Area ID
data.enable_vm_encryption	Body	Int	Y	Encryption settings. 0: Disabled, 1: Enabled (This is not supported when floating pool is enabled.)
data.vtp_name	Body	String	Y	HCI cluster name
data.data.area_name	Body	String	Y	Area name
data.work_mode	Body	String	Y	Work mode
data.vms_data	Body	Array	Y	List of VM locations
data.vms_data[].position_id	Body	String	Y	VM location ID
data.vms_data[].position_host_id	Body	String	Y	Cluster location
data.vms_data[].position_dir_id	Body	String	Y	Run location ID
data.vms_data[].position_dir_name	Body	String	Y	Run location name
data.vms_data[].position_storage_id	Body	String	Y	Datastore ID
data.vms_data[].position_storage_name	Body	String	Y	Datastore name
data.vms_data[].position_disk_id	Body	String	Y	Private disk location ID
data.vms_data[].position_disk_name	Body	String	Y	Private disk location
data.vms_data[].position_network_id	Body	String	Y	Switch ID
data.vms_data[].position_network_name	Body	String	Y	Switch name
data.vms_data[].position_server_count	Body	String	Y	Total number of VMs in the VM location
data.vms_data[].position_tpl_version	Body	String	Y	Template version
data.vms_data[].position_img_id	Body	String	Y	Image ID corresponding to the template version
data.vms_data[].position_tmp_vtp_id	Body	int	Y	HCI cluster ID
data.vms_data[].position_vtp_name	Body	String	Y	HCI platform name
data.vms_data[].position_is_import	Body	Int	Y	Whether to import VMs. 0: Deploy, 1: Import
data.vms_data[].position_storage_policy_id	Body	String	Y	Storage policy ID
data.vms_data[].position_vm_num	Body	Int	Y	Total number of VMs in the current location
data.vms_data[].position_vm_status	Body	Int	Y	Status of the operation for deploying or importing VMs to the current location
data.vms_data[].position_vm_success_num	Body	Int	Y	Number of VMs deployed or imported successfully to the current location
data.vms_data[].position_vm_failure_num	Body	Int	Y	Number of VMs failed to be deployed or imported to the current location
data.vms_data[].position_vm_err_message	Body	Array	Y	List of error details for failures to deploy or import VMs to the current location
data.vms_data[].position_vm_err_message[].name	Body	String	Y	VM name
data.vms_data[].position_vm_err_message[].err_msg	Body	String	Y	Error details

Request Example

{
"id": 102
}

Response Example

{
    "id": 102,
    "icon": "shareDesk.png",
    "name": "remote_app_1",
    "group_id": 0,
    "description": "555",
    "enable": 1,
    "tpl_id": "f2c57b79-0616-4cbd-a3b5-e4905620462a",
    "tpl_name": "2016_remote_app",
    "deploy_mode": 1,
    "derivative_mode": 0,
    "cpu_cores": 2,
    "memory_size": 2,
    "enable_huge_page_memory": 1,
    "enable_l3_cache": 1,
    "enable_disk": 1,
    "disk_size": 40,
    "server_name": "DXyccy01VM",
    "vtp_id": 42,
    "area_id": 0,
    "enable_vm_encryption": 0,
    "vtp_name": "10.70.3.38",
    "area_name": "All/Default area/",
    "work_mode": "3",
    "vms_data": [{
        "position_id": "150",
        "position_host_id": "cluster",
        "position_dir_id": "",
        "position_dir_name": "default",
        "position_storage_id": "42a15e6d_vs_vol_rep2",
        "position_storage_name": "vscolume1",
        "position_disk_id": "42a15e6d_vs_vol_rep2",
        "position_disk_name": "vscolume1",
        "position_network_id": "1400f448-4504-4f5c-8437-cc200b45d3fe:cd4e3220-02cc-4e9d-a755-46aa11686f44",
        "position_network_name": "evswitch1:br_eth4",
        "position_server_count": 0,
        "position_tpl_version": "0",
        "position_img_id": "c2d47b88-44e3-43bc-ba04-00d1596edcbc",
        "position_tmp_vtp_id": "42",
        "position_vtp_name": "10.70.3.38",
        "position_is_import": "1",
        "position_storage_policy_id": "",
        "position_vm_num": 0,
        "position_vm_status": 0,
        "position_vm_success_num": 0,
        "position_vm_failure_num": 0,
        "position_vm_err_message": null
    }]
}

{{ $t('index.defaultHeader.logo') }}

aDesk Virtual Desktop Infrastructure (VDI)

Obtain Details of a Virtual Desktop Resource in Remote App Work Mode