{"base_path":null,"components":null,"consumes":"[\"application/json\"]","definitions":{"AppTypeEnum":{"description":"服务器组应用类型:\n* `SESSION_DESKTOP_APP` - 会话桌面app\n* `COMMON_APP` - 普通app","enum":["SESSION_DESKTOP_APP","COMMON_APP"],"example":"SESSION_DESKTOP_APP","type":"string"},"BaseServerGroup":{"description":"服务器组。","properties":{"app_type":{"$ref":"#/definitions/AppTypeEnum","readOnly":true},"create_time":{"description":"服务器组创建时间。","example":"2022-03-07T10:40:43.858Z","format":"date-time","readOnly":true,"type":"string"},"description":{"default":"","description":"服务器组描述。","example":"XXX公司 软件开发应用服务器组","readOnly":true,"type":"string"},"enterprise_project_id":{"description":"企业项目ID(0表示默认企业项目Id)。","example":"0","readOnly":true,"type":"string"},"extra_session_size":{"description":"付费会话个数。","example":1,"readOnly":true,"type":"integer"},"extra_session_type":{"$ref":"#/definitions/ExtraSessionTypeEnum","readOnly":true},"id":{"description":"服务器组的唯一标识。","example":"1","readOnly":true,"type":"string"},"image_id":{"default":"","description":"服务器组关联的镜像ID,用于创建对应组下的云服务器。","example":"a6ea73e0-9f4b-11ec-b909-0242ac120002","readOnly":true,"type":"string"},"is_vdi":{"default":false,"description":"是否为vdi单会话模式。","example":false,"readOnly":true,"type":"boolean"},"name":{"description":"服务器组名称。","example":"流程开发应用服务器组","readOnly":true,"type":"string"},"os_type":{"$ref":"#/definitions/OsTypeEnum","readOnly":true},"primary_server_group_ids":{"description":"主服务器组id列表。","items":{"type":"string"},"readOnly":true,"type":"array"},"product_id":{"description":"产品id。","example":"workspace.x86.general.xlarge2","readOnly":true,"type":"string"},"secondary_server_group_ids":{"description":"备服务器组id列表。","items":{"type":"string"},"readOnly":true,"type":"array"},"server_group_status":{"description":"服务器是否处于启用状态,true表示处于启用状态 false表示处于禁用状态。","example":false,"readOnly":true,"type":"boolean"},"site_id":{"description":"站点id。","example":"ae985216-83fa-46b6-ab03-a36dcb3dd05a","readOnly":true,"type":"string"},"site_type":{"description":"站点类型 - CENTER/IES。","example":"CENTER","readOnly":true,"type":"string"},"storage_mount_policy":{"$ref":"#/definitions/StorageFolderMountType"},"subnet_id":{"description":"网卡对应的子网ID。","example":"0ddf778f-c0fe-4717-9251-001caee7c95e","readOnly":true,"type":"string"},"system_disk_size":{"description":"磁盘容量,单位GB。","example":10,"readOnly":true,"type":"integer"},"system_disk_type":{"$ref":"#/definitions/VolumeType","readOnly":true},"update_time":{"description":"服务器组更新时间。","example":"2022-03-07T10:40:43.858Z","format":"date-time","readOnly":true,"type":"string"}}},"ErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00169901","maxLength":16,"minLength":1,"type":"string"},"error_msg":{"description":"错误描述。","example":"The request message is invalid.","maxLength":255,"minLength":1,"type":"string"}}},"ExtraSessionTypeEnum":{"description":"付费会话类型\n* `GPU` - GPU规格会话\n* `CPU` - 普通CPU规格会话","enum":["GPU","CPU"],"example":"CPU","type":"string"},"ListServerGroupResp":{"allOf":[{"$ref":"#/definitions/PageResp"},{"properties":{"items":{"description":"服务器组列表,返回列表条目数量上限为分页的最大上限值。","items":{"$ref":"#/definitions/ServerGroup"},"readOnly":true,"type":"array"}},"type":"object"}],"description":"查询服务器组响应。"},"OsTypeEnum":{"description":"系统类型,当前仅支持Windows。\n* `Linux` -\n* `Windows` -\n* `Other` -","enum":["Linux","Windows","Other"],"example":"windows","type":"string"},"PageResp":{"description":"API列表查询响应。\n\n**⚠ 警告: 此Model不生成java代码,允许其它Model中引用,请勿直接作为Model使用。**","properties":{"count":{"description":"总数。","example":0,"maximum":2147483647,"minimum":0,"type":"integer"}}},"ProductInfo":{"properties":{"architecture":{"description":"产品架构,当前仅支持x86。\n- x86\n- arm","example":"x86","maxLength":255,"minLength":1,"type":"string"},"charge_mode":{"description":"套餐标识。\n- 1:表示包周期。\n- 0:表示按需。","maxLength":1,"minLength":0,"type":"string","x-hcs-ignore":true},"cloud_service_type":{"description":"云服务类型。","example":"hws.service.type.xxxxx","maxLength":255,"minLength":0,"type":"string"},"cond_operation_az":{"description":"产品套餐在可用区的状态,配套status使用。\n> - 此参数是AZ级配置,优选取此参数的值,某个AZ没有在此参数中配置时默认使用status参数的取值。\n> - 配置格式“az(xx)”。()内为某个AZ的flavor状态,()内必须要填有状态,不填为无效配置。\n> - 例如:套餐在某个region的az0正常商用,az1售罄,az2公测,az3正常商用,其他az显示下线,可配置为:\n> - “status”设置为:“abandon” 。\n> - “cond_operation_az”设置为:“az0(normal), az1(sellout), az2(obt), az3(normal)”。 \n> - 说明:如果flavor在某个AZ下的状态与status配置状态不同,必须配置该参数。","example":"cn-north-5a(normal),cn-north-5b(abandon),cn-north-5c(sellout)","minLength":0,"type":"string"},"contain_data_disk":{"description":"套餐计费是否包含了数据盘。","example":false,"type":"boolean"},"cpu":{"description":"CPU。","example":"2","maxLength":255,"minLength":1,"type":"string"},"cpu_desc":{"description":"CPU描述。","example":"云应用通用型|4核|8GB内存","maxLength":255,"minLength":0,"type":"string"},"descriptions":{"description":"产品描述。","example":"GPU图形加速DG4型|32核128G内存32G显存|P02","maxLength":255,"minLength":1,"type":"string"},"domain_ids":{"description":"产品属于专有的domainId。","example":["xxx","xxxx"],"items":{"maxLength":255,"minLength":0,"type":"string"},"maxItems":100,"minItems":0,"type":"array","x-maxLength":100,"x-minLength":0},"expire_time":{"description":"产品套餐过期时间,产品将在该时间点后逐步下架。","example":"2022-03-07T10:40:43Z","format":"date-time","readOnly":true,"type":"string"},"flavor_id":{"description":"规格ID。","example":"c3.large.4","maxLength":255,"minLength":1,"type":"string"},"gpu_desc":{"description":"GPU描述。","example":"GPU图形加速","maxLength":255,"minLength":0,"type":"string"},"is_gpu":{"description":"是否是GPU类型的规格。","example":false,"type":"boolean"},"memory":{"description":"内存大小,单位兆:MB。","example":"4096","maxLength":255,"minLength":1,"type":"string"},"package_type":{"description":"套餐类型:\n- general:表示产品通用套餐。\n- dedicated:表示产品专属主机套餐。","example":"general","maxLength":64,"minLength":0,"type":"string"},"product_id":{"description":"产品id。","example":"workspace.appstream.general.2xlarge.4","maxLength":128,"minLength":1,"type":"string"},"resource_type":{"description":"资源类型。","example":"hws.resource.type.xxxx.vm","maxLength":255,"minLength":0,"type":"string"},"series_type":{"description":"系列类型。","example":"c6","maxLength":64,"minLength":0,"type":"string"},"sessions":{"description":"套餐默认支持的最大会话数。","example":2,"readOnly":true,"type":"integer"},"status":{"description":"产品套餐在销售模式下的状态,取值自ECS的cond:operation:status。\n不配置时等同于normal在售状态。\n* `normal` - 正常商用\n* `abandon` - 下线(即不显示)\n* `sellout` - 售罄\n* `obt` - 公测\n* `obt_sellout` - 公测售罄\n* `promotion` - 推荐(等同normal,也是商用)","maxLength":16,"minLength":0,"type":"string"},"sub_product_list":{"description":"专属主机的子产品。","example":["xxx","xxxx"],"items":{"maxLength":255,"minLength":0,"type":"string"},"maxItems":100,"minItems":0,"type":"array","x-maxLength":100,"x-minLength":0},"support_gpu_type":{"description":"产品套餐支持的GPU类型。","example":"A40","format":"支持的GPU类型","readOnly":true,"type":"string"},"system_disk_size":{"default":"80","description":"系统盘大小。","example":"80","maxLength":10,"minLength":0,"type":"string"},"system_disk_type":{"default":"SAS","description":"系统盘类型。","example":"SAS","maxLength":32,"minLength":0,"type":"string"},"type":{"description":"产品类型。\n- BASE:表示产品基础套餐,套餐镜像中不包括除操作系统之外的其他商业软件,私有镜像场景只能使用此类套餐。\n- ADVANCED:表示产品高级套餐,套餐镜像中包括了一些商业软件。","example":"BASE","maxLength":55,"minLength":1,"type":"string"},"volume_product_type":{"description":"磁盘产品类型。","example":"workspace","maxLength":255,"minLength":0,"type":"string"}},"type":"object"},"ScalingPolicy":{"description":"弹性伸缩策略。","properties":{"enable":{"default":true,"description":"是否启用策略,默认启用:\n'true': 启用\n'false': 禁用","example":true,"type":"boolean"},"max_scaling_amount":{"description":"最大扩容数量。","example":10,"maximum":100,"minimum":1,"type":"integer"},"scaling_policy_by_session":{"$ref":"#/definitions/ScalingPolicyBySession"},"single_expansion_count":{"description":"单次扩容数量。","example":1,"maximum":10,"minimum":1,"type":"integer"}},"required":["max_scaling_amount","scaling_policy_by_session","single_expansion_count"]},"ScalingPolicyBySession":{"description":"基于会话的弹性策略。","properties":{"session_usage_threshold":{"description":"分组的总会话使用率(达到该阈值后扩容)。","example":85,"maximum":100,"minimum":1,"type":"integer"},"shrink_after_session_idle_minutes":{"description":"给定时间内无会话连接的的实例进行释放。","example":60,"maximum":120,"minimum":5,"type":"integer"}},"required":["session_usage_threshold","shrink_after_session_idle_minutes"]},"ServerGroup":{"allOf":[{"$ref":"#/definitions/BaseServerGroup"},{"properties":{"app_group_count":{"description":"关联应用组的总数量。","example":1,"readOnly":true,"type":"integer"},"app_server_count":{"description":"服务器总数量。","example":1,"readOnly":true,"type":"integer"},"app_server_flavor_count":{"description":"服务器配置总数量。","example":1,"readOnly":true,"type":"integer"},"image_name":{"description":"镜像名称。","example":"Huawei cloud EulerOs 1.0 64bit","readOnly":true,"type":"string"},"ou_name":{"default":"","description":"默认组织名称。","example":"wksappusers","readOnly":true,"type":"string"},"product_info":{"$ref":"#/definitions/ProductInfo","description":"产品规格信息。","readOnly":true},"scaling_policy":{"$ref":"#/definitions/ScalingPolicy","description":"弹性伸缩策略。","readOnly":true},"subnet_name":{"description":"子网名称。","readOnly":true,"type":"string"},"tags":{"description":"标签信息。","items":{"$ref":"#/definitions/TmsTag"},"type":"array"}},"type":"object"}],"description":"分页查询分组信息。"},"StorageFolderMountType":{"description":"用户访问APS的应用时,对应NAS存储目录在APS上的挂载策略。\n* `USER` - 仅挂载个人目录。\n* `SHARE` - 仅挂载共享目录。\n* `ANY` - 挂载目录不做限制(个人和共享NAS存储目录都会自动挂载)。","enum":["USER","SHARE","ANY"],"example":"ANY","type":"string"},"TmsTag":{"description":"tms标签。","properties":{"key":{"description":"键。最大长度128个unicode字符。\n1. 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @\n2. 两头不能有空白字符","example":"demo01","pattern":"^((?!_sys_)[\\p{L}\\p{Z}\\p{N}_.:=+\\-@]{1,128})(?<!\\s)$","type":"string"},"value":{"description":"值。每个值最大长度255个unicode字符。\n1. 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @","example":"01","pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]{0,255})$","type":"string"}},"required":["key"]},"VolumeType":{"description":"磁盘类型,获取可用磁盘类型详见接口磁盘管理ListVolumeType。\n* `ESSD` - 极速型SSD\n* `SSD` - 超高IO\n* `GPSSD` - 通用型SSD\n* `SAS` - 高IO\n* `SATA` - 普通IO","enum":["ESSD","SSD","GPSSD","SAS","SATA"],"example":"SSD","type":"string"}},"description":null,"group_id":"fe7dbee2e20f4aa589be7dce935a38ad","host":"appstream.cn-north-4.myhuaweicloud.com","id":"682b72c4fd81448ab32fe686eb2bcdb6","info_version":"v1","method":"get","name":"ListServerGroups","parameters":{},"paths":{"/v1/{project_id}/app-server-groups":{"get":{"description":"查询服务器组列表。","operationId":"ListServerGroups","parameters":[{"description":"用户Token。\n通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","maxLength":2147483647,"minLength":1,"name":"X-Auth-Token","required":false,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..."},{"description":"项目唯一标识。","in":"path","maxLength":128,"minLength":1,"name":"project_id","required":true,"type":"string","x-example":"2b31ed520xxxxxxebedb6e57xxxxxxxx"},{"default":0,"description":"查询的偏移量,默认值0。","in":"query","maximum":2147483647,"minimum":0,"name":"offset","required":false,"type":"integer"},{"default":10,"description":"查询的数量,值区间[1-100],默认值10。","in":"query","maximum":100,"minimum":1,"name":"limit","required":false,"type":"integer"},{"description":"服务器组名称。","in":"query","maxLength":1024,"minLength":0,"name":"server_group_name","required":false,"type":"string","x-example":"流程开发应用服务器组"},{"description":"服务器组唯一标识。","in":"query","maxLength":128,"minLength":0,"name":"server_group_id","required":false,"type":"string","x-example":"1c873056-9f4d-11ec-b909-0242ac120002"},{"description":"应用组类型:\n* `SESSION_DESKTOP_APP` - 会话桌面app\n* `COMMON_APP` - 普通app","in":"query","name":"app_type","pattern":"^(SESSION_DESKTOP_APP|COMMON_APP)?$","required":false,"type":"string"},{"description":"查询tag字段中包含该值的服务器组。","in":"query","name":"tags","required":false,"type":"string","x-example":"key1=value1,key2=value2"},{"description":"企业项目ID(字段为空或者0表示使用默认default企业项目)。","in":"query","name":"enterprise_project_id","required":false,"type":"string","x-example":0},{"description":"是否为备服务器组,不传默认查所有:\ntrue : 是备服务器组。\nfalse: 主服务器组,默认。","in":"query","name":"is_secondary_server_group","pattern":"^(true|false)$","required":false,"type":"string","x-example":true}],"responses":{"200":{"description":"成功响应。","examples":{"application/json":{"count":1,"items":[{"app_group_count":0,"app_server_count":0,"app_server_flavor_count":0,"app_type":"COMMON_APP","create_time":"2023-06-06T14:14:36.416Z","description":"","id":"bc05da52-89df-45ba-8146-13fe3ce7c45a","image_id":"6579b42e-f345-4452-ae3a-fa0687564943","image_name":"ApiExplore_Image_01","is_vdi":false,"name":"ApiExpirezSr5_1HgOfh56","os_type":"Windows","ou_name":"","product_id":"workspace.appstream.general.xlarge.2","product_info":{"architecture":"x86","charge_mode":"0","cloud_service_type":"hws.service.type.vdi","cond_operation_az":"cn-north-7c(abandon),cn-north-7b(abandon),cn-north-7a(normal)","contain_data_disk":false,"cpu":"2","descriptions":"s2.large.2 云应用通用型|2核|4GB内存","domain_ids":[],"flavor_id":"s2.large.2","is_gpu":false,"memory":"4096","product_id":"workspace.appstream.general.xlarge.2","resource_type":"hws.resource.type.workspace.appstream","sessions":1,"status":"abandon","system_disk_size":"80","system_disk_type":"SAS","type":"BASE","volume_product_type":"workspace"},"subnet_id":"a5842cb4-5718-4b0a-8b27-3a3e9c74f977","subnet_name":"subnet-config","system_disk_size":60,"system_disk_type":"SATA","update_time":"2023-06-06T14:14:38.127Z"}]}},"schema":{"$ref":"#/definitions/ListServerGroupResp"}},"400":{"description":"由于包含语法错误,当前请求无法被服务器理解。","schema":{"$ref":"#/definitions/ErrorResp"}},"401":{"description":"鉴权失败。","schema":{"$ref":"#/definitions/ErrorResp"}},"403":{"description":"没有操作权限。","schema":{"$ref":"#/definitions/ErrorResp"}},"404":{"description":"找不到资源。","schema":{"$ref":"#/definitions/ErrorResp"}},"405":{"description":"请求中指定的方法不被允许。","schema":{"$ref":"#/definitions/ErrorResp"}},"500":{"description":"服务内部错误,具体返回错误码请参见错误码说明。","schema":{"$ref":"#/definitions/ErrorResp"}},"503":{"description":"服务不可用。","schema":{"$ref":"#/definitions/ErrorResp"}}},"schemes":["https"],"security":[{"apig-auth-iam-used-authn5":[]}],"summary":"查询服务器组列表","tags":["ServerGroup"],"x-api-type":"open-api","x-apiexplorer-hide":"N","x-apig-group":"internal,public","x-apigateway-backend":{"httpVpcEndpoints":{"description":"","method":"get","name":"wks-apsmanager-lb","path":"/v1/{project_id}/app-server-groups","scheme":"https","timeout":30000},"parameters":[{"description":"","in":"header","name":"X-Auth-Token","origin":"request","value":"X-Auth-Token"},{"description":"","in":"path","name":"project_id","origin":"request","value":"project_id"},{"description":"","in":"query","name":"limit","origin":"request","value":"limit"},{"description":"","in":"query","name":"offset","origin":"request","value":"offset"},{"description":"","in":"query","name":"server_group_name","origin":"request","value":"server_group_name"},{"description":"","in":"query","name":"server_group_id","origin":"request","value":"server_group_id"},{"description":"","in":"query","name":"app_type","origin":"request","value":"app_type"}],"type":"HTTP-VPC"},"x-apigateway-cors":false,"x-apigateway-match-mode":"NORMAL","x-apigateway-ratelimit":"workspace_default_get","x-apigateway-request-type":"public","x-is-registered":"Y","x-order":2,"x-request-examples-url-1":"GET /v1/a4da8115c9d8464ead3a38309130523f/app-server-groups?limit=10&server_group_id=bc05da52-89df-45ba-8146-13fe3ce7c45a&server_group_name=&offset=0","x-support-hcs":"Y","x-support-sdk":"Y"}}},"product_short":"WorkspaceApp","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"}