# 包周期下单 - CreateOrder #### 功能介绍 包周期资源（桌面、磁盘）下订单。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Workspace/doc?api=CreateOrder)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-workspace/workspace_09_0128.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | workspace:orders:create | Write | - | - workspace:CreateOrderType - workspace:AssociatePublicIp - workspace:AccessMode | - | - ims:images:list - vpc:vpcs:get - vpc:networks:get - vpc:subnets:get - vpc:ports:get - bss:order:update - kms:cmk:createGrant - kms:cmk:listGrants - kms:cmk:get - kms:cmk:list - iam:agencies:pass | #### URI POST /v2/{project_id}/periodic/subscribe/order 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 是 | String | 订单类型，createDesktops：创建桌面，addVolumes：添加磁盘，rebuildDesktops：重建系统盘，createDesktopPool 创建桌面池，expandDesktopPool 扩容桌面池，applyDesktopsInternet：开通桌面EIP上网，createExclusiveHosts：创建专享主机，subscribeUserSharer：订购用户协同资源，ApplySubnetBandwidth：开通云办公带宽。 | | enterprise_project_id | 否 | String | 企业项目ID，默认"0。" | | agency_urn | 否 | String | 授权给Billing服务的委托URN。使用RAM共享密钥创建包周期云桌面或添加包周期磁盘时，需要传入该字段。 | | resources | 是 | Array of [Resource] objects | 包周期资源。 | | extend_param | 否 | [OrderExtendParam] object | 订单的扩展参数。 | 表3Resource | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | period_type | 否 | Integer | 订购周期类型：2：月；3：年；4：包小时（仅限带宽加油包购买场景使用）5：绝对时间；（追加附属资源场景使用，比如主机上追加云硬盘）6：一次性（chargingMode=1 一次性计费场景使用），必填 | | period_num | 否 | Integer | 订购周期数。 | | is_auto_renew | 否 | Integer | 是否自动续订。 | | add_volumes | 否 | [AddVolumes] object | 磁盘订单请求。 | | create_desktops | 否 | [CreateDesktopReq] object | 创建桌面请求。 | | rebuild_desktops | 否 | [RebuildDesktopsReq] object | 重建系统盘的请求。 | | attach_desktops | 否 | [AttachInstancesReq] object | 分配用户请求。 | | create_exclusive_hosts | 否 | [CreateExclusiveHostsReq] object | 创建专享主机请求体。 | | resize_exclusive_lites | 否 | [ResizeExclusiveLitesReq] object | 专享主机变更桌面桌面路数请求。 | | create_desktop_pool | 否 | [CreateDesktopPoolReq] object | 创建桌面请求。 | | expand_desktop_pool | 否 | [ExpandDesktopPoolOrderReq] object | 扩容桌面池请求。 | | apply_desktops_internet | 否 | [ApplyDesktopsInternet] object | 开通桌面上网能力请求体。 | | apply_subnet_bandwidth | 否 | [ApplySubnetBandwidthReq] object | 开通云办公带宽请求体。 | | subscribe_user_sharer | 否 | [SubscribeUserSharerReq] object | 用户订阅协同请求体。 | 表4AddVolumes | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | desktop_id | 是 | String | 桌面ID。 | | volumes | 是 | Array of [Volume] objects | 订单的磁盘信息列表。 | 表5CreateDesktopReq | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | desktop_type | 是 | String | 云桌面类型。 - DEDICATED：专属桌面，单用户。 - SHARED: 多用户共享桌面。 | | availability_zone | 否 | String | 可用分区。将桌面创建到指定的可用分区。 | | product_id | 是 | String | 套餐ID。 | | buy_type | 否 | String | console页面购买方式。默认值为custom。 - speed：快速购买。 - custom：自定义购买。 | | image_type | 是 | String | 镜像类型。默认值为private。 - private：私有镜像。 - gold：公共镜像。 | | image_id | 是 | String | 镜像ID，用于私有镜像创建桌面场景，配合product_id使用。 | | root_volume | 是 | [Volume] object | 系统盘。 | | data_volumes | 否 | Array of [Volume] objects | 数据盘列表。 | | nics | 否 | Array of [Nic] objects | 桌面对应的网卡信息，如果不指定则使用默认网卡。 | | security_groups | 否 | Array of [SecurityGroupIdInfo] objects | 桌面使用的安全组，如果不指定则默认使用桌面代理中指定的安全组。 | | desktops | 否 | Array of [Desktop] objects | 创建桌面使用的参数列表。长度为1-100。 | | desktop_name | 否 | String | 搭配size使用，当size为1时代表桌面名，位数1-15，当size大于1时代表桌面名前缀，位数：1-13。 | | desktop_ips | 否 | Array of strings | 桌面指定分配的ip地址列表,最小为0，最大为100。 | | size | 否 | Integer | 创建不分配用户的桌面的个数，和desktops不能同时生效，搭配desktop_name使用。 | | email_notification | 否 | Boolean | 创建成功后是否发送邮件通知桌面用户，默认为true。 | | enterprise_project_id | 否 | String | 企业项目ID，默认"0。" | | ou_name | 否 | String | OU名称，在对接AD时使用，需提前在AD中创建OU。 | | tags | 否 | Array of [Tag] objects | 标签列表。 | | apply_shared_vpc_dedicated_param | 否 | [ApplySharedVpcDedicatedParam] object | 共享Vpc专线入参。 | | eip | 否 | [Eip] object | EIP信息。 | | desktop_name_policy_id | 否 | String | 策略id，用于指定生成桌面名称策略，如果指定了桌面名称则优先使用指定的桌面名称。 | | hour_package_product_id | 否 | String | 桌面小时包套餐ID。 | | hour_package_offering_id | 否 | String | 桌面小时包offeringID。 | | if_mount_old_desktop_disk | 否 | Boolean | 是否在发放新桌面时，挂载旧桌面磁盘为数据盘 | | domain | 否 | String | 桌面分配的域。 | 表6Volume | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 是 | String | 桌面数据盘对应的磁盘类型，需要与系统所提供的磁盘类型相匹配。 -SAS：高IO。 -SSD：超高IO。 -GPSSD：通用型SSD。 | | size | 是 | Integer | 磁盘容量，单位GB。系统盘大小范围\[80-32760\]，数据盘范围\[10-32760\]，大小为10的倍数。 | | iops | 否 | Integer | iops，云硬盘每秒进行读写的操作次数。 | | throughput | 否 | Integer | 吞吐量，云硬盘每秒成功传送的数据量，即读取和写入的数据量。 | | kms_id | 否 | String | kms密钥id，对创建的磁盘进行加密。 | 表7Nic | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | subnet_id | 是 | String | 网卡对应的子网ID。 | 表8SecurityGroupIdInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 是 | String | 安全组ID。 | 表9Desktop | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | user_name | 是 | String | 桌面所属的用户，当桌面创建成功后此用户可以登录该桌面。只允许输入大写字母、小写字母、数字、中划线（-）和下划线（_）。域类型为LITE_AD时，使用小写字母或者大写字母开头，长度范围为\[1-20\]。当域类型为LOCAL_AD时，用户名可以使用小写字母或者大写字母或者数字开头，长度范围为\[1-32\]。Windows桌面用户最长支持20个字符，Linux桌面用户最长支持32个字符。 | | domain | 否 | String | 用户所属域。 | | user_email | 否 | String | 合法用户邮箱，桌面创建成功后系统会通过发送邮件的方式通知用户。 | | user_phone | 否 | String | 合法用户手机号。 | | user_group | 否 | String | 桌面用户所属的用户组。 - sudo：Linux管理员组。 - default：Linux默认用户组。 - administrators：Windows管理员组。管理员拥有对该桌面的完全访问权，可以做任何需要的更改（禁用操作除外）。 - users：Windows标准用户组。标准用户可以使用大多数软件，并可以更改不影响其他用户的系统设置。 | | computer_name | 否 | String | 桌面名，桌面名必须保证唯一。桌面名称只允许输入大写字母、小写字母、中文、数字、中划线，以字母或数字开头、不能以中划线结尾，长度范围为1\~15(中文字符长度为2，数字及英文字符长度为1)。 | | os_host_name | 否 | String | 系统计算机名。 | | desktop_name_prefix | 否 | String | 桌面名称前缀，不指定"computer_name"时生效。 | | copy_volume_desktop_id | 否 | String | 需要拷贝数据盘的桌面ID，如果指定了该参数，那么copy_volume_ids不能为空。 | | copy_volume_ids | 否 | Array of strings | 需要拷贝数据盘桌面的磁盘ID列表，如果指定了该参数，copy_volume_desktop_id不能为空，且磁盘必须属于该桌面。 | | if_delete_old_desktop | 否 | Boolean | 是否删除按需旧桌面，值为true时，新发放桌面配置并拷贝磁盘后删除旧桌面 | 表10ApplySharedVpcDedicatedParam | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | address | 否 | String | 租户指定的共享Vpc专线地址。 | | port | 否 | Integer | 租户指定共享Vpc专线地址端口。 | | availability_zone | 否 | Array of strings | 开通服务资源使用的可用分区，默认随机使用2个可用区。 | 表11Eip | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 否 | String | 桌面绑定的EIP的id，有值时优先绑定EIP。 | | type | 否 | String | EIP的类型。 | | charge_mode | 否 | String | eip带宽计费模式 - TRAFFIC：按流量计费。 - BANDWIDTH：按带宽计费。 | | bandwidth_size | 否 | Integer | 带宽大小。 | 表12RebuildDesktopsReq | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | desktop_ids | 是 | Array of strings | 计算机id列表。 | | image_type | 是 | String | 镜像类型 - 公共镜像：gold - 私有镜像：private - 市场镜像：market | | image_id | 是 | String | 模板ID。 | | encrypt_type | 否 | String | 加密类型。 - KEEP：保持原有加密状态 - UNENCRYPTED：不加密 - ENCRYPTED：加密（需同步上传kms_id） | | kms_id | 否 | String | 密钥ID，encrypt_type为ENCRYPTED时必传。 | | os_type | 否 | String | os类型。 | | delay_time | 否 | Integer | 立即重建时给用户预留的保存数据的时间（单位：分钟）。 | | message | 否 | String | 下发重建系统盘任务时，给用户发送的提示信息。 | | order_id | 否 | String | 订单ID，包周期桌面重建系统盘，涉及收费镜像时需传。 | | enterprise_project_id | 否 | String | 企业项目ID，默认"0。" | | handle_type | 否 | String | 处理类型 - ONLY_FOR_EXPAND：仅对新扩容桌面生效 - FOR_EXPAND_AND_IDLE：对新扩容桌面与空闲桌面生效 - FOR_EXPAND_AND_ALL：对新扩容桌面与已有全部桌面生效 | 表13AttachInstancesReq | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | desktops | 否 | Array of [AttachInstancesDesktopInfo] objects | 桌面信息列表。 | | image_type | 否 | String | 镜像类型，涉及变更镜像时需传（可选）。 | | image_id | 否 | String | 模板ID，涉及变更镜像时需传（可选）。 | | desktop_name_policy_id | 否 | String | 策略id，用于指定生成桌面名称策略，如果指定了桌面名称则优先使用指定的桌面名称。 | | encrypt_type | 否 | String | 加密类型。 - KEEP：保持原有加密状态 - UNENCRYPTED：不加密 - ENCRYPTED：加密（需同步上传kms_id） | | kms_id | 否 | String | 密钥ID，encrypt_type为ENCRYPTED时必传。 | 表14AttachInstancesDesktopInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | desktop_id | 否 | String | 待分配的桌面ID。 | | user_name | 否 | String | 桌面所属的用户，当桌面分配成功后此用户可以登录该桌面。只允许输入大写字母、小写字母、数字、中划线（-）和下划线（_）。域类型为LITE_AD时，使用小写字母或者大写字母开头，长度范围为\[1-20\]。当域类型为LOCAL_AD时，用户名可以使用小写字母或者大写字母或者数字开头，长度范围为\[1-32\]。Windows桌面用户最长支持20个字符，Linux桌面用户最长支持32个字符。用户名不能与分配的机器名重名。 attach_user_infos为空时,必填,attach_user_infos优先级更高 | | user_id | 否 | String | 用户id。 | | user_email | 否 | String | 合法用户邮箱，桌面分配成功后系统会通过发送邮件的方式通知用户。 | | user_group | 否 | String | 桌面用户所属的用户组,attach_user_infos为空时,必填,attach_user_infos优先级更高。 - sudo：Linux管理员组。 - default：Linux默认用户组。 - administrators：Windows管理员组。管理员拥有对该桌面的完全访问权，可以做任何需要的更改（禁用操作除外）。 - users：Windows标准用户组。标准用户可以使用大多数软件，并可以更改不影响其他用户的系统设置。 | | computer_name | 否 | String | 桌面名，桌面名必须保证唯一。只允许输入大写字母、小写字母、数字、中划线（-）和下划线（_）；以字母开头且不允许以中划线（-）结尾；长度范围为\[1-15\]。 | | is_clear_data | 否 | Boolean | 该字段只有当解绑和绑定为同一个用户时生效。表示绑定时是否清理桌面数据，true：清理，false：不清理，默认值为true。 | | attach_user_infos | 否 | Array of [AttachInstancesUserInfo] objects | 待分配的用户信息列表,只有多用户桌面分配多人时有效。 | 表15AttachInstancesUserInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | user_id | 否 | String | 当type字段为USER时，填写用户id；当type字段为GROUP时，填写用户组id，后端服务会校验组id是否存在； | | user_name | 是 | String | 桌面分配对象的名称，当type类型USER时填写用户名字；当type类型GROUP时填写用户组名称。 - 当type类型USER时：桌面所属的用户，当桌面分配成功后此用户可以登录该桌面。只允许输入大写字母、小写字母、数字、中划线（-）和下划线（_）。域类型为LITE_AD时，使用小写字母或者大写字母开头，长度范围为\[1-20\]。当域类型为LOCAL_AD时，用户名可以使用小写字母或者大写字母或者数字开头，长度范围为\[1-64\]。Windows桌面用户最长支持20个字符，Linux桌面用户最长支持64个字符。后端服务会校验用户名是否存在，并且用户名不能与机器名重复。 - 当type类型GROUP时：只能为中文、字母、数字及特殊符号-_。 | | domain | 否 | String | 用户所属域。 | | user_group | 是 | String | 桌面用户所属的用户组。 - sudo：Linux管理员组。 - default：Linux默认用户组。 - administrators：Windows管理员组。管理员拥有对该桌面的完全访问权，可以做任何需要的更改（禁用操作除外）。 - users：Windows标准用户组。标准用户可以使用大多数软件，并可以更改不影响其他用户的系统设置。 | | type | 否 | String | 对象类型，可选值为，默认值为USER： - USER：用户。 - GROUP：用户组。 | 表16CreateExclusiveHostsReq | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | availability_zone | 是 | String | 可用分区。 | | name | 否 | String | 名称。 | | apply_desktop_quantity | 否 | Integer | 追加桌面数量。 | | quantity | 是 | Integer | 购买数量。 | | product_id | 是 | String | 产品套餐ID。 | | image_volumes | 是 | Array of [Volume] objects | 镜像盘列表。 | | enterprise_project_id | 否 | String | 企业项目ID，默认"0。" | | memory_volumes | 是 | Array of [Volume] objects | 存储盘列表。 | | vpc_id | 是 | String | vpc id。 | | subnet_id | 是 | String | 子网id。 | | resize_exclusive_lites | 否 | [ResizeExclusiveLitesReq] object | 专享主机变更桌面桌面路数请求。 | 表17ResizeExclusiveLitesReq | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | enterprise_project_id | 否 | String | 企业项目ID，默认"0。" | | product_id | 是 | String | 产品套餐ID。 | | new_quantity | 是 | Integer | 扩容后的桌面个数，单位为个/次。 | 表18CreateDesktopPoolReq | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 是 | String | 桌面池名称，桌面池名称必须保证唯一。桌面名称只允许输入中文、大写字母、小写字母、数字、中划线，长度范围为1\~64。 | | type | 是 | String | 桌面池类型，DYNAMIC：动态池，STATIC：静态池。 | | size | 是 | Integer | 桌面池大小：当前桌面池要创建多少台桌面。 | | description | 否 | String | 桌面池描述。 | | availability_zone | 否 | String | 可用分区。将桌面创建到指定的可用分区。 | | product_id | 是 | String | 套餐ID。 | | flavor_id | 否 | String | 产品规格ID。 | | image_type | 是 | String | 镜像类型。默认值为private。 - private：私有镜像。 - gold：公共镜像。 | | image_id | 是 | String | 镜像ID，用于私有镜像创建桌面场景，配合product_id使用。 | | root_volume | 是 | [VolumeInfo] object | 系统盘。 | | data_volumes | 否 | Array of [VolumeInfo] objects | 数据盘列表。 | | vpc_id | 否 | String | 创建桌面时的VPC ID。 | | subnet_ids | 是 | Array of strings | 创建桌面使用的子网ID。 | | security_groups | 否 | Array of [SecurityGroupIdInfo] objects | 桌面使用的安全组，如果不指定则默认使用桌面代理中指定的安全组。 | | authorized_objects | 否 | Array of [AuthorizedObjects] objects | 要授权的用户/用户组列表。 | | ou_name | 否 | String | OU名称，在对接AD时使用，需提前在AD中创建OU。 | | tags | 否 | Array of [Tag] objects | 标签列表。 | | enterprise_project_id | 否 | String | 企业项目ID，默认"0。" | | disconnected_retention_period | 否 | Integer | 动态池桌面断连多少分钟内，保留用户与桌面的绑定关系，超时后自动解绑。 | | enable_autoscale | 否 | Boolean | 桌面池是否开启弹性伸缩类型，为false则表示不开启弹性伸缩，为true则表示开启弹性伸缩。 | | autoscale_policy | 否 | [AutoscalePolicy] object | 弹性伸缩策略。 | | user_reset_policy | 否 | [UserResetPolicy] object | 用户重置策略。 | | desktop_name_policy_id | 否 | String | 策略id，用于指定生成桌面名称策略。 | | domain | 否 | String | 桌面分配的域。 | 表19VolumeInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 否 | String | 批量操作磁盘的磁盘集合id。 | | type | 是 | String | 桌面数据盘对应的磁盘类型，需要与系统所提供的磁盘类型相匹配。 - SAS：高IO。 - SSD：超高IO。 | | size | 是 | Integer | 磁盘容量，单位GB。 | | iops | 否 | Integer | iops，云硬盘每秒进行读写的操作次数。 | | throughput | 否 | Integer | 吞吐量，云硬盘每秒成功传送的数据量，即读取和写入的数据量。 | | resource_spec_code | 否 | String | 规格。 | | kms_id | 否 | String | kms密钥Id | 表20AuthorizedObjects | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | object_type | 是 | String | 绑定对象类型枚举。 - USER：用户 - USER_GROUP：用户组 | | object_id | 是 | String | 用户/用户组id。 | | object_name | 是 | String | 用户/用户组名称。 | | domain | 否 | String | 用户/用户组所属域名。 | | user_group | 是 | String | 桌面用户所属的用户权限组。 - sudo：Linux管理员组。 - default：Linux默认用户组。 - administrators：Windows管理员组。管理员拥有对该桌面的完全访问权，可以做任何需要的更改（禁用操作除外）。 - users：Windows标准用户组。标准用户可以使用大多数软件，并可以更改不影响其他用户的系统设置。 | | created_at | 否 | String | 创建时间。 | 表21Tag | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key | 是 | String | 标签的键，不能为空，最大长度128个unicode字符。大小写字母，数字，可以包含中划线"-"，下划线"_"，不能包含以下字符"=","\*","\<","\>","\\",",","\|","/"。 | | value | 否 | String | 标签的值，最大长度43个unicode字符。大小写字母，数字，可以包含中划线"-"，下划线"_"，不能包含以下字符"=","\*","\<","\>","\\",",","\|","/"。 | 表22AutoscalePolicy | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | autoscale_type | 否 | String | 弹性伸缩类型，ACCESS_CREATED：接入时创建，AUTO_CREATED：弹性伸缩。 | | max_auto_created | 否 | Integer | 最大自动创建桌面数。 | | min_idle | 否 | Integer | 预留空闲桌面数。 | | once_auto_created | 否 | Integer | 一次自动创建桌面的数量(已弃用)。 | | min_retention | 否 | Integer | 最小桌面数。 | | idle_retention_duration | 否 | Integer | 空闲桌面保留时长（分钟）。 | | auto_isolation_enable | 否 | Boolean | 自动故障隔离开关。 | | auto_isolation_max_num | 否 | Integer | 自动隔离桌面数量上限，默认上限1000。 | 表23UserResetPolicy | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | enable | 否 | Boolean | 开关 | | reset_count_per_day | 否 | Integer | 用户每天自动重试次数,重置次数每天0点刷新。 | 表24ExpandDesktopPoolOrderReq | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | size | 否 | Integer | 扩容桌面池的大小。 | | pool_id | 是 | String | 要扩容的桌面池ID。 | 表25ApplyDesktopsInternet | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | desktop_ids | 否 | Array of strings | 需要开通上网功能的桌面id列表。 | | eip_type | 是 | String | 支持的类型请参考EIP服务支持的类型。可通过调用如下链接的接口查询，https://support.huaweicloud.com/api-eip/ShowPublicIpType.html。 | | eip_charge_mode | 是 | String | eip带宽计费模式 - TRAFFIC：按流量计费。 - BANDWIDTH：按带宽计费。 | | bandwidth_size | 是 | Integer | 带宽大小，单位Mbit/s。默认1Mbit/s\~2000Mbit/s（具体范围以各区域配置为准，请参见控制台对应页面显示）。 | | count | 否 | Integer | 需要购买EIP的数量，当desktop_ids为空时需要填，兼容单独购买EIP场景。 | 表26ApplySubnetBandwidthReq | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | bandwidth_name | 否 | String | 云办公带宽名称。 | | subnet_id | 是 | String | 子网id。 | | charge_mode | 是 | String | 计费模式 - wks_bandwidth：按带宽计费，仅包周期支持。 - free: 不计费，仅按需支持。 - wks_traffic：按流量计费，仅按需支持。 | | bandwidth_size | 否 | Integer | 云办公带宽大小。 | | enterprise_project_id | 否 | String | 企业项目ID，默认"0。" | 表27SubscribeUserSharerReq | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | user_sharer_sku | 是 | String | 用户协同资源SKU码。 | | users | 是 | Array of [SubscribeUserInfo] objects | 开通协同的的用户列表。 | 表28SubscribeUserInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | user_id | 是 | String | 用户id。 | | user_name | 是 | String | 用户名称。 | 表29OrderExtendParam | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | is_auto_pay | 否 | String | 是否自动付款。true:自动支付; false：不自动支付;默认false。 | #### 响应参数 **状态码：200** 表30响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | order_id | String | 订单号，下单成功时返回订单ID。 | | job_id | String | 任务id，下单成功时返回的任务ID。 | **状态码：400** 表31响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：500** 表32响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | #### 请求示例 - ``` POST /v2/0bec5db98280d2d02fd6c00c2de791ce/periodic/subscribe/order { "type" : "addVolumes", "enterprise_project_id" : "0", "resources" : [ { "add_volumes" : { "desktop_id" : "8d049b4e-4f1e-4ed5-b3a9-a7f0f15658a7", "volumes" : [ { "type" : "SAS", "size" : 50 } ] } } ] } ``` - ``` POST /v2/0bec5db98280d2d02fd6c00c2de791ce/periodic/subscribe/order { "type" : "createDesktops", "enterprise_project_id" : "0", "resources" : [ { "period_type" : 2, "period_num" : 1, "create_desktops" : { "desktops" : [ { "user_email" : "test@test.com", "user_name" : "test", "user_group" : "sudo" } ], "desktop_type" : "DEDICATED", "email_notification" : false, "product_id" : "workspace.k.xlarge2.uosv20pro", "image_type" : "private", "image_id" : "e1d65e11-861c-459d-a3a8-ab150d79befc", "root_volume" : { "type" : "SAS", "size" : 80 }, "nics" : [ { "subnet_id" : "197c1aa4-2611-48bd-a3af-ac4ce2c17c4c" } ], "tags" : [ { "key" : "aa", "value" : "bb" } ] } } ] } ``` #### 响应示例 **状态码：200** CBC下订单响应体。 ``` { "order_id" : "CS2108102036B2CAI" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | CBC下订单响应体。 | | 400 | 由于包含语法错误，当前请求无法被服务器理解。 | | 500 | 服务内部错误，具体返回错误码请参见错误码说明。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-workspace/ErrorCode.html)。