huawei-cloud-api-definitions-Workspace 0.1.20250711

{"base_path":null,"components":null,"consumes":"[\"application/json\"]","definitions":{"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":{"error_code":{"description":"错误码。","maxLength":12,"minLength":0,"type":"string"},"error_msg":{"description":"错误描述。","maxLength":1000,"minLength":0,"type":"string"}}},"DescribeDesktopPoolsResponse":{"properties":{"desktop_pools":{"description":"桌面池信息。","items":{"$ref":"#/definitions/SimpleDesktopPoolInfo"},"readOnly":true,"type":"array"},"total_count":{"description":"总数。","readOnly":true,"type":"integer"}}},"ProductInfo":{"properties":{"architecture":{"description":"产品架构,当前支持:arm、x86。","maxLength":255,"minLength":1,"type":"string"},"bill_switch":{"default":"on","description":"话单开关,默认on,on-出话单模式,off-关话单模式,只支持反序列化,不支持序列化,不在接口中展示。","maxLength":255,"minLength":0,"type":"string"},"charge_mode":{"description":"周期套餐标识。0表示包周期,1表示按需。","maxLength":2,"minLength":0,"type":"string"},"cloud_service_type":{"description":"云服务编码。","maxLength":255,"minLength":0,"type":"string"},"contain_data_disk":{"description":"套餐计费是否包含了数据盘,off-不包含。","type":"boolean"},"cpu":{"description":"cpu。","maxLength":255,"minLength":1,"type":"string"},"cpu_desc":{"description":"cpu描述。","maxLength":255,"minLength":0,"type":"string"},"data_disk_size":{"default":"80","description":"数据盘大小,单位GB。","maxLength":255,"minLength":0,"type":"string"},"default_desktop_num":{"description":"专享主机套餐默认的桌面数。","maximum":100,"minimum":0,"type":"integer"},"descriptions":{"description":"产品描述。","maxLength":255,"minLength":1,"type":"string"},"domain_ids":{"description":"该产品套餐支持的专有域id(domainId)。","items":{"maxLength":255,"minLength":0,"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"flavor_id":{"description":"规格ID。","maxLength":255,"minLength":1,"type":"string"},"gpu_desc":{"description":"GPU描述。","maxLength":255,"minLength":0,"type":"string"},"is_gpu":{"description":"是否是GPU类型的规格。","type":"boolean"},"max_apply_desktop_num":{"description":"专享主机支持创建的最大桌面数。","maximum":100,"minimum":0,"type":"integer"},"memory":{"description":"内存。","maxLength":255,"minLength":1,"type":"string"},"product_id":{"description":"产品id。","maxLength":255,"minLength":1,"type":"string"},"resource_type":{"description":"资源规格。","maxLength":255,"minLength":0,"type":"string"},"status":{"default":"normal","description":"产品状态,normal:正常、sellout:售空、abandon:下线。","maxLength":255,"minLength":0,"type":"string"},"sub_product_list":{"description":"专属主机的子产品。","items":{"maxLength":255,"minLength":0,"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"system_disk_size":{"default":"80","description":"系统盘大小,单位GB。","maxLength":255,"minLength":0,"type":"string"},"system_disk_type":{"default":"SAS","description":"系统盘类型。","maxLength":255,"minLength":0,"type":"string"},"type":{"description":"产品类型。取值为:\nBASE:表示产品基础套餐,套餐镜像中不包括除操作系统之外的其他商业软件,私有镜像场景只能使用此类套餐。","maxLength":55,"minLength":1,"type":"string"},"volume_product_type":{"description":"磁盘产品类型。","maxLength":255,"minLength":0,"type":"string"}}},"SecurityGroup":{"description":"安全组。","properties":{"id":{"description":"安全组ID。","maxLength":255,"minLength":0,"type":"string"},"name":{"description":"安全组名称。","maxLength":55,"minLength":0,"type":"string"}},"required":["id"]},"SimpleDesktopPoolInfo":{"properties":{"autoscale_policy":{"$ref":"#/definitions/AutoscalePolicy","readOnly":true},"availability_zone":{"description":"可用区。","readOnly":true,"type":"string"},"charging_mode":{"description":"计费模式,0:包周期,1:按需。","readOnly":true,"type":"string"},"created_time":{"description":"创建时间,格式为:UTC格式,例如“2022-05-11T11:45:42.000Z”。","readOnly":true,"type":"string"},"data_volumes":{"description":"数据盘列表。","items":{"$ref":"#/definitions/VolumeInfo"},"readOnly":true,"type":"array"},"description":{"description":"桌面池描述。","readOnly":true,"type":"string"},"desktop_count":{"description":"桌面池总桌面数量。","readOnly":true,"type":"integer"},"desktop_name_policy_id":{"description":"策略id,用于指定生成桌面名称策略。","readOnly":true,"type":"string"},"desktop_used":{"description":"桌面池绑定用户的桌面个数。","readOnly":true,"type":"integer"},"disconnected_retention_period":{"description":"动态池桌面断连多少分钟内,保留用户与桌面的绑定关系,超时后自动解绑。","readOnly":true,"type":"integer"},"enable_autoscale":{"description":"桌面池是否开启弹性伸缩类型,为false则表示不开启弹性伸缩,为true则表示开启弹性伸缩。","readOnly":true,"type":"boolean"},"enterprise_project_id":{"description":"企业项目ID","maxLength":36,"minLength":0,"type":"string"},"id":{"description":"桌面池ID。","readOnly":true,"type":"string"},"image_id":{"description":"镜像ID。","readOnly":true,"type":"string"},"image_name":{"description":"镜像名称。","readOnly":true,"type":"string"},"image_os_platform":{"description":"镜像OS平台。","readOnly":true,"type":"string"},"image_os_type":{"description":"镜像OS类型。","readOnly":true,"type":"string"},"image_os_version":{"description":"镜像OS版本。","readOnly":true,"type":"string"},"image_product_code":{"description":"镜像的productCode(specCode)。","readOnly":true,"type":"string"},"in_maintenance_mode":{"description":"桌面池是否处于管理员维护模式","type":"boolean"},"name":{"description":"桌面池名称。","readOnly":true,"type":"string"},"on_demand_desktop_num":{"description":"桌面池按需桌面个数(不包含删除中的桌面)。","readOnly":true,"type":"integer","x-is_inner_param":"True"},"product":{"$ref":"#/definitions/ProductInfo","description":"产品信息。"},"root_volume":{"$ref":"#/definitions/VolumeInfo","description":"系统盘。"},"security_groups":{"description":"桌面安全组。","items":{"$ref":"#/definitions/SecurityGroup"},"readOnly":true,"type":"array"},"status":{"description":"桌面池状态。\n- STEADY:稳态\n- TEMPORARY:临时态\n- EXIST_FROZEN:存在冻结桌面\n- UNKNOWN:未知态","readOnly":true,"type":"string"},"subnet_id":{"description":"子网ID。","readOnly":true,"type":"string"},"type":{"description":"桌面池类型。DYNAMIC:动态池,STATIC:静态池。","readOnly":true,"type":"string"}}},"VolumeInfo":{"description":"磁盘信息。","properties":{"cluster_id":{"description":"云服务器系统盘对应的存储池的ID。","maxLength":255,"minLength":0,"type":"string","x-is_inner_param":"True"},"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":["type","size"]}},"description":null,"group_id":"7383c32d5d5e4d0481c071faeb994404","host":"workspace.cn-north-4.myhuaweicloud.com","id":"e80f2a8659b94de5b2301efbe4193a62","info_version":"v2","method":"get","name":"ListDesktopPools","parameters":{"X-Auth-Token":{"description":"用户Token。\n\n通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","maxLength":40000,"minLength":1,"name":"X-Auth-Token","required":true,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..."},"project_id":{"description":"项目ID。","in":"path","maxLength":255,"minLength":1,"name":"project_id","required":true,"type":"string","x-example":"2b31ed520xxxxxxebedb6e57xxxxxxxx"}},"paths":{"/v2/{project_id}/desktop-pools":{"get":{"description":"该接口用于查询桌面池列表。","operationId":"ListDesktopPools","parameters":[{"$ref":"#/parameters/X-Auth-Token"},{"$ref":"#/parameters/project_id"},{"description":"桌面池名称。","in":"query","maxLength":255,"minLength":0,"name":"name","required":false,"type":"string"},{"description":"桌面池类型,DYNAMIC:动态池,STATIC:静态池。","in":"query","maxLength":255,"minLength":0,"name":"type","required":false,"type":"string"},{"description":"企业项目ID","in":"query","maxLength":36,"minLength":0,"name":"enterprise_project_id","pattern":"^[a-zA-Z0-9_-]+$","type":"string"},{"description":"用于分页查询,查询的起始记录序号,从0开始。","in":"query","maximum":20000,"minimum":0,"name":"offset","required":false,"type":"integer"},{"default":1000,"description":"用于分页查询,取值范围0-1000,默认值1000。","in":"query","maximum":1000,"minimum":0,"name":"limit","required":false,"type":"integer"},{"description":"按照维护状态过滤","in":"query","name":"in_maintenance_mode","required":false,"type":"boolean"}],"responses":{"200":{"description":"查询桌面池列表响应","examples":{"application/json":{"desktop_pools":[{"availability_zone":"cn-north-4a","created_time":"2023-01-04T07:10:56.696Z","id":"ca689892-25f2-4c68-88cb-56be3565f3f5","name":"POOL1","product":{"architecture":"x86","charge_mode":"1","cloud_service_type":"hws.service.type.vdi","contain_data_disk":false,"cpu":"2","descriptions":"尊享办公|2核|4GB内存","flavor_id":"s6.large.2","is_gpu":false,"memory":"4096","package_type":"ultimate","product_id":"workspace.x86.ultimate.large2","resource_type":"hws.resource.type.workspace.desktop","status":"normal","sub_product_list":[],"system_disk_size":"80","system_disk_type":"SAS","type":"BASE","volume_product_type":"workspace"},"root_volume":{"cluster_id":"","size":80,"type":"SAS"},"type":"STATIC"},{"availability_zone":"cn-north-4b","created_time":"2023-01-04T07:10:53.554Z","data_volumes":[{"cluster_id":"","size":80,"type":"SAS"},{"cluster_id":"","size":80,"type":"SAS"}],"id":"2c2be3fb-0013-48d5-a081-0731f3473997","name":"POOL2","product":{"architecture":"x86","charge_mode":"1","cloud_service_type":"hws.service.type.vdi","contain_data_disk":false,"cpu":"2","descriptions":"尊享办公|2核|4GB内存","flavor_id":"s6.large.2","is_gpu":false,"memory":"4096","package_type":"ultimate","product_id":"workspace.x86.ultimate.large2","resource_type":"hws.resource.type.workspace.desktop","status":"normal","sub_product_list":[],"system_disk_size":"80","system_disk_type":"SAS","type":"BASE","volume_product_type":"workspace"},"root_volume":{"cluster_id":"","size":80,"type":"SAS"},"type":"DEDICATED"}],"total_count":2}},"schema":{"$ref":"#/definitions/DescribeDesktopPoolsResponse"}},"400":{"description":"由于包含语法错误,当前请求无法被服务器理解。","schema":{"$ref":"#/definitions/BaseResponse"}},"401":{"description":"鉴权失败。","schema":{"$ref":"#/definitions/BaseResponse"}},"403":{"description":"没有操作权限。","schema":{"$ref":"#/definitions/BaseResponse"}},"404":{"description":"找不到资源。","schema":{"$ref":"#/definitions/BaseResponse"}},"500":{"description":"服务内部错误,具体返回错误码请参见错误码说明。","schema":{"$ref":"#/definitions/BaseResponse"}}},"schemes":["https"],"summary":"查询桌面池列表","tags":["DesktopPool"],"x-apiexplorer-hide":"N","x-apig-group":"public,internal_token,internal_appcode","x-apigateway-request-type":"public","x-is-registered":"Y","x-methodAnnotations":["@EnableAuth","@WksIamAuthMeta(operationType=OperationType.LIST, resourceType=ResourceType.DESKTOP_POOL)","@IamAuthMeta(authLevel = IamAuthLevel.INSTANCE_LIST, abacAction = \"workspace:desktopPools:list\",  needApigwJwtAuthCheck = false, authContextInitializerName = \"workspaceListAuthContextInitializer\", needRbacCheck = false, needAbacResourceCheck = true)","@CtsMeta(serviceType = \"Workspace\", resourceType = \"workspace\", traceName = \"listDesktopPools\")"],"x-request-examples-url-1":"/v2/bcae3e673fd04716a3b9dacdf58ca336/desktop-pools","x-support-sdk":"Y"}}},"product_short":"Workspace","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询桌面池列表","tags":"桌面池","uri":null,"version":"2.0"}