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":{"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"}}},"FileInfo":{"description":"文件信息。","properties":{"content_type":{"description":"文件的MIME类型。","example":".txt","readOnly":true,"type":"string"},"file_name":{"description":"文件名称。","example":"My Files/backup/aaa.pptx","readOnly":true,"type":"string"},"size":{"description":"文件大小。","example":1232321,"format":"int64","readOnly":true,"type":"integer"}}},"FolderInfo":{"description":"文件夹信息。","properties":{"inode_no":{"description":"文件inode。","example":123431232,"format":"int64","readOnly":true,"type":"integer"},"prefix":{"description":"文件夹名称。","example":"My Files/backup/20250425152345","readOnly":true,"type":"string"}}},"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"}}},"ListFoldersAndFilesResp":{"description":"返回指定目录下文件夹和文件信息","properties":{"files":{"description":"文件信息列表。","items":{"$ref":"#/definitions/FileInfo"},"readOnly":true,"type":"array"},"folders":{"description":"文件夹信息列表。","items":{"$ref":"#/definitions/FolderInfo"},"readOnly":true,"type":"array"},"location":{"description":"文件系统所在区域代号。","example":"cn-north-7","readOnly":true,"type":"string"},"marker":{"description":"本次列举的文件的起始位置,默认为空。","example":"/My Files","readOnly":true,"type":"string"},"max_keys":{"description":"本次列举可以返回的最大文件数量,非本次列举返回的数量,取入参与系统默认值的小值为准。","example":1000,"readOnly":true,"type":"integer"},"next_marker":{"description":"下次列举请求的的起始位置,默认为空。","example":"/My Files","readOnly":true,"type":"string"},"prefix":{"description":"文件名的绝对路径的前缀。","example":"/My Files","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":"de9469d7b65b448e95f4a4467920befb","info_version":"v1","method":"get","name":"ListFoldersAndFiles","parameters":{},"paths":{"/v1/{project_id}/cloud-storages/actions/list-folder-files":{"get":{"description":"查询指定目录下文件夹和文件信息","operationId":"ListFoldersAndFiles","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":"用户名","in":"query","name":"user_name","pattern":"[\\S ]{0,128}$","required":true,"type":"string","x-example":"tester"},{"description":"个人文件夹ID。(用户拥有多个文件夹时,如果不传个人文件夹id则选择最早创建的文件系统进行文件查询)","in":"query","name":"cloud_storage_assignment_id","pattern":"[\\S ]{0,128}$","required":false,"type":"string","x-example":"2b31ed520x2va3cda3xxxebedb6e57xxxx"},{"description":"查询文件夹路径","in":"query","name":"folder_url","pattern":"^(?=.{1,512}$)([^<>:\"|?*]+[/\\\\])*[^<>:\"|?*]+[/\\\\]?$","required":true,"type":"string","x-example":"Backup/"},{"description":"指定一个标识符,从该标识符以后按文件名的字典顺序返回文件列表。","in":"query","name":"marker","pattern":"^.{1,1024}$","required":false,"type":"string","x-example":"test"},{"description":"列举文件系统的最大数目,返回的文件系统列表将是按照字典顺序的最多前 limit 个,默认取值为1000。","in":"query","maximum":1000000,"minimum":0,"name":"limit","required":false,"type":"integer","x-example":1000}],"responses":{"200":{"description":"成功响应。","schema":{"$ref":"#/definitions/ListFoldersAndFilesResp"}},"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":"GET","name":"wks-appcenter-lb","path":"/v1/{project_id}/cloud-storages/actions/list-folder-files","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"}],"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-request-examples-url-1":"GET /v1/a4da8115c9d8464ead3a38309130523f/cloud-storages/actions/list-folder-files","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"}