{"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"},"ListBaseServerGroupResp":{"allOf":[{"$ref":"#/definitions/PageResp"},{"properties":{"items":{"description":"服务器组列表。","items":{"$ref":"#/definitions/ServerGroupDto"},"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"}}},"ServerGroupDto":{"allOf":[{"$ref":"#/definitions/BaseServerGroup"},{"properties":{"app_group_count":{"description":"关联应用组的总数量。","example":1,"readOnly":true,"type":"integer"}},"type":"object"}],"description":"分页查询分组信息。"},"StorageFolderMountType":{"description":"用户访问APS的应用时,对应NAS存储目录在APS上的挂载策略。\n* `USER` - 仅挂载个人目录。\n* `SHARE` - 仅挂载共享目录。\n* `ANY` - 挂载目录不做限制(个人和共享NAS存储目录都会自动挂载)。","enum":["USER","SHARE","ANY"],"example":"ANY","type":"string"},"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":"3070690b8b3545f2a467d73f30f269d2","info_version":"v1","method":"get","name":"ListTenantServerGroups","parameters":{},"paths":{"/v1/{project_id}/app-server-groups/actions/list":{"get":{"description":"查询租户服务器组基础信息列表(用于创建应用组时绑定服务器组)。","operationId":"ListTenantServerGroups","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":"查询的偏移量。","in":"query","maximum":2147483647,"minimum":0,"name":"offset","required":false,"type":"integer"},{"default":10,"description":"查询的数量,值区间[1-100]。","in":"query","maximum":100,"minimum":1,"name":"limit","required":false,"type":"integer"},{"description":"服务器组名称。","in":"query","maxLength":64,"minLength":0,"name":"sever_group_name","required":false,"type":"string","x-example":"测试名称"},{"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":"是否为备服务器组,不传默认查所有:\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":0,"items":[{"app_group_count":"1","app_type":"SESSION_DESKTOP_APP","create_time":"2022-03-07T10:40:43.858Z","description":"XXX公司 软件开发应用服务器组","enterprise_project_id":"0","extra_session_size":1,"extra_session_type":"CPU","id":"1","image_id":"a6ea73e0-9f4b-11ec-b909-0242ac120002","is_vdi":false,"name":"流程开发应用服务器组","os_type":"windows","primary_server_group_ids":["string"],"product_id":"workspace.x86.general.xlarge2","secondary_server_group_ids":["string"],"server_group_status":false,"site_id":"ae985216-83fa-46b6-ab03-a36dcb3dd05a","site_type":"CENTER","storage_mount_policy":"ANY","subnet_id":"0ddf778f-c0fe-4717-9251-001caee7c95e","system_disk_size":10,"system_disk_type":"SSD","update_time":"2022-03-07T10:40:43.858Z"}]}},"schema":{"$ref":"#/definitions/ListBaseServerGroupResp"}},"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/actions/list","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":"sever_group_name","origin":"request","value":"sever_group_name"},{"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_base_get","x-apigateway-request-type":"public","x-is-registered":"N","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"}