{"base_path":null,"components":null,"consumes":"[\"application/json\"]","definitions":{"AttachInstancesUserInfo":{"description":"分配桌面用户信息。","properties":{"user_group":{"description":"桌面用户所属的用户组。\n- sudo:Linux管理员组。\n- default:Linux默认用户组。\n- administrators:Windows管理员组。管理员拥有对该桌面的完全访问权,可以做任何需要的更改(禁用操作除外)。\n- users:Windows标准用户组。标准用户可以使用大多数软件,并可以更改不影响其他用户的系统设置。","maxLength":255,"minLength":1,"type":"string"},"user_id":{"description":"用户id","maxLength":255,"minLength":1,"type":"string"},"user_name":{"description":"桌面所属的用户,当桌面分配成功后此用户可以登录该桌面。只允许输入大写字母、小写字母、数字、中划线(-)和下划线(_)。域类型为LITE_AD时,使用小写字母或者大写字母开头,长度范围为[1-20]。当域类型为LOCAL_AD时,用户名可以使用小写字母或者大写字母或者数字开头,长度范围为[1-20]。","maxLength":20,"minLength":1,"type":"string","x-isSensitive":true}}},"BaseResponse":{"description":"API响应基类","properties":{"error_code":{"description":"错误码。","maxLength":12,"minLength":0,"type":"string"},"error_msg":{"description":"错误描述。","maxLength":1000,"minLength":0,"type":"string"}}},"DescribeDesktopsResponse":{"properties":{"desktops":{"description":"桌面信息。","items":{"$ref":"#/definitions/SimpleDesktopInfo"},"maxItems":2000,"minItems":0,"type":"array","x-is-registered":"Y","x-maxLength":2000,"x-minLength":0},"total_count":{"description":"总数。","format":"int32","maximum":2000,"minimum":0,"type":"integer","x-is-registered":"Y"}}},"SimpleDesktopInfo":{"properties":{"attach_user_infos":{"description":"桌面已分配的用户信息列表。","items":{"$ref":"#/definitions/AttachInstancesUserInfo"},"readOnly":true,"type":"array"},"computer_name":{"description":"桌面名。","maxLength":55,"minLength":1,"type":"string"},"created":{"description":"创建时间。","maxLength":55,"minLength":1,"type":"string"},"desktop_id":{"description":"桌面ID。","maxLength":255,"minLength":1,"type":"string"},"enterprise_project_id":{"description":"企业项目ID","maxLength":36,"minLength":0,"type":"string"},"in_maintenance_mode":{"description":"是否处于管理员维护模式","type":"boolean"},"ip_address":{"description":"桌面ip地址。","maxLength":255,"minLength":1,"type":"string"},"ou_name":{"description":"ou名称。","maxLength":55,"minLength":1,"type":"string"},"sid":{"description":"桌面的SID信息。","maxLength":55,"minLength":1,"type":"string"},"user_group":{"description":"权限组。","maxLength":55,"minLength":1,"type":"string"},"user_name":{"description":"用户名。","maxLength":55,"minLength":1,"type":"string"}}}},"description":null,"group_id":"7383c32d5d5e4d0481c071faeb994404","host":"workspace.cn-north-4.myhuaweicloud.com","id":"3b41b9432556478396964186daaa4c2a","info_version":"v2","method":"get","name":"ListDesktops","parameters":{},"paths":{"/v2/{project_id}/desktops":{"get":{"description":"该接口用于查询桌面虚拟机列表。","operationId":"ListDesktops","parameters":[{"description":"用户Token。\n\n通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","maxLength":15000,"minLength":1,"name":"X-Auth-Token","required":true,"type":"string","x-annotations":"@Size(max = 15000, 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"},{"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":"query","maxLength":255,"minLength":0,"name":"user_name","required":false,"type":"string"},{"description":"桌面名。","in":"query","maxLength":255,"minLength":0,"name":"computer_name","required":false,"type":"string"},{"description":"桌面IP地址。","in":"query","maxLength":255,"minLength":0,"name":"desktop_ip","required":false,"type":"string"},{"description":"用于分页查询,查询的起始记录序号,从0开始。","in":"query","maximum":2147483647,"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":"桌面池ID,多个桌面池ID用逗号隔开。","in":"query","maxLength":255,"minLength":0,"name":"pool_id","required":false,"type":"string"},{"description":"企业项目ID","in":"query","maxLength":36,"minLength":0,"name":"enterprise_project_id","pattern":"^[a-zA-Z0-9_-]+$","required":false,"type":"string"},{"description":"桌面类型,为空时查所有桌面。查询多个类型时用,隔开。\n- DEDICATED:普通桌面,包括专享桌面、专属桌面等。\n- SHARED: 多用户共享桌面。","in":"query","maxLength":255,"minLength":0,"name":"desktop_type","required":false,"type":"string"}],"responses":{"200":{"description":"查询云桌面列表响应","examples":{"application/json":{"desktops":[{"computer_name":"ZRYUAN107","created":"2022-02-23 04:02:07","desktop_id":"a6f6e2d1-cc62-46f3-865b-9ae6ae0afde0","in_maintenance_mode":false,"ip_address":"10.0.9.25","sid":"3db90102-d11d-4d13-9a96-104696d3c6a3","user_group":"administrators","user_name":"zryuan1"},{"computer_name":"CHENYC01","created":"2022-02-22 12:14:59","desktop_id":"248077ea-bb64-4e58-b5e8-6b686600920e","in_maintenance_mode":true,"ip_address":"10.0.9.103","sid":"352cf09d-ee15-4ef1-aa49-8d673972b4e6","user_group":"administrators","user_name":"chenyc"}],"total_count":2}},"schema":{"$ref":"#/definitions/DescribeDesktopsResponse"}},"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":["Desktop"],"x-apiexplorer-hide":"N","x-apig-group":"public,internal_token","x-apigateway-request-type":"public","x-is-registered":"Y","x-request-examples-url-1":"/v2/bcae3e673fd04716a3b9dacdf58ca336/desktops","x-support-sdk":"Y"}}},"product_short":"Workspace","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询桌面列表","tags":"桌面","uri":null,"version":"2.0"}