huawei-cloud-api-definitions-Workspace 0.1.20250711

{"base_path":null,"components":null,"consumes":"[\"application/json\",\"application/json;charset=utf-8\"]","definitions":{"AddVolumes":{"description":"磁盘订单请求。","properties":{"desktop_id":{"description":"桌面ID。","maxLength":255,"minLength":1,"type":"string"},"volumes":{"description":"订单的磁盘信息列表。","items":{"$ref":"#/definitions/Volume"},"maxItems":10,"minItems":1,"type":"array","x-maxLength":10,"x-minLength":1}},"required":["desktop_id","volumes"]},"ApplyDesktopsInternet":{"description":"开通桌面上网能力请求体。","properties":{"bandwidth_size":{"description":"带宽大小,单位Mbit/s。默认1Mbit/s~2000Mbit/s(具体范围以各区域配置为准,请参见控制台对应页面显示)。","format":"int32","maximum":2000,"minimum":1,"type":"integer"},"count":{"description":"需要购买EIP的数量,当desktop_ids为空时需要填,兼容单独购买EIP场景。","format":"int32","maximum":100,"minimum":0,"type":"integer"},"desktop_ids":{"description":"需要开通上网功能的桌面id列表。","items":{"maxLength":255,"minLength":0,"type":"string"},"maxItems":100,"minItems":0,"type":"array","x-maxLength":100,"x-minLength":0},"eip_charge_mode":{"description":"eip带宽计费模式\n- TRAFFIC:按流量计费。\n- BANDWIDTH:按带宽计费。","enum":["TRAFFIC","BANDWIDTH"],"maxLength":255,"minLength":0,"type":"string"},"eip_type":{"description":"支持的类型请参考EIP服务支持的类型。可通过调用如下链接的接口查询,https://support.huaweicloud.com/api-eip/ShowPublicIpType.html。","maxLength":255,"minLength":0,"type":"string"}},"required":["bandwidth_size","eip_charge_mode","eip_type"]},"ApplySharedVpcDedicatedParam":{"description":"共享Vpc专线入参。","properties":{"address":{"description":"租户指定的共享Vpc专线地址。","maxLength":255,"minLength":0,"type":"string"},"availability_zone":{"description":"开通服务资源使用的可用分区,默认随机使用2个可用区。","items":{"maxLength":255,"minLength":0,"type":"string"},"maxItems":10,"minItems":0,"type":"array","x-maxLength":10,"x-minLength":0},"port":{"description":"租户指定共享Vpc专线地址端口。","maximum":65535,"minimum":1025,"type":"integer"}}},"ApplySubnetBandwidthReq":{"description":"开通云办公带宽请求体。","properties":{"bandwidth_name":{"description":"云办公带宽名称。","maxLength":64,"minLength":2,"pattern":"^[a-zA-Z0-9\\u4E00-\\u9FA5_\\-*\\+\\.]+$","type":"string"},"bandwidth_size":{"description":"云办公带宽大小。","format":"int32","maximum":2000,"minimum":1,"type":"integer"},"charge_mode":{"description":"计费模式\n- wks_bandwidth:按带宽计费,仅包周期支持。\n- free: 不计费,仅按需支持。\n- wks_traffic:按流量计费,仅按需支持。","maxLength":255,"minLength":1,"type":"string"},"enterprise_project_id":{"default":"0","description":"企业项目ID,默认\"0。\"","maxLength":36,"minLength":0,"type":"string"},"subnet_id":{"description":"子网id。","maxLength":255,"minLength":1,"type":"string"}},"required":["charge_mode","subnet_id"]},"AttachInstancesDesktopInfo":{"description":"分配用户请求桌面信息,单人专属桌面只能分配给一个用户;多人共享桌面可以分配给多个用户或用户组,具体分配信息见字段attach_user_infos说明。","properties":{"attach_user_infos":{"description":"待分配的用户信息列表,只有多用户桌面分配多人时有效。","items":{"$ref":"#/definitions/AttachInstancesUserInfo"},"maxItems":500,"minItems":0,"type":"array","x-maxLength":500,"x-minLength":0},"computer_name":{"description":"桌面名,桌面名必须保证唯一。只允许输入大写字母、小写字母、数字、中划线(-)和下划线(_);以字母开头且不允许以中划线(-)结尾;长度范围为[1-15]。","maxLength":15,"minLength":1,"type":"string"},"desktop_id":{"description":"待分配的桌面ID。","maxLength":255,"minLength":0,"type":"string"},"is_clear_data":{"default":true,"description":"该字段只有当解绑和绑定为同一个用户时生效。表示绑定时是否清理桌面数据,true:清理,false:不清理,默认值为true。","type":"boolean"},"user_email":{"description":"合法用户邮箱,桌面分配成功后系统会通过发送邮件的方式通知用户。","maxLength":255,"minLength":0,"type":"string","x-isSensitive":true},"user_group":{"description":"桌面用户所属的用户组,attach_user_infos为空时,必填,attach_user_infos优先级更高。\n\n- sudo:Linux管理员组。\n- default:Linux默认用户组。\n- administrators:Windows管理员组。管理员拥有对该桌面的完全访问权,可以做任何需要的更改(禁用操作除外)。\n- users:Windows标准用户组。标准用户可以使用大多数软件,并可以更改不影响其他用户的系统设置。","maxLength":255,"minLength":1,"type":"string"},"user_name":{"description":"桌面所属的用户,当桌面分配成功后此用户可以登录该桌面。只允许输入大写字母、小写字母、数字、中划线(-)和下划线(_)。域类型为LITE_AD时,使用小写字母或者大写字母开头,长度范围为[1-20]。当域类型为LOCAL_AD时,用户名可以使用小写字母或者大写字母或者数字开头,长度范围为[1-32]。Windows桌面用户最长支持20个字符,Linux桌面用户最长支持32个字符。用户名不能与分配的机器名重名。 attach_user_infos为空时,必填,attach_user_infos优先级更高","maxLength":64,"minLength":1,"type":"string","x-isSensitive":true}}},"AttachInstancesReq":{"description":"分配用户请求。","properties":{"desktop_name_policy_id":{"description":"策略id,用于指定生成桌面名称策略,如果指定了桌面名称则优先使用指定的桌面名称。","maxLength":36,"minLength":0,"type":"string"},"desktops":{"description":"桌面信息列表。","items":{"$ref":"#/definitions/AttachInstancesDesktopInfo"},"maxItems":50,"minItems":1,"type":"array","x-maxLength":50,"x-minLength":1},"image_id":{"description":"模板ID,涉及变更镜像时需传(可选)。","maxLength":255,"minLength":1,"type":"string"},"image_type":{"description":"镜像类型,涉及变更镜像时需传(可选)。","maxLength":255,"minLength":0,"type":"string"}}},"AttachInstancesUserInfo":{"description":"桌面分配用户信息。","properties":{"type":{"default":"USER","description":"对象类型,可选值为:\n- USER:用户。\n- GROUP:用户组。","enum":["USER","GROUP"],"maxLength":20,"minLength":1,"type":"string"},"user_group":{"description":"桌面用户所属的用户组。\n- sudo:Linux管理员组。\n- default:Linux默认用户组。\n- administrators:Windows管理员组。管理员拥有对该桌面的完全访问权,可以做任何需要的更改(禁用操作除外)。\n- users:Windows标准用户组。标准用户可以使用大多数软件,并可以更改不影响其他用户的系统设置。","maxLength":255,"minLength":1,"type":"string"},"user_id":{"description":"当type字段为USER时,填写用户id;当type字段为GROUP时,填写用户组id,后端服务会校验组id是否存在;","maxLength":255,"minLength":1,"type":"string"},"user_name":{"description":"桌面分配对象的名称,当type类型USER时填写用户名字;当type类型GROUP时填写用户组名称。\n- 当type类型USER时:桌面所属的用户,当桌面分配成功后此用户可以登录该桌面。只允许输入大写字母、小写字母、数字、中划线(-)和下划线(_)。域类型为LITE_AD时,使用小写字母或者大写字母开头,长度范围为[1-20]。当域类型为LOCAL_AD时,用户名可以使用小写字母或者大写字母或者数字开头,长度范围为[1-64]。Windows桌面用户最长支持20个字符,Linux桌面用户最长支持64个字符。后端服务会校验用户名是否存在,并且用户名不能与机器名重复。\n- 当type类型GROUP时:只能为中文、字母、数字及特殊符号-_。","maxLength":64,"minLength":1,"type":"string","x-isSensitive":true}}},"AuthorizedObjects":{"description":"查询桌面池授权的用户、用户组响应的用户/用户组信息。","properties":{"created_at":{"description":"创建时间。格式为:UTC格式,例如“2022-05-11T11:45:42.000Z”。","maxLength":100,"minLength":0,"type":"string"},"object_id":{"description":"用户/用户组id。","maxLength":255,"minLength":1,"type":"string"},"object_name":{"description":"用户/用户组名称。","maxLength":100,"minLength":1,"type":"string"},"object_type":{"description":"绑定对象类型枚举。\n\n- USER:用户\n- USER_GROUP:用户组","enum":["USER","USER_GROUP"],"maxLength":100,"minLength":1,"type":"string"},"user_group":{"description":"桌面用户所属的用户权限组。\n\n- sudo:Linux管理员组。\n- default:Linux默认用户组。\n- administrators:Windows管理员组。管理员拥有对该桌面的完全访问权,可以做任何需要的更改(禁用操作除外)。\n- users:Windows标准用户组。标准用户可以使用大多数软件,并可以更改不影响其他用户的系统设置。","maxLength":55,"minLength":1,"type":"string"}},"required":["object_id","object_name","object_type","user_group"]},"AutoscalePolicy":{"description":"弹性伸缩策略。","properties":{"autoscale_type":{"description":"弹性伸缩类型,ACCESS_CREATED:接入时创建,AUTO_CREATED:弹性伸缩。","enum":["ACCESS_CREATED","AUTO_CREATED"],"maxLength":55,"minLength":0,"type":"string"},"max_auto_created":{"description":"自动创建桌面上限。","maximum":1000,"minimum":1,"type":"integer"},"min_idle":{"description":"空闲桌面低于多少时开始自动创建桌面。","maximum":1000,"minimum":1,"type":"integer"},"once_auto_created":{"description":"一次自动创建桌面的数量。","maximum":100,"minimum":1,"type":"integer"}}},"BaseResponse":{"description":"API响应基类。","properties":{"encoded_authorization_message":{"description":"加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。","readOnly":true,"type":"string"},"error_code":{"description":"错误码。","maxLength":12,"minLength":0,"type":"string"},"error_msg":{"description":"错误描述。","maxLength":1000,"minLength":0,"type":"string"}}},"CreateDesktopPoolReq":{"description":"创建桌面请求。","properties":{"authorized_objects":{"description":"要授权的用户/用户组列表。","items":{"$ref":"#/definitions/AuthorizedObjects"},"maxItems":500,"minItems":0,"type":"array","x-maxLength":500,"x-minLength":0},"autoscale_policy":{"$ref":"#/definitions/AutoscalePolicy"},"availability_zone":{"description":"可用分区。将桌面创建到指定的可用分区。如果不指定则使用系统随机的可用分区。","maxLength":255,"minLength":0,"type":"string"},"data_volumes":{"description":"数据盘列表。","items":{"$ref":"#/definitions/VolumeInfo"},"maxItems":10,"minItems":0,"type":"array","x-maxLength":10,"x-minLength":0},"description":{"description":"桌面池描述。","maxLength":255,"minLength":0,"type":"string"},"desktop_name_policy_id":{"description":"策略id,用于指定生成桌面名称策略。","maxLength":36,"minLength":0,"type":"string"},"disconnected_retention_period":{"description":"动态池桌面断连多少分钟内,保留用户与桌面的绑定关系,超时后自动解绑。","maximum":43200,"minimum":10,"type":"integer"},"enable_autoscale":{"default":false,"description":"桌面池是否开启弹性伸缩类型,为false则表示不开启弹性伸缩,为true则表示开启弹性伸缩。","type":"boolean"},"enterprise_project_id":{"default":"0","description":"企业项目ID,默认\"0。\"","maxLength":36,"minLength":0,"pattern":"^[a-zA-Z0-9_-]+$","type":"string"},"flavor_id":{"description":"产品规格ID。可用区是边缘可用区时,必填此参数。","maxLength":255,"minLength":1,"type":"string"},"image_id":{"description":"镜像ID,用于私有镜像创建桌面场景,配合product_id使用。","maxLength":255,"minLength":1,"type":"string"},"image_type":{"default":"private","description":"镜像类型。默认值为private。\n\n- private:私有镜像。\n- gold:公共镜像。","maxLength":55,"minLength":1,"type":"string"},"name":{"description":"桌面池名称,桌面池名称必须保证唯一。桌面名称只允许输入中文、大写字母、小写字母、数字、中划线,长度范围为1~255。","maxLength":255,"minLength":1,"type":"string"},"ou_name":{"description":"OU名称,在对接AD时使用,需提前在AD中创建OU。","maxLength":255,"minLength":0,"type":"string"},"product_id":{"description":"套餐ID。","maxLength":255,"minLength":1,"type":"string"},"root_volume":{"$ref":"#/definitions/VolumeInfo","description":"系统盘。"},"security_groups":{"description":"桌面使用的安全组,如果不指定则默认使用桌面代理中指定的安全组。","items":{"$ref":"#/definitions/SecurityGroup"},"maxItems":5,"minItems":0,"type":"array","x-maxLength":5,"x-minLength":0},"size":{"description":"桌面池大小:当前桌面池要创建多少台桌面。","maximum":100,"minimum":0,"type":"integer"},"subnet_ids":{"description":"创建桌面使用的子网ID。","items":{"maxLength":55,"minLength":0,"type":"string"},"maxItems":100,"minItems":0,"type":"array","x-maxLength":100,"x-minLength":0},"tags":{"description":"标签列表。","items":{"$ref":"#/definitions/Tag"},"maxItems":10,"minItems":0,"type":"array","x-maxLength":10,"x-minLength":0},"type":{"description":"桌面池类型,DYNAMIC:动态池,STATIC:静态池。","enum":["DYNAMIC","STATIC"],"maxLength":255,"minLength":0,"type":"string"},"vpc_id":{"description":"创建桌面时的VPC ID。","maxLength":255,"minLength":1,"type":"string"}},"required":["image_id","image_type","name","product_id","root_volume","size","subnet_ids","type"]},"CreateDesktopReq":{"description":"创建桌面请求。","properties":{"apply_shared_vpc_dedicated_param":{"$ref":"#/definitions/ApplySharedVpcDedicatedParam"},"availability_zone":{"description":"可用分区。将桌面创建到指定的可用分区。如果不指定则使用系统随机的可用分区。","maxLength":255,"minLength":0,"type":"string"},"data_volumes":{"description":"数据盘列表。","items":{"$ref":"#/definitions/Volume"},"maxItems":10,"minItems":0,"type":"array","x-maxLength":10,"x-minLength":0},"desktop_ips":{"description":"桌面指定分配的ip地址列表,最小为0,最大为100。","items":{"maxLength":255,"minLength":0,"type":"string"},"maxItems":100,"minItems":0,"type":"array","x-maxLength":100,"x-minLength":0},"desktop_name":{"description":"搭配size使用,当size为1时代表桌面名,位数1-15,当size大于1时代表桌面名前缀,位数:1-13。","maxLength":15,"minLength":0,"type":"string"},"desktop_name_policy_id":{"description":"策略id,用于指定生成桌面名称策略,如果指定了桌面名称则优先使用指定的桌面名称。","maxLength":36,"minLength":0,"type":"string"},"desktop_type":{"description":"云桌面类型。\n- DEDICATED:专属桌面,单用户。\n- SHARED: 多用户共享桌面。","enum":["DEDICATED","SHARED"],"maxLength":255,"minLength":0,"type":"string"},"desktops":{"description":"创建桌面使用的参数列表。长度为1-100。\n\n当前不支持一批桌面不同配置,所有桌面的配置和第一台的一致,如果第一台未设置参数,则取外层的同名参数。","items":{"$ref":"#/definitions/Desktop"},"maxItems":100,"minItems":1,"type":"array","x-maxLength":100,"x-minLength":0},"eip":{"$ref":"#/definitions/Eip","description":"EIP信息。"},"email_notification":{"default":true,"description":"创建成功后是否发送邮件通知桌面用户,默认为true。","enum":[true,false],"type":"boolean"},"enterprise_project_id":{"default":"0","description":"企业项目ID,默认\"0。\"","maxLength":36,"minLength":0,"pattern":"^[a-zA-Z0-9_-]+$","type":"string"},"hour_package_offering_id":{"description":"桌面小时包offeringID。","maxLength":255,"minLength":1,"type":"string"},"hour_package_product_id":{"description":"桌面小时包套餐ID。","maxLength":255,"minLength":1,"type":"string"},"image_id":{"description":"镜像ID,用于私有镜像创建桌面场景,配合product_id使用。","maxLength":255,"minLength":1,"type":"string"},"image_type":{"default":"private","description":"镜像类型。默认值为private。\n\n- private:私有镜像。\n- gold:公共镜像。","maxLength":55,"minLength":1,"type":"string"},"nics":{"description":"桌面对应的网卡信息,如果不指定则使用默认网卡。","items":{"$ref":"#/definitions/Nic"},"maxItems":5,"minItems":0,"type":"array","x-maxLength":5,"x-minLength":0},"product_id":{"description":"套餐ID。","maxLength":255,"minLength":1,"type":"string"},"root_volume":{"$ref":"#/definitions/Volume","description":"系统盘。"},"security_groups":{"description":"桌面使用的安全组,如果不指定则默认使用桌面代理中指定的安全组。","items":{"$ref":"#/definitions/SecurityGroup"},"maxItems":5,"minItems":0,"type":"array","x-maxLength":5,"x-minLength":0},"size":{"description":"创建不分配用户的桌面的个数,和desktops不能同时生效,搭配desktop_name使用。","maximum":100,"minimum":1,"type":"integer"},"tags":{"description":"标签列表。","items":{"$ref":"#/definitions/Tag"},"maxItems":10,"minItems":0,"type":"array","x-is-registered":"Y","x-maxLength":10,"x-minLength":0}},"required":["desktop_type","image_id","image_type","product_id","root_volume"]},"CreateExclusiveHostsReq":{"description":"创建专享主机请求体。","properties":{"apply_desktop_quantity":{"description":"追加桌面数量。","example":2,"format":"int32","maximum":300,"minimum":0,"type":"integer"},"availability_zone":{"description":"可用分区。","example":"cn-north-7c","maxLength":255,"minLength":0,"type":"string"},"enterprise_project_id":{"default":"0","description":"企业项目ID,默认\"0。\"","maxLength":36,"minLength":0,"pattern":"^[a-zA-Z0-9_-]+$","type":"string"},"image_volumes":{"description":"镜像盘列表。","example":{"size":60,"type":"SAS"},"items":{"$ref":"#/definitions/Volume"},"maxItems":100,"minItems":0,"type":"array","x-maxLength":100,"x-minLength":0},"memory_volumes":{"description":"存储盘列表。","example":{"size":60,"type":"SAS"},"items":{"$ref":"#/definitions/Volume"},"maxItems":100,"minItems":0,"type":"array","x-maxLength":100,"x-minLength":0},"name":{"description":"名称。","example":"host","maxLength":255,"minLength":0,"type":"string"},"product_id":{"description":"产品套餐ID。","example":"string","maxLength":255,"minLength":0,"type":"string"},"quantity":{"description":"购买数量。","example":2,"format":"int32","maximum":100,"minimum":1,"type":"integer"},"resize_exclusive_lites":{"$ref":"#/definitions/ResizeExclusiveLitesReq"},"subnet_id":{"description":"子网id。","example":"string","maxLength":255,"minLength":0,"type":"string"},"vpc_id":{"description":"vpc id。","example":"string","maxLength":255,"minLength":0,"type":"string"}},"required":["availability_zone","image_volumes","memory_volumes","product_id","quantity","subnet_id","vpc_id"]},"CreateOrderReq":{"description":"包周期订单请求体。","properties":{"enterprise_project_id":{"default":"0","description":"企业项目ID,默认\"0。\"","maxLength":36,"minLength":0,"pattern":"^[a-zA-Z0-9_-]+$","type":"string"},"extend_param":{"$ref":"#/definitions/OrderExtendParam"},"resources":{"description":"包周期资源。","items":{"$ref":"#/definitions/Resource"},"maxItems":50,"minItems":1,"type":"array","x-maxLength":50,"x-minLength":1},"type":{"description":"订单类型,createDesktops:创建桌面,addVolumes:添加磁盘,rebuildDesktops:重建系统盘,createDesktopPool 创建桌面池,expandDesktopPool 扩容桌面池,applyDesktopsInternet:开通桌面EIP上网,createExclusiveHosts:创建专享主机,subscribeUserSharer:订购用户协同资源,ApplySubnetBandwidth:开通云办公带宽。","example":"28f61af50fc9452aa0ed5ea25c3cc3d3","maxLength":36,"minLength":10,"type":"string","x-is-registered":"N"}},"required":["resources","type"]},"CreateOrderRsp":{"description":"创建订单响应体。","properties":{"order_id":{"description":"订单号,下单成功时返回订单ID。","readOnly":true,"type":"string"}}},"Desktop":{"properties":{"computer_name":{"description":"桌面名,桌面名必须保证唯一。桌面名称只允许输入大写字母、小写字母、中文、数字、中划线,以字母或数字开头、不能以中划线结尾,长度范围为1~15(中文字符长度为2,数字及英文字符长度为1)。","maxLength":15,"minLength":1,"type":"string"},"desktop_name_prefix":{"description":"桌面名称前缀,不指定\"computer_name\"时生效。","maxLength":5,"minLength":0,"type":"string"},"os_host_name":{"description":"系统计算机名。","maxLength":15,"minLength":1,"type":"string"},"user_email":{"description":"合法用户邮箱,桌面创建成功后系统会通过发送邮件的方式通知用户。","maxLength":255,"minLength":1,"type":"string"},"user_group":{"description":"桌面用户所属的用户组。\n\n- sudo:Linux管理员组。\n- default:Linux默认用户组。\n- administrators:Windows管理员组。管理员拥有对该桌面的完全访问权,可以做任何需要的更改(禁用操作除外)。\n- users:Windows标准用户组。标准用户可以使用大多数软件,并可以更改不影响其他用户的系统设置。","maxLength":255,"minLength":1,"type":"string"},"user_name":{"description":"桌面所属的用户,当桌面创建成功后此用户可以登录该桌面。只允许输入大写字母、小写字母、数字、中划线(-)和下划线(_)。域类型为LITE_AD时,使用小写字母或者大写字母开头,长度范围为[1-20]。当域类型为LOCAL_AD时,用户名可以使用小写字母或者大写字母或者数字开头,长度范围为[1-32]。Windows桌面用户最长支持20个字符,Linux桌面用户最长支持32个字符。","maxLength":32,"minLength":1,"type":"string","x-isSensitive":true},"user_phone":{"description":"合法用户手机号。","maxLength":255,"minLength":1,"type":"string"}},"required":["user_name"]},"Eip":{"description":"EIP信息。","properties":{"bandwidth_size":{"description":"带宽大小。","format":"int32","maximum":2000,"minimum":1,"type":"integer"},"charge_mode":{"description":"eip带宽计费模式\n- TRAFFIC:按流量计费。\n- BANDWIDTH:按带宽计费。","enum":["TRAFFIC","BANDWIDTH"],"maxLength":10,"minLength":0,"type":"string"},"id":{"description":"桌面绑定的EIP的id,有值时优先绑定EIP。","maxLength":255,"minLength":1,"type":"string"},"type":{"description":"EIP的类型,5_bgp(全动态BGP),5_sbgp(静态BGP)。","maxLength":255,"minLength":0,"type":"string"}}},"ExpandDesktopPoolOrderReq":{"description":"扩容桌面池请求。","properties":{"pool_id":{"description":"要扩容的桌面池ID。","maxLength":255,"minLength":1,"type":"string"},"size":{"description":"扩容桌面池的大小。","maximum":1000,"minimum":1,"type":"integer"}},"required":["pool_id"]},"Nic":{"properties":{"subnet_id":{"description":"网卡对应的子网ID。","maxLength":255,"minLength":0,"type":"string"}},"required":["subnet_id"]},"OrderExtendParam":{"description":"订单的扩展参数。","properties":{"is_auto_pay":{"description":"是否自动付款。true:自动支付; false:不自动支付;默认false。","maxLength":255,"minLength":0,"type":"string"}}},"RebuildDesktopsReq":{"description":"重建系统盘的请求。","properties":{"delay_time":{"description":"立即重建时给用户预留的保存数据的时间(单位:分钟)。","format":"int32","maximum":2147483647,"minimum":0,"type":"integer"},"desktop_ids":{"description":"计算机id列表。","items":{"type":"string"},"type":"array","x-maxLength":100,"x-minLength":0,"x-type":"List<@Size(min=0, max=255) String>"},"enterprise_project_id":{"default":"0","description":"企业项目ID,默认\"0。\"","maxLength":36,"minLength":0,"type":"string"},"image_id":{"description":"模板ID。","maxLength":255,"minLength":1,"type":"string"},"image_type":{"description":"镜像类型。","maxLength":255,"minLength":0,"type":"string"},"message":{"description":"下发重建系统盘任务时,给用户发送的提示信息。","maxLength":400,"minLength":0,"type":"string"},"order_id":{"description":"订单ID,包周期桌面重建系统盘,涉及收费镜像时需传。","maxLength":255,"minLength":0,"type":"string"},"os_type":{"description":"os类型。","maxLength":255,"minLength":0,"type":"string"}},"required":["desktop_ids","image_id","image_type"]},"ResizeExclusiveLitesReq":{"description":"专享主机变更桌面桌面路数请求。","properties":{"enterprise_project_id":{"default":"0","description":"企业项目ID,默认\"0。\"","maxLength":36,"minLength":0,"type":"string"},"new_quantity":{"description":"扩容后的桌面个数,单位为个/次。","format":"int32","maximum":300,"minimum":0,"type":"integer"},"product_id":{"description":"产品套餐ID。","maxLength":255,"minLength":0,"type":"string"}},"required":["new_quantity","product_id"]},"Resource":{"description":"包周期资源对象。","properties":{"add_volumes":{"$ref":"#/definitions/AddVolumes"},"apply_desktops_internet":{"$ref":"#/definitions/ApplyDesktopsInternet"},"apply_subnet_bandwidth":{"$ref":"#/definitions/ApplySubnetBandwidthReq"},"attach_desktops":{"$ref":"#/definitions/AttachInstancesReq"},"create_desktop_pool":{"$ref":"#/definitions/CreateDesktopPoolReq"},"create_desktops":{"$ref":"#/definitions/CreateDesktopReq"},"create_exclusive_hosts":{"$ref":"#/definitions/CreateExclusiveHostsReq"},"expand_desktop_pool":{"$ref":"#/definitions/ExpandDesktopPoolOrderReq"},"is_auto_renew":{"description":"是否自动续订。","format":"int32","maximum":255,"minimum":0,"type":"integer"},"period_num":{"description":"订购周期数。","format":"int32","maximum":2147483647,"minimum":0,"type":"integer"},"period_type":{"description":"订购周期类型:2:月;3:年;4:包小时(仅限带宽加油包购买场景使用)5:绝对时间;(追加附属资源场景使用,比如主机上追加云硬盘)6:一次性(chargingMode=1 一次性计费场景使用),必填","format":"int32","maximum":255,"minimum":0,"type":"integer"},"rebuild_desktops":{"$ref":"#/definitions/RebuildDesktopsReq"},"resize_exclusive_lites":{"$ref":"#/definitions/ResizeExclusiveLitesReq"},"subscribe_user_sharer":{"$ref":"#/definitions/SubscribeUserSharerReq"}}},"SecurityGroup":{"description":"安全组。","properties":{"id":{"description":"安全组ID。","maxLength":255,"minLength":0,"type":"string"},"name":{"description":"安全组名称。","maxLength":55,"minLength":0,"type":"string"}},"required":["id"]},"SubscribeUserSharerReq":{"description":"用户订阅协同请求体。","properties":{"user_sharer_sku":{"description":"用户协同资源SKU码。","maxLength":255,"minLength":0,"type":"string"},"users":{"description":"开通协同的的用户列表。","items":{"$ref":"#/definitions/User"},"maxItems":1000,"minItems":1,"type":"array","x-maxLength":100,"x-minLength":1}},"required":["user_sharer_sku","users"]},"Tag":{"description":"标签。","properties":{"key":{"description":"标签的键,不能为空,最大长度128个unicode字符。标签的键可以包含任意语种字母、数字、空格和_.:=+-@,但首尾不能含有空格,不能以_sys_开头。","maxLength":128,"minLength":0,"type":"string"},"value":{"default":"","description":"标签的值,最大长度43个unicode字符。标签的值可以包含任意语种字母、数字、空格和_.:=+-@,但首尾不能含有空格。","maxLength":43,"minLength":0,"type":"string"}},"required":["key"]},"User":{"properties":{"account_expired":{"description":"账号是否过期,true表示已过期,false表示未过期。","type":"boolean"},"account_expires":{"description":"账户过期时间,0表示永远不过期。","maxLength":55,"minLength":0,"type":"string"},"active_type":{"description":"激活类型,默认为用户激活。\n* USER_ACTIVATE: 用户激活\n* ADMIN_ACTIVATE: 管理员激活","enum":["USER_ACTIVATE","ADMIN_ACTIVATE"],"example":"USER_ACTIVATE","maxLength":50,"minLength":0,"type":"string"},"description":{"description":"用户描述。","maxLength":255,"minLength":0,"type":"string"},"disabled":{"description":"账户是否禁用,true表示被禁用,false表示未禁用。","type":"boolean"},"enable_change_password":{"description":"是否允许修改密码,true表示允许,false表示不允许。","type":"boolean"},"enterprise_project_id":{"description":"企业项目ID","maxLength":255,"minLength":0,"type":"string"},"group_names":{"description":"加入的组列表。","items":{"maxLength":255,"minLength":0,"type":"string"},"maxItems":50,"minItems":1,"type":"array"},"id":{"description":"用户ID。","maxLength":255,"minLength":0,"type":"string"},"is_pre_user":{"description":"是不是预创建的用户。","type":"boolean"},"locked":{"description":"账户是否被锁定,true表示被锁定,false表示未锁定。","type":"boolean"},"next_login_change_password":{"description":"下次登录是否需要重置密码,true表示需要重置密码,false表示不需要。","type":"boolean"},"password_never_expired":{"description":"密码是否永不过期,true表示密码永不过期,false表示密码会过期。","type":"boolean"},"share_space_desktops":{"description":"用户已绑定协同桌面数。","format":"int32","maximum":100,"minimum":0,"type":"integer"},"share_space_subscription":{"description":"用户是否订阅协同,true表示已订阅,false表示未订阅。","type":"boolean"},"sid":{"description":"用户ID。","maxLength":255,"minLength":0,"type":"string"},"total_desktops":{"description":"用户绑定桌面云总数。","format":"int32","maximum":55,"minimum":1,"type":"integer"},"user_email":{"description":"用户邮箱。","maxLength":64,"minLength":0,"pattern":"^((([0-9a-zA-Z_]+)|([0-9a-zA-Z]+[_.0-9a-zA-Z-]*[0-9a-zA-Z]+))@([a-zA-Z0-9-_]+[.])+[a-zA-Z0-9]+)$","type":"string"},"user_info_map":{"description":"用户信息映射,包含用户的服务等级、操作模式和类型。","maxLength":255,"minLength":0,"type":"string"},"user_name":{"description":"桌面用户名。","maxLength":55,"minLength":0,"type":"string"},"user_phone":{"description":"手机号。","maxLength":20,"minLength":0,"type":"string"}}},"Volume":{"description":"磁盘。","properties":{"size":{"description":"磁盘容量,单位GB。系统盘大小范围[80-32760],数据盘范围[10-32760],大小为10的倍数。","maximum":32760,"minimum":10,"type":"integer"},"type":{"description":"桌面数据盘对应的磁盘类型,需要与系统所提供的磁盘类型相匹配。\n\n-SAS:高IO。\n-SSD:超高IO。\n-GPSSD:通用型SSD。","maxLength":255,"minLength":1,"type":"string"}},"required":["size","type"]},"VolumeInfo":{"description":"磁盘信息。","properties":{"id":{"description":"批量操作磁盘的磁盘集合id。","maxLength":255,"minLength":1,"type":"string"},"resource_spec_code":{"description":"规格。","maxLength":255,"minLength":0,"type":"string"},"size":{"description":"磁盘容量,单位GB。","maximum":8200,"minimum":0,"type":"integer"},"type":{"description":"桌面数据盘对应的磁盘类型,需要与系统所提供的磁盘类型相匹配。\n- SAS:高IO。\n- SSD:超高IO。","maxLength":255,"minLength":1,"type":"string"}},"required":["size","type"]}},"description":null,"group_id":"7383c32d5d5e4d0481c071faeb994404","host":"workspace.cn-north-4.myhuaweicloud.com","id":"08100350b727481fb5aac370028a21ce","info_version":"v2","method":"post","name":"CreateOrder","parameters":{},"paths":{"/v2/{project_id}/periodic/subscribe/order":{"post":{"description":"包周期资源(桌面、磁盘)下订单。","operationId":"CreateOrder","parameters":[{"description":"项目ID。","in":"path","maxLength":255,"minLength":1,"name":"project_id","required":true,"type":"string","x-annotations":"@Size(max = 255, min = 1)","x-example":"2b31ed520xxxxxxebedb6e57xxxxxxxx"},{"description":"创建订单请求体。","in":"body","name":"CreateOrderRequestBody","required":true,"schema":{"$ref":"#/definitions/CreateOrderReq"}},{"description":"用户Token。\n\n通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","maxLength":40000,"minLength":1,"name":"X-Auth-Token","required":false,"type":"string","x-annotations":"@Size(max = 40000, min = 1)","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX...","x-is-registered":"N"},{"description":"发送的实体的MIME类型。","in":"header","maxLength":255,"minLength":1,"name":"Content-Type","required":false,"type":"string","x-annotations":"@Size(max = 255, min = 1)","x-example":"application/json"}],"produces":["application/json"],"responses":{"200":{"description":"CBC下订单响应体。","examples":{"application/json":{"order_id":"CS2108102036B2CAI"}},"schema":{"$ref":"#/definitions/CreateOrderRsp"}},"400":{"description":"由于包含语法错误,当前请求无法被服务器理解。","schema":{"$ref":"#/definitions/BaseResponse"}},"500":{"description":"服务内部错误,具体返回错误码请参见错误码说明。","schema":{"$ref":"#/definitions/BaseResponse"}}},"summary":"包周期下单","tags":["Order"],"x-api-type":"open-api","x-apiexplorer-hide":"N","x-apig-group":"public,internal_token","x-apigateway-request-type":"public","x-imports":["com.huawei.workspace.auth.iam5.WksDependIamAuthMeta","com.huawei.clouds.wushan.auth.token.IamAuthMeta","com.huawei.clouds.wushan.auth.token.IamAuthLevel","com.huawei.clouds.wushan.integration.common.auth.EnableAuth","com.huawei.clouds.wushan.cts.meta.CtsMeta"],"x-is-registered":"Y","x-methodAnnotations":["@EnableAuth","@WksDependIamAuthMeta(resourceParamSpEL = {\"USER:name:resources.![subscribeUserSharer.users.![userName]]\"})","@IamAuthMeta(authLevel = IamAuthLevel.PROJECT, abacAction = \"workspace:orders:create\",  needApigwJwtAuthCheck = false, needRbacCheck = false, authContextInitializerName = \"createOrdersAuthContextInitializer\")","@CtsMeta(serviceType = \"Workspace\", resourceType = \"workspace\", traceName = \"createOrder\")"],"x-request-examples-1":{"enterprise_project_id":"0","resources":[{"add_volumes":{"desktop_id":"8d049b4e-4f1e-4ed5-b3a9-a7f0f15658a7","volumes":[{"size":50,"type":"SAS"}]}}],"type":"addVolumes"},"x-request-examples-2":{"enterprise_project_id":"0","resources":[{"create_desktops":{"desktop_type":"DEDICATED","desktops":[{"user_email":"test@test.com","user_group":"sudo","user_name":"test"}],"email_notification":false,"image_id":"e1d65e11-861c-459d-a3a8-ab150d79befc","image_type":"private","nics":[{"subnet_id":"197c1aa4-2611-48bd-a3af-ac4ce2c17c4c"}],"product_id":"workspace.k.xlarge2.uosv20pro","root_volume":{"size":80,"type":"SAS"},"tags":[{"key":"aa","value":"bb"}]},"period_num":1,"period_type":2}],"type":"createDesktops"},"x-request-examples-text-1":{"enterprise_project_id":"0","resources":[{"add_volumes":{"desktop_id":"8d049b4e-4f1e-4ed5-b3a9-a7f0f15658a7","volumes":[{"size":50,"type":"SAS"}]}}],"type":"addVolumes"},"x-request-examples-text-2":{"enterprise_project_id":"0","resources":[{"create_desktops":{"desktop_type":"DEDICATED","desktops":[{"user_email":"test@test.com","user_group":"sudo","user_name":"test"}],"email_notification":false,"image_id":"e1d65e11-861c-459d-a3a8-ab150d79befc","image_type":"private","nics":[{"subnet_id":"197c1aa4-2611-48bd-a3af-ac4ce2c17c4c"}],"product_id":"workspace.k.xlarge2.uosv20pro","root_volume":{"size":80,"type":"SAS"},"tags":[{"key":"aa","value":"bb"}]},"period_num":1,"period_type":2}],"type":"createDesktops"},"x-request-examples-url-1":"POST /v2/0bec5db98280d2d02fd6c00c2de791ce/periodic/subscribe/order","x-request-examples-url-2":"POST /v2/0bec5db98280d2d02fd6c00c2de791ce/periodic/subscribe/order","x-request-examples-x-request-examples-description-1":"磁盘下单请求参数。","x-request-examples-x-request-examples-description-2":"创建桌面订单。","x-support-isv":"ZR,ZQ","x-support-sdk":"Y"}}},"product_short":"Workspace","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":{"apig-auth-app":{"in":"header","name":"Authorization","type":"apiKey","x-apigateway-auth-type":"AppSigv1"},"apig-auth-iam":{"in":"header","name":"unused","type":"apiKey","x-apigateway-auth-type":"IAM"},"apig-auth-iam-used-authn5":{"in":"header","name":"unused","type":"apiKey","x-apigateway-auth-opt":{"inner-auth-type":"iam_auth_n5"},"x-apigateway-auth-type":"IAM"}},"summary":"包周期下单","tags":"订单","uri":null,"version":"2.0"}