huawei-cloud-api-definitions-Workspace 0.1.20250711

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":null,"components":null,"consumes":"[\"application/json\"]","definitions":{"BaseResponse":{"description":"API响应基类","properties":{"error_code":{"description":"错误码。","maxLength":12,"minLength":0,"type":"string"},"error_msg":{"description":"错误描述。","maxLength":1000,"minLength":0,"type":"string"}}},"User":{"properties":{"account_expired":{"description":"帐号是否过期,true表示已过期,false表示未过期。","type":"boolean"},"account_expires":{"description":"账户过期时间,0表示永远不过期。","maxLength":55,"minLength":1,"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":1,"type":"string"},"disabled":{"description":"账户是否禁用,true表示被禁用,false表示未禁用。","type":"boolean"},"enable_change_password":{"description":"是否允许修改密码,true表示允许,false表示不允许。","type":"boolean"},"id":{"description":"用户ID。","maxLength":255,"minLength":1,"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"},"total_desktops":{"description":"用户绑定桌面云总数。","format":"int32","maximum":55,"minimum":1,"type":"integer"},"user_email":{"description":"用户邮箱。","maxLength":55,"minLength":1,"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_name":{"description":"桌面用户名。","maxLength":55,"minLength":1,"type":"string"},"user_phone":{"description":"手机号。","maxLength":20,"minLength":1,"type":"string"}}},"UserListResponse":{"properties":{"total_count":{"description":"用户总数。","format":"int32","readOnly":true,"type":"integer"},"users":{"description":"用户列表。","items":{"$ref":"#/definitions/User"},"readOnly":true,"type":"array"}}}},"description":null,"group_id":"7383c32d5d5e4d0481c071faeb994404","host":"workspace.cn-north-4.myhuaweicloud.com","id":"dfe0842234e042bbba7f66280043ce46","info_version":"v2","method":"get","name":"ListUsers","parameters":{},"paths":{"/v2/{project_id}/users":{"get":{"description":"该接口用于查询桌面用户列表。","operationId":"ListUsers","parameters":[{"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..."},{"description":"发送的实体的MIME类型,如:application/json。","in":"header","maxLength":255,"minLength":1,"name":"Content-Type","required":true,"type":"string","x-example":"application/json"},{"description":"项目ID。","in":"path","maxLength":255,"minLength":1,"name":"project_id","required":true,"type":"string","x-example":"2b31ed520xxxxxxebedb6e57xxxxxxxx"},{"description":"桌面用户名,长度范围为1-20,不能包含特殊字符,不能以数字开头。","in":"query","maxLength":255,"minLength":0,"name":"user_name","required":false,"type":"string"},{"description":"用于分页查询,返回用户数量限制。如果不指定,则返回所有符合条件的用户。","in":"query","maxLength":255,"minLength":0,"name":"limit","required":false,"type":"string"},{"description":"分页查询起始条数。","in":"query","maxLength":255,"minLength":0,"name":"offset","required":false,"type":"string"},{"description":"用户描述查询,模糊匹配。","in":"query","maxLength":100,"minLength":0,"name":"description","pattern":"[  一-龥a-zA-Z\\d._~!@*()=;:',??,【】、。!;()-]{0,100}","required":false,"type":"string"},{"description":"激活类型,默认为用户激活。\n* USER_ACTIVATE: 用户激活\n* ADMIN_ACTIVATE: 管理员激活","in":"query","maxLength":40,"minLength":0,"name":"active_type","required":false,"type":"string"},{"description":"桌面用户组名,精确匹配。","in":"query","maxLength":64,"minLength":0,"name":"group_name","required":false,"type":"string"}],"responses":{"200":{"description":"查询桌面云用户列表响应。","examples":{"application/json":{"total_count":2,"users":[{"account_expires":"0","disabled":false,"enable_change_password":true,"id":"8a2c3f9579d240820179d51e6caf0001","locked":false,"next_login_change_password":true,"total_desktops":0,"user_email":"test@huawei.com","user_name":"api-test"},{"account_expires":"0","disabled":false,"enable_change_password":true,"id":"8a2c3f9579d240820179d51e6caf0002","locked":false,"next_login_change_password":true,"total_desktops":0,"user_email":"test@huawei.com","user_name":"api-test2"}]}},"schema":{"$ref":"#/definitions/UserListResponse"}},"400":{"description":"由于包含语法错误,当前请求无法被服务器理解。","schema":{"$ref":"#/definitions/BaseResponse"}},"401":{"description":"鉴权失败。","schema":{"$ref":"#/definitions/BaseResponse"}},"403":{"description":"没有操作权限。","schema":{"$ref":"#/definitions/BaseResponse"}},"404":{"description":"找不到资源。","schema":{"$ref":"#/definitions/BaseResponse"}},"405":{"description":"请求中指定的方法不被允许。","schema":{"$ref":"#/definitions/BaseResponse"}},"500":{"description":"服务内部错误,具体返回错误码请参见错误码说明。","schema":{"$ref":"#/definitions/BaseResponse"}},"503":{"description":"服务不可用。","schema":{"$ref":"#/definitions/BaseResponse"}}},"schemes":["https"],"summary":"查询用户列表","tags":["User"],"x-apiexplorer-hide":"N","x-apig-group":"public,internal_token,internal_appcode","x-apigateway-request-type":"public","x-is-registered":"Y","x-request-examples-url-1":"GET /v2/0bec5db98280d2d02fd6c00c2de791ce/users?limit=10","x-support-sdk":"Y"}}},"product_short":"Workspace","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询用户列表","tags":"用户","uri":null,"version":"2.0"}