云办公服务-华为云

云桌面 WORKSPACE-开通云办公服务:请求示例

请求示例 POST /v2/fb2e5ec048384c8f9469d22db0037908/workspaces { "ad_domains" : { "domain_type" : "LITE_AS" }, "vpc_id" : "e8f985fa-5161-4cb8-bf5a-155058ea58c9", "subnet_ids" : [ { "subnet_id" : "067b30a9-1b73-4804-a808-699c5f6c4e09" } ], "access_mode" : "INTERNET", "is_send_email" : true } { "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" : "xxxx.xxxx.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" }, "vpc_id" : "27823fc4-5808-4f3b-a5bc-24c7a80742b8", "subnet_ids" : [ { "subnet_id" : "598d4599-059f-40ca-9cce-841b784d13e6" } ], "access_mode" : "INTERNET", "is_send_email" : true } { "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" : "xxxx.xxxx.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" }, "vpc_id" : "27823fc4-5808-4f3b-a5bc-24c7a80742b8", "subnet_ids" : [ { "subnet_id" : "598d4599-059f-40ca-9cce-841b784d13e6" } ], "access_mode" : "DEDICATED", "is_send_email" : true, "dedicated_subnets" : "192.168.0.0/24;10.0.0.0/16" }

云桌面 WORKSPACE 云办公服务

云桌面 WORKSPACE-开通云办公服务:响应参数

响应参数状态码： 200 表8 响应Body参数参数参数类型描述 job_id String 开通云办公服务的任务ID。状态码： 400 表9 响应Body参数参数参数类型描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。状态码： 401 表10 响应Body参数参数参数类型描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。状态码： 403 表11 响应Body参数参数参数类型描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。状态码： 404 表12 响应Body参数参数参数类型描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。状态码： 500 表13 响应Body参数参数参数类型描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

云桌面 WORKSPACE 云办公服务

云桌面 WORKSPACE-开通云办公服务:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 X-Auth-Token 否 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 发送的实体的MIME类型。表3 请求Body参数参数是否必选参数类型描述 ad_domains 是 AdDomain object 域信息。 enterprise_id 否 String 企业ID。企业ID是您在云桌面服务的唯一标识，终端用户登录时需要填写企业ID，若不自定义设置企业ID，系统将自动生成您的企业ID。格式为由半角数字、字母、_-组成，长度范围小于等于32个字符。 vpc_id 否 String VPC ID。 subnet_ids 否 Array of Subnet objects 指定业务子网的网络ID，子网不能与172.16.0.0/12冲突。 manage_subnet_cidr 否 String 管理子网网段。注：不能与172.16.0.0/12以及subnet_ids参数下子网的网段冲突。 access_mode 否 String 接入方式。 INTERNET：表示Internet接入。 DEDICATED：表示专线接入。 BOTH：表示两种接入方式都支持。 apply_shared_vpc_dedicated_param 否 ApplySharedVpcDedicatedParam object 共享Vpc专线入参。 dedicated_subnets 否 String 专线接入网段列表，多个网段信息用分号隔开，列表长度不超过5。 is_send_email 否 Boolean 桌面退订是否发送邮件通知。表4 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信息。表5 TlsConfig 参数是否必选参数类型描述 cert_pem 否 String pem内容, 有则更新，无则上传。查询不返回。 cert_start_time 否 String 证书生效开始时间，时间参考样例 2022-01-25T09:24:27。 cert_end_time 否 String 证书生效截止时间，时间参考样例 2022-01-25T09:24:27。表6 Subnet 参数是否必选参数类型描述 subnet_id 是 String 子网的网络ID。表7 ApplySharedVpcDedicatedParam 参数是否必选参数类型描述 address 否 String 租户指定的共享Vpc专线地址。 port 否 Integer 租户指定共享Vpc专线地址端口。 availability_zone 否 Array of strings 开通服务资源使用的可用分区，默认随机使用2个可用区。

云桌面 WORKSPACE 云办公服务

云桌面 WORKSPACE-查询边缘小站列表:响应示例

响应示例状态码： 200 查询边缘小站列表的接口响应。 { "wks_edge_sites" : [ { "id" : "string", "name" : "string", "description" : "string。", "availability_zone_id" : "string", "address" : "string", "status" : "string", "created_at" : "string", "updated_at" : "string", "cpu_usage_rate" : 0, "memory_usage_rate" : 0, "capacity_usage_rate" : 0, "site_info" : { "id" : "string", "status" : "string" } } ], "total_count" : 0 }

云桌面 WORKSPACE 云办公服务

云桌面 WORKSPACE-查询边缘小站列表:URI

URI GET /v2/{project_id}/wks-edge-sites 表1 路径参数参数是否必选参数类型描述 project_id 是 String 项目ID。表2 Query参数参数是否必选参数类型描述 name 否 String 根据边缘小站名称查询。 availability_zone_id 否 String 根据边缘可用区ID查询。 status 否 String 根据边缘小站部署状态查询。

云桌面 WORKSPACE 云办公服务

云桌面 WORKSPACE-查询边缘小站列表:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 wks_edge_sites Array of WksEdgeSiteDetail objects 边缘小站列表。 total_count Integer 站点总数。表5 WksEdgeSiteDetail 参数参数类型描述 id String 边缘小站id。 name String 边缘小站名称。 description String 边缘小站描述。 availability_zone_id String 边缘小站的可用区ID。 address String 部署位置。 status String 边缘小站的部署状态。 initial：待部署。 deploying：部署中。 available：可用。 unavailable：不可用。 created_at String 边缘小站创建时间。 updated_at String 边缘小站更新时间。 cpu_usage_rate Double cpu使用率。 memory_usage_rate Double 内存使用率。 capacity_usage_rate Double 存储使用率。 site_info SimpleSiteInfo object 站点信息。表6 SimpleSiteInfo 参数参数类型描述 id String 云桌面边缘小站id。 status String 云办公服务的状态。 PREPARING：准备开通。 SUBSCRIBING：开通中。 SUBSCRIBED：已开通。 SUBSCRIPTION_FAILED：开通失败。 DEREGISTERING：销户中。 DEREGISTRATION_FAILED：销户失败。 CLOSED：已销户未开通。状态码： 400 表7 响应Body参数参数参数类型描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。状态码： 401 表8 响应Body参数参数参数类型描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。状态码： 403 表9 响应Body参数参数参数类型描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。状态码： 404 表10 响应Body参数参数参数类型描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。状态码： 500 表11 响应Body参数参数参数类型描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。状态码： 503 表12 响应Body参数参数参数类型描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

云桌面 WORKSPACE 云办公服务

云桌面 WORKSPACE-删除站点:响应参数

响应参数状态码： 200 表3 响应Body参数参数参数类型描述 job_id String 任务ID。状态码： 400 表4 响应Body参数参数参数类型描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。状态码： 401 表5 响应Body参数参数参数类型描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。状态码： 403 表6 响应Body参数参数参数类型描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。状态码： 404 表7 响应Body参数参数参数类型描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。状态码： 500 表8 响应Body参数参数参数类型描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。状态码： 503 表9 响应Body参数参数参数类型描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

云桌面 WORKSPACE 云办公服务

云服务器内容精选

云办公服务

7*24

备案

专业服务

退订

建议反馈

售前咨询热线