开通云办公服务 - ApplyWorkspace

功能介绍

该接口用于开通云办公服务。

作为异步接口，调用成功说明云办公服务后台收到了开通请求，但服务是否开通成功需要通过任务查询接口(GET /v2/{project_id}/workspace-sub-jobs)查询该任务的执行状态。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

POST /v2/{project_id}/workspaces

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
ad_domains	是	ApplyWorkspaceAdDomain 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	桌面退订是否发送邮件通知。

表3 ApplyWorkspaceAdDomain
参数	是否必选	参数类型	描述
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信息。

表4 TlsConfig
参数	是否必选	参数类型	描述
cert_pem	否	String	pem内容, 有则更新，无则上传。查询不返回。
cert_start_time	否	String	证书生效开始时间，时间参考样例 2022-01-25T09:24:27。
cert_end_time	否	String	证书生效截止时间，时间参考样例 2022-01-25T09:24:27。

表5 Subnet
参数	是否必选	参数类型	描述
subnet_id	是	String	子网的网络ID。

表6 ApplySharedVpcDedicatedParam
参数	是否必选	参数类型	描述
address	否	String	租户指定的共享Vpc专线地址。
port	否	Integer	租户指定共享Vpc专线地址端口。
availability_zone	否	Array of strings	开通服务资源使用的可用分区，默认随机使用2个可用区。

响应参数

状态码：200

表7 响应Body参数
参数	参数类型	描述
job_id	String	开通云办公服务的任务ID。

状态码：400

表8 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：401

表9 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：403

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：404

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：500

**表12** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

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",
    "cba_enabled" : true,
    "certificate_id" : "xxxxxxxxxxx"
  },
  "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",
    "cba_enabled" : false,
    "certificate_id" : null
  },
  "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"
}

响应示例

状态码：200

开通云办公服务响应。

{
  "job_id" : "0000000059071dbc01591661d3990019"
}

状态码

状态码	描述
200	开通云办公服务响应。
400	由于包含语法错误，当前请求无法被服务器理解。
401	鉴权失败。
403	没有操作权限。
404	找不到资源。
500	服务内部错误，具体返回错误码请参见错误码说明。