huawei-cloud-api-definitions-Workspace 0.1.20240127

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"}}},"CreateUserRequest":{"properties":{"account_expires":{"description":"账户过期时间,0表示永远不过期。时间格式:yyyy-MM-ddTHH:mm:ssZ或yyyy-MM-ddTHH:mm:ss.SSSZ。","maxLength":55,"minLength":1,"type":"string"},"active_type":{"description":"激活类型,默认为用户激活。\n* USER_ACTIVATE: 用户激活\n* ADMIN_ACTIVATE: 管理员激活","enum":["USER_ACTIVATE","ADMIN_ACTIVATE"],"example":"ADMIN_ACTIVATE","maxLength":50,"minLength":0,"type":"string"},"alias_name":{"description":"别名。","maxLength":55,"minLength":1,"type":"string"},"description":{"description":"用户描述,字符串长度区间[0, 255]。","maxLength":255,"minLength":0,"type":"string"},"enable_change_password":{"default":true,"description":"是否允许用户更改密码,缺省值为true,后续此字段无效,创建时都为true。","type":"boolean"},"group_ids":{"description":"用户组的专有ID列表。","items":{"maxLength":55,"minLength":1,"type":"string"},"maxItems":5,"minItems":1,"type":"array"},"next_login_change_password":{"default":true,"description":"下次登录是否必须更改密码,缺省值为true。后续此字段无效,创建时都为true。","type":"boolean"},"password":{"description":"用户初始密码。管理员激活模式需要输入。","maxLength":20,"minLength":0,"type":"string"},"user_email":{"description":"用户邮箱。","maxLength":64,"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":20,"minLength":1,"pattern":"^[a-zA-Z][a-zA-Z0-9_-]*","type":"string"},"user_phone":{"description":"用户手机号。","maxLength":20,"minLength":0,"type":"string"}},"required":["user_name"]},"CreateUserResponse":{"properties":{"id":{"description":"用户id。","readOnly":true,"type":"string"}}}},"description":null,"group_id":"7383c32d5d5e4d0481c071faeb994404","host":"workspace.cn-north-4.myhuaweicloud.com","id":"5f69e321b2644df8b1e721522cce7b8a","info_version":"v2","method":"post","name":"CreateDesktopUser","parameters":{},"paths":{"/v2/{project_id}/users":{"post":{"description":"该接口用于创建桌面用户。","operationId":"CreateDesktopUser","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-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":"创建云桌面用户请求。","in":"body","name":"CreateDesktopUserRequestBody","required":true,"schema":{"$ref":"#/definitions/CreateUserRequest"}}],"responses":{"201":{"description":"创建云桌面用户响应。","examples":{"application/json":{"id":"8a2c3f9579d240820179d51e6caf0001"}},"schema":{"$ref":"#/definitions/CreateUserResponse"}},"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","x-apigateway-request-type":"public","x-is-registered":"Y","x-request-examples-1":{"user_email":"test@huawei.com","user_name":"api-test"},"x-request-examples-url-1":"POST /v2/0bec5db98280d2d02fd6c00c2de791ce/users","x-support-sdk":"Y"}}},"product_short":"Workspace","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"创建用户","tags":"用户","uri":null,"version":"2.0"}