Modifies attributes of Huawei Cloud Workspace

Updated on 2025-07-14 GMT+08:00

View PDF

Function

Modifies attributes of Huawei Cloud Workspace. Only one attribute type can be modified in a single request.

Debugging

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

URI

PUT /v2/{project_id}/workspaces

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

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	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	Yes	String	MIME type of the request body.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
ad_info	No	AdDomainInfo object	Domain information.
ad_domains	No	AdDomain object	Domain information.
access_mode	No	String	Access mode. INTERNET: access through Internet DEDICATED: access through Direct Connect BOTH: access through Internet or Direct Connect
dedicated_subnets	No	String	List of Direct Connect access network segments. Multiple network segments are separated by semicolons (;). The list contains a maximum of five network segments.
adn_conflict_network	No	String	Conflicted CIDR blocks in ADN network access. Multiple CIDR blocks are separated by semicolons (;). A maximum of 50 CIDR blocks are allowed.
subnet_ids	No	Array of strings	Subnet network IDs.
internet_access_port	No	String	Internet access port.
enterprise_id	No	String	Enterprise ID.
is_send_email	No	Boolean	Whether to send a notification email upon desktop unsubscription.
dc_vnc_ip	No	String	Whether to enable the function of accessing VNC through Direct Connect. If the value is default, the function is automatically enabled. If the value is a user-defined dc_vnc_ip, the function is directly used. If the value is close, the function is disabled.
authorized_collect_log	No	Boolean	Indicates whether to authorize log collection.
authorized_hda_upgrade	No	Boolean	Indicates whether to authorize the hda upgrade.
apply_shared_vpc_dedicated_param	No	ApplySharedVpcDedicatedParam object	Input parameter of the shared VPC Direct Connect.
apply_dedicated_standby_network_param	No	ApplyDedicatedStandbyNetworkParam object	Parameter specified for enabling the standby Direct Connect.
is_authorized_install_agent	No	Boolean	Whether to grant the permission for automatic agent plug-in installation on desktops.
enable_user_create_snapshot	No	Boolean	Whether to authorize end tenants to create snapshots.

**Table 4** AdDomainInfo
Parameter	Mandatory	Type	Description
domain_type	Yes	String	Domain type. LITE_AS: LiteAS LOCAL_AD: local AD When domain_type is set to LOCAL_AD, ensure that the selected VPC can be connected to the network to which the LOCAL_AD belongs.
domain_admin_account	Yes	String	Domain administrator account.
domain_password	Yes	String	Domain administrator account and password.

**Table 5** AdDomain
Parameter	Mandatory	Type	Description
domain_type	Yes	String	Domain type. LITE_AS: local authentication LOCAL_AD: local AD When domain_type is set to LOCAL_AD, ensure that the selected VPC can be connected to the network to which the AD belongs.
domain_name	No	String	Domain name. This parameter is mandatory when domain type is set to LOCAL_AD. The domain name must be an existing domain name on the Windows AD server and can contain a maximum of 55 characters.
domain_admin_account	No	String	Domain administrator account. This parameter is mandatory when domain type is set to LOCAL_AD. The account must be an existing domain administrator account on the Windows AD server.
domain_password	No	String	Domain administrator account and password. This parameter is mandatory when domain type is set to LOCAL_AD.
active_domain_ip	No	String	Primary domain controller IP address. This parameter is mandatory when domain type is set to LOCAL_AD.
active_domain_name	No	String	Primary domain controller name. This parameter is mandatory when domain type is set to LOCAL_AD.
standby_domain_ip	No	String	Backup domain controller IP address. This parameter is mandatory when domain type is set to LOCAL_AD and the standby node is configured.
standby_domain_name	No	String	Backup domain controller name. This parameter is mandatory when domain type is set to LOCAL_AD and the standby node is configured.
active_dns_ip	No	String	Primary DNS IP address. This parameter is mandatory when domain type is set to LOCAL_AD.
standby_dns_ip	No	String	Standby DNS IP address. This parameter is mandatory when domain type is set to LOCAL_AD and the standby node is configured.
delete_computer_object	No	Integer	Whether to delete the corresponding computer object from the AD when deleting the desktop. The value 0 indicates that the computer object is not deleted, and the value 1 indicates that the computer object is deleted.
use_ldaps	No	Boolean	Whether to enable LDAPS.
tls_config	No	TlsConfig object	TLS information.

**Table 6** TlsConfig
Parameter	Mandatory	Type	Description
cert_pem	No	String	PEM content. If the content exists, update it. Otherwise, upload it. The query result is not returned.
cert_start_time	No	String	Time when the certificate starts to take effect, for example, 2022-01-25T09:24:27.
cert_end_time	No	String	Time when the certificate expires, for example, 2022-01-25T09:24:27.

**Table 7** ApplySharedVpcDedicatedParam
Parameter	Mandatory	Type	Description
address	No	String	Shared VPC Direct Connect address specified by the tenant.
port	No	Integer	Shared VPC Direct Connect address port specified by the tenant.
availability_zone	No	Array of strings	AZ used for subscribing to service resources. By default, two AZs are randomly used.

**Table 8** ApplyDedicatedStandbyNetworkParam
Parameter	Mandatory	Type	Description
address	No	String	Standby address specified by the tenant for Direct Connect.
port	No	Integer	Standby address port specified by the tenant for Direct Connect.
availability_zone	No	Array of strings	AZ used for subscribing to service resources. By default, two AZs are randomly used.

Response Parameters

Status code: 200

**Table 9** Response body parameters
Parameter	Type	Description
job_id	String	ID of the task for modifying the service attributes of Huawei Cloud Workspace.
enterprise_id	String	Enterprise ID.
dc_vnc_ip	String	IP address for accessing VNC through Direct Connect.

Status code: 400

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

**Table 13** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 14** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

PUT /v2/fb2e5ec048384c8f9469d22db0037908/workspaces

{
  "access_mode" : "BOTH"
}

{
  "ad_domains" : {
    "domain_type" : "LOCAL_AD",
    "domain_admin_account" : "vdsadmin",
    "active_domain_ip" : "192.161.43.66",
    "standby_domain_ip" : "192.161.43.67",
    "domain_name" : "vdesktop.huawei.com",
    "domain_password" : "xxxxxxxxxx@",
    "active_domain_name" : "AD-xxx-0001.vdesktop.huawei.com",
    "active_dns_ip" : "192.161.43.66",
    "standby_domain_name" : "AD-xxx-0002.vdesktop.huawei.com",
    "standby_dns_ip" : "192.161.43.67",
    "use_ldaps" : true,
    "tls_config" : {
      "cert_pem" : "-----BEGIN CERTIFICATE-----\\nMIIDiTCCAnGgAwIBAgIQQdj2u+x1LJ9Dc34un\\n-----END CERTIFICATE"
    }
  }
}

{
  "access_mode" : "DEDICATED",
  "dedicated_subnets" : "192.168.0.0/24;10.0.0.0/16"
}

```
{
  "is_send_email" : false
}
```

Example Responses

Status code: 200

Response to the request for modifying attributes of Huawei Cloud Workspace.

{
  "job_id" : "0000000059071dbc01591661d3990019"
}

Status Codes


Status Code	Description
200	Response to the request for modifying attributes of Huawei Cloud Workspace.
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.
500	An internal service error occurred. For details about the error code, see the error code description.