文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 云办公服务/ 修改云办公服务属性
更新时间：2024-01-11 GMT+08:00
查看PDF
分享

修改云办公服务属性

功能介绍

该接口目前支持修改云办公服务属性。单次请求仅支持修改一种属性类型。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

PUT /v2/{project_id}/workspaces

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

Content-Type

是

String

发送的实体的MIME类型。
表3 请求Body参数

参数

是否必选

参数类型

描述

ad_info

否

AdDomainInfo object

域信息。

ad_domains

否

AdDomain object

域信息。

access_mode

否

String

接入模式。

  • INTERNET：互联网接入。

  • DEDICATED：专线接入。

  • BOTH：代表两种接入方式都支持。

dedicated_subnets

否

String

专线接入网段列表，多个网段信息用分号隔开，列表长度不超过5。

subnet_ids

否

Array of strings

子网的网络ID列表。

internet_access_port

否

String

互联网接入端口。

enterprise_id

否

String

企业ID。

is_send_email

否

Boolean

桌面退订是否发送邮件通知。

dc_vnc_ip

否

String

开通专线访问VNC功能，如果传入的是default则自动创建，如果传入的自定义的dc_vnc_ip则直接使用，如果传入的是close表示关闭自定义VNC

authorized_collect_log

否

Boolean

是否授权收集日志。

authorized_hda_upgrade

否

Boolean

是否授权hda升级。

apply_dedicated_standby_network_param

否

ApplyDedicatedStandbyNetworkParam object

开通专线备用线路入参
表4 AdDomainInfo

参数

是否必选

参数类型

描述

domain_type

是

String

域类型。

  • LITE_AS：LiteAS。

  • LOCAL_AD：本地AD。 说明：域类型为“LOCAL_AD”时，请确保所选VPC网络与“LOCAL_AD”所属网络可连通。

domain_admin_account

是

String

域管理员帐号。

domain_password

是

String

域管理员账号密码。
表5 AdDomain

参数

是否必选

参数类型

描述

domain_type

是

String

域类型。

  • LITE_AS：本地认证。

  • LOCAL_AD：本地AD。 说明：域类型为“LOCAL_AD”时，请确保所选VPC网络与AD所属网络可连通。

domain_name

否

String

域名称。域类型为LOCAL_AD时需要配置。 域名必须为AD服务器上已经存在的域名，且长度不超过55。

domain_admin_account

否

String

域管理员帐号。域类型为LOCAL_AD时需要配置。 必须为AD服务器上已经存在的域管理员帐号。

domain_password

否

String

域管理员账号密码。域类型为LOCAL_AD时需要配置。

active_domain_ip

否

String

主域控制器IP地址。域类型为LOCAL_AD时需要配置。

active_domain_name

否

String

主域控制器名称。域类型为LOCAL_AD时需要配置。

standby_domain_ip

否

String

备域控制器IP地址。域类型为LOCAL_AD时且配置备节点时需要配置。

standby_domain_name

否

String

备域控制器名称。域类型为LOCAL_AD时且配置备节点时需要配置。

active_dns_ip

否

String

主DNS IP地址。域类型为LOCAL_AD时需要配置。

standby_dns_ip

否

String

备DNS IP地址。域类型为LOCAL_AD时且配置备节点时需要配置。

delete_computer_object

否

Integer

是否在删除桌面的同时删除AD上对应的计算机对象，0代表不删除，1代表删除。

use_ldaps

否

Boolean

是否开启LDAPS。

tls_config

否

TlsConfig object

TLS信息。
表6 TlsConfig

参数

是否必选

参数类型

描述

cert_pem

否

String

pem内容, 有则更新，无则上传。查询不返回。

cert_start_time

否

String

证书生效开始时间，时间参考样例 2022-01-25T09:24:27。

cert_end_time

否

String

证书生效截止时间，时间参考样例 2022-01-25T09:24:27。
表7 ApplyDedicatedStandbyNetworkParam

参数

是否必选

参数类型

描述

address

否

String

租户指定的专线备用地址

port

否

Integer

租户指定的专线备用地址端口

availability_zone

否

Array of strings

开通服务资源使用的可用分区，默认随机使用2个可用区

响应参数

状态码： 200

表8 响应Body参数

参数

参数类型

描述

job_id

String

修改云办公服务属性的任务ID

enterprise_id

String

企业ID

dc_vnc_ip

String

专线vnc访问的ip

状态码： 400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码： 401

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码： 403

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码： 404

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码： 500

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

  • 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
}

响应示例

状态码： 200

修改云办公服务属性响应。

{
  "job_id" : "0000000059071dbc01591661d3990019"
}

状态码

状态码

描述

200

修改云办公服务属性响应。

400

由于包含语法错误，当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误，具体返回错误码请参见错误码说明。

错误码

请参见错误码。

父主题： 云办公服务

相关文档