Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop/ Query the Desktop Network

Updated on 2024-01-10 GMT+08:00

View PDF

Query the Desktop Network

Queries desktop VPCs, subnets, private IP addresses, EIPs, and security groups.

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

GET /v2/{project_id}/desktops/{desktop_id}/networks

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
desktop_id	Yes	String	Desktop ID.

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API that is used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Content-Type	No	String	MIME type of the request body.

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
computer_name	String	Desktop name.
computer_id	String	Desktop ID.
network_infos	Array of NetworkInfo objects	Desktop network information.

**Table 4** NetworkInfo
Parameter	Type	Description
vpc_info	Vpc object	VPC information.
subnet_info	Subnet object	Subnet information.
port_info	Port object	Private IP Information.
public_ip_info	PublicIp object	Unique EIP Information.
security_groups	Array of SecurityGroup objects	Specifies the list of security groups bound to the desktop.

**Table 5** Vpc
Parameter	Type	Description
id	String	Specifies the ID of the VPC to which the desktop belongs.
name	String	Specifies the name of the VPC to which the desktop belongs.
cidr	String	Specifies the VPC network segment where the desktop is located.

**Table 6** Subnet
Parameter	Type	Description
id	String	ID of the subnet where the desktop is located.
name	String	Specifies the name of the subnet where the desktop is located.
cidr	String	Subnet segment where the desktop is located.

**Table 7** Port
Parameter	Type	Description
id	String	Specifies the ID of the private IP address, which uniquely identifies the private IP address.
ip_address	String	Private IP address.

**Table 8** PublicIp
Parameter	Type	Description
id	String	Unique EIP ID.
public_ip_address	String	EIP.

**Table 9** SecurityGroup
Parameter	Type	Description
id	String	Security group ID.

Status code: 400

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Status code: 401

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Status code: 403

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Status code: 404

**Table 13** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Status code: 409

**Table 14** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Status code: 500

**Table 15** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

None

None

Status Code	Description
200	Normal.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	You do not have required permissions.
404	No resource found.
409	Operation conflict.
500	An internal service error occurred. For details, see the error code description.