• Workspace

workspace
  1. Help Center
  2. Workspace
  3. API Reference
  4. Desktop Dedicated Hosts
  5. Modifying Desktop Dedicated Host Attributes

Modifying Desktop Dedicated Host Attributes

Function

This interface is used to modify desktop dedicated host attributes.

URI

  • URI format

    PUT /v1.0/{project_id}/workspace-dedicated-hosts/{dedicated_host_id}

  • URI parameter description

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    string

    Specifies the user ID.

    dedicated_host_id

    Yes

    string

    Specifies the ID of a desktop dedicated host.

Request

  • Request body parameter description

    Name

    Mandatory

    Type

    Description

    dedicated_host

    Yes

    Dictionary data structure [1]

    Specifies the information about a desktop dedicated host.

[1] dedicated_host field data structure description

Name

Type

Description

auto_placement

string

If a desktop dedicated host is not specified during desktop creation, the desktop can be run on any dedicated host whose auto_placement is on.

Value range: on and off

name

string

Specifies the name of a desktop dedicated host.

  • Request example
    PUT /v1.0/29dfe82ada564ac2b927e1ff036d9a9b/workspace-dedicated-hosts/ ab910cf0daebca90c4001 
     Request Body:  
     { 
     "dedicated_host":  
          { 
                "auto_placement": "off", 
                "name": "wjvm3" 
         } 
     }

Response

No response body

Returned Values

  • Normal

    204

  • Abnormal

    Returned Value

    Description

    400 Bad Request

    The request syntax is incorrect and cannot be understood by the server.

    401 Unauthorized

    Authentication fails.

    403 Forbidden

    You are not authorized to perform the operation.

    404 Not Found

    The requested resource is not found.

    405 Method Not Allowed

    The method specified in the request is not allowed.

    500 Internal Server Error

    Internal service error. For details about error codes, see Error Code Description.

    503 Service Unavailable

    The service is unavailable.