huawei-cloud-api-definitions-WorkspaceApp 0.1.20260612

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":null,"components":null,"consumes":"[\"application/json\"]","definitions":{"AttachType":{"description":"关联对象类型:\n* `USER` -  用户\n* `USER_GROUP` - 用户组","enum":["USER","USER_GROUP"],"example":"USER","type":"string"},"BadRequestErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00211102","readOnly":true,"type":"string"},"error_msg":{"description":"错误描述。","example":"The parameter is invalid.","readOnly":true,"type":"string"}}},"CloudStorageAssignmentCreateInfo":{"description":"创建文件夹返回信息。","properties":{"attach":{"description":"用户名称。","example":"user","type":"string"},"attach_id":{"description":"用户ID。","example":"01c0d7ebb6624ef782cc2779d540dxxx","type":"string"},"attach_type":{"$ref":"#/definitions/AttachType","description":"用户类型。"},"domain_id":{"description":"域ID。","example":"06efbb8c1100d47c0f20c00d54efexxx","type":"string"},"error_message":{"description":"错误信息。","example":"WKS.xxxx","type":"string"},"folder_name":{"description":"文件夹名称。","example":"06efbb8c1100d47c0f20c00d54efexxx","type":"string"},"id":{"description":"存储分配的唯一标识符。","example":"925827847048658888","type":"string"},"is_success":{"description":"是否创建成功。","example":true,"type":"boolean"},"region_id":{"description":"区域ID。","example":"cn-north-7","type":"string"},"tenant_id":{"description":"租户ID。","example":"601ff3957dfa4e90baebadddc11c1xxx","type":"string"}},"type":"object"},"CloudStorageAssignmentCreateResp":{"description":"创建个人文件夹返回列表。","properties":{"items":{"description":"创建文件夹返回信息。","items":{"$ref":"#/definitions/CloudStorageAssignmentCreateInfo"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["items"]},"CreateUserAssignmentInfo":{"description":"创建个人文件夹。","properties":{"action_get":{"default":false,"description":"云存储于本地设备的权限,下载:\ntrue : 允许下载。\nfalse: 不允许下载。","type":"boolean"},"action_put":{"default":false,"description":"云存储于本地设备的权限,上传:\ntrue : 允许上传。\nfalse: 不允许上传。","type":"boolean"},"attach_id":{"description":"目标用户id。","example":"xxx-xxx-x-xxx","maxLength":128,"minLength":1,"type":"string"},"attach_name":{"description":"目标用户。","example":"USER001***@local.com","maxLength":128,"minLength":1,"type":"string"},"file_system_quota":{"description":"配额。","example":2147483647,"format":"int64","maximum":9223372036854775807,"minimum":0,"type":"integer"},"roam_action_get":{"default":false,"description":"云存储于云桌面/云应用权限,下载:\ntrue : 允许下载。\nfalse: 不允许下载。","type":"boolean"},"roam_action_put":{"default":false,"description":"云存储于云桌面/云应用权限,上传:\ntrue : 允许上传。\nfalse: 不允许上传。","type":"boolean"}},"required":["attach_id","attach_name"]},"CreateUserFolderReq":{"description":"创建个人文件夹。","properties":{"items":{"description":"存储分配目标。","items":{"$ref":"#/definitions/CreateUserAssignmentInfo"},"maxItems":200,"minItems":1,"type":"array","x-annotations":"@Size(max = 200, min = 1)"}},"required":["items"]},"ForbiddenErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00081102","readOnly":true,"type":"string"},"error_msg":{"description":"错误描述。","example":"User does not have permission to access this resource.","readOnly":true,"type":"string"}}},"InternalServerErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00211401","readOnly":true,"type":"string"},"error_msg":{"description":"错误描述。","example":"The requested operation failed. Please try again later.","readOnly":true,"type":"string"}}},"MethodNotAllowedErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00000405","readOnly":true,"type":"string"},"error_msg":{"description":"错误描述。","example":"The method specified in the request is not allowed for this resource.","readOnly":true,"type":"string"}}},"NotFoundErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00211902","readOnly":true,"type":"string"},"error_msg":{"description":"错误描述。","example":"The application does not exist","readOnly":true,"type":"string"}}},"ServiceUnavailableErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00050902","readOnly":true,"type":"string"},"error_msg":{"description":"错误描述。","example":"The service is now unavailable to process the request.","readOnly":true,"type":"string"}}},"UnauthorizedErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00211302","readOnly":true,"type":"string"},"error_msg":{"description":"错误描述。","example":"User authorization error.","readOnly":true,"type":"string"}}}},"description":null,"group_id":"fe7dbee2e20f4aa589be7dce935a38ad","host":"appstream.cn-north-4.myhuaweicloud.com","id":"94019aadf7fc410fbebd1292f4fd561e","info_version":"v1","method":"post","name":"CreateUserFolderAssignment","parameters":{},"paths":{"/v1/{project_id}/cloud-storages/{storage_id}/actions/create-folder":{"post":{"description":"创建个人文件夹并创建对应文件系统,已存在对应目录时,仅更新策略不会重复创建目录。","operationId":"CreateUserFolderAssignment","parameters":[{"description":"用户Token。\n通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","maxLength":102400,"minLength":1,"name":"X-Auth-Token","required":false,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..."},{"description":"项目ID。","in":"path","maxLength":128,"minLength":1,"name":"project_id","required":true,"type":"string","x-example":"2b31ed520xxxxxxebedb6e57xxxxxxxx"},{"description":"WKS存储ID。","in":"path","maxLength":128,"minLength":1,"name":"storage_id","required":true,"type":"string","x-example":"2b31ed520xxxxxxebedb6e57xxxxxxxx"},{"description":"创建并设置个人目录关联对象。","in":"body","name":"CreateUserFolderAssignmentRequestBody","required":true,"schema":{"$ref":"#/definitions/CreateUserFolderReq"}}],"responses":{"200":{"description":"成功响应。","examples":{"application/json":{"items":[{"attach":"psc","attach_id":"e8be1ecbae8b49ac9ad30124dbe9d41e","attach_type":"USER","domain_id":"06efbb8c1100d47c0f20c00d54efeba0","folder_name":"My Files1","id":"842486659197960192","is_success":true,"region_id":"cn-north-7","tenant_id":"5be809d45f1a4bb39c6c9256efe00adf"}]}},"schema":{"$ref":"#/definitions/CloudStorageAssignmentCreateResp"}},"400":{"description":"由于包含语法错误,当前请求无法被服务器理解。","schema":{"$ref":"#/definitions/BadRequestErrorResp"}},"401":{"description":"鉴权失败。","schema":{"$ref":"#/definitions/UnauthorizedErrorResp"}},"403":{"description":"没有操作权限。","schema":{"$ref":"#/definitions/ForbiddenErrorResp"}},"404":{"description":"找不到资源。","schema":{"$ref":"#/definitions/NotFoundErrorResp"}},"405":{"description":"请求中指定的方法不被允许。","schema":{"$ref":"#/definitions/MethodNotAllowedErrorResp"}},"500":{"description":"服务内部错误,具体返回错误码请参见错误码说明。","schema":{"$ref":"#/definitions/InternalServerErrorResp"}},"503":{"description":"服务不可用。","schema":{"$ref":"#/definitions/ServiceUnavailableErrorResp"}}},"schemes":["https"],"security":[{"apig-auth-iam-used-authn5":[]}],"summary":"创建个人文件夹","tags":["CloudStorage"],"x-api-type":"open-api","x-apiexplorer-hide":"N","x-apig-group":"public,internal_token","x-apigateway-backend":{"httpVpcEndpoints":{"description":"","method":"POST","name":"wks-appcenter-lb","path":"/v1/{project_id}/cloud-storages/{storage_id}/actions/create-folder","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":"path","name":"storage_id","origin":"request","value":"storage_id"}],"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":7,"x-request-examples-1":{"items":[{"action_get":false,"action_put":false,"attach_id":"e8be1ecbae8b49ac9ad30124dbe9d41e","attach_name":"psc","file_system_quota":1073741824,"roam_action_get":false,"roam_action_put":false}]},"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"}