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":{"AppCategoryEnum":{"description":"应用分类:\n* `GAME` - 游戏\n* `BUSSINESS_INTELLIGENCE` - 商业智能\n* `SECURE_STORAGE` - 安全与存储\n* `MULTIMEDIA_AND_CODING` - 多媒体与编解码\n* `PROJECT_MANAGEMENT` - 项目管理\n* `PRODUCTIVITY_AND_COLLABORATION` - 生产力与协作\n* `WEB_ADN_APPLICATION` - 网页与应用开发\n* `GRAPHIC_DESIGN` - 图形设计\n* `OTHER` - 其它","enum":["GAME","BUSSINESS_INTELLIGENCE","SECURE_STORAGE","MULTIMEDIA_AND_CODING","PROJECT_MANAGEMENT","PRODUCTIVITY_AND_COLLABORATION","WEB_ADN_APPLICATION","GRAPHIC_DESIGN","OTHER"],"example":"GAME","type":"string"},"AppExtendedInfo":{"description":"包含自定义应用业务扩展信息的对象","properties":{"extended_info":{"additionalProperties":{"type":"string"},"description":"扩展信息的键值对映射","type":"object"}},"type":"object"},"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"}}},"CreateWarehouseAppReq":{"description":"先上传应用文件,再提交向应用仓库中添加应用的请求。","properties":{"app_category":{"$ref":"#/definitions/AppCategoryEnum","description":"应用分类。"},"app_description":{"description":"应用仓库中的应用描述。","example":"XXX公司 XX软件开发应用","maxLength":255,"minLength":0,"type":"string"},"app_extended_info":{"$ref":"#/definitions/AppExtendedInfo","description":"自定义应用业务扩展信息。"},"app_file_size":{"description":"应用文件大小,单位为KB。","example":366,"maximum":5242880,"minimum":1,"type":"integer"},"app_icon":{"description":"> - 图片的默认大小当前限制为8KB,即1024 * 8字节。\n> - 如果数据格式为data;image/png;base64,iVBORw0KGgoAAAANS时实际大小约为字段约为:size * 4/3 + 4bytes。","example":"a2FybWEK","maxLength":10977,"minLength":0,"type":"string"},"app_name":{"description":"应用名称,名称需满足如下规则:\n1. 由中文,英文大小写,数字,_-组成。\n2. 长度范围1~64个字符。","example":"记事本","maxLength":64,"minLength":1,"pattern":"[\\w\\u4e00-\\u9fa5\\u002d_]{1,64}$","type":"string"},"appfile_store_path":{"description":"应用在obs桶的存储路径。","example":"/28fdsuvj222/notepad++.exe","maxLength":1024,"minLength":1,"type":"string"},"os_type":{"$ref":"#/definitions/OsTypeEnum","description":"操作系统类型。"},"version_id":{"description":"版本号,名称需满足如下规则:\n1. 由可见字符组成。\n2. 长度范围1~64个字符。","example":"3.1.2","pattern":"[\\S]{1,64}","type":"string"},"version_name":{"description":"版本描述,名称需满足如下规则:\n1. 由可见字符组成。\n2. 长度范围1~255个字符。","example":"测试版本","pattern":"[\\S]{1,64}","type":"string"}},"required":["app_category","app_name","appfile_store_path","os_type","version_id","version_name"]},"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"}}},"OsTypeEnum":{"description":"系统类型,当前仅支持Windows。\n* `Linux` -\n* `Windows` -\n* `Other` -","enum":["Linux","Windows","Other"],"example":"windows","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"}}},"UnsupportedMediaTypeErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00000415","readOnly":true,"type":"string"},"error_msg":{"description":"错误描述。","example":"The server does not support the media type of the request payload.","readOnly":true,"type":"string"}}},"VerifyStatusEnum":{"description":"审核状态:\n* `VERIFYING` - 审核中\n* `VERIFY_PASS` - 审核通过\n* `Verify_FAIL` - 审核不通过","enum":["VERIFYING","VERIFY_PASS","Verify_FAIL"],"example":"VERIFYING","type":"string"},"WarehouseApp":{"allOf":[{"properties":{"app_category":{"$ref":"#/definitions/AppCategoryEnum","description":"应用分类。","readOnly":true},"app_description":{"description":"应用描述。","example":"XXX公司 XX软件开发应用","readOnly":true,"type":"string"},"app_extended_info":{"$ref":"#/definitions/AppExtendedInfo","description":"自定义应用业务扩展信息。"},"app_file_size":{"description":"应用文件的大小,以KB为单位。","example":"879322","readOnly":true,"type":"string"},"app_icon":{"description":"app的图标文件。","example":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==","readOnly":true,"type":"string"},"app_id":{"description":"应用id。","example":"680556127405998080","readOnly":true,"type":"string"},"app_name":{"description":"应用名称。","example":"记事本","readOnly":true,"type":"string"},"appfile_store_path":{"description":"应用文件的存放路径。","example":"file/notepad++.exe","readOnly":true,"type":"string"},"appicon_store_path":{"description":"应用文件的存放路径。","example":"/26trgfy/notepad.png","readOnly":true,"type":"string"},"create_time":{"description":"应用创建时间。","example":"2016-03-28T00:00:00Z","format":"date-time","readOnly":true,"type":"string"},"id":{"description":"应用的记录id。","example":"680556127464718336","readOnly":true,"type":"string"},"modify_time":{"description":"应用修改时间。","example":"2016-03-28T00:00:00Z","format":"date-time","readOnly":true,"type":"string"},"os_type":{"$ref":"#/definitions/OsTypeEnum","description":"操作系统类型。","readOnly":true},"tenant_id":{"description":"租户id。","example":"26a0420e9e284569a23f1b2f7d9b5011","readOnly":true,"type":"string"},"verify_comment":{"description":"审核的评论意见。","example":"上传的文件存在病毒","readOnly":true,"type":"string"},"verify_status":{"$ref":"#/definitions/VerifyStatusEnum","description":"审核状态。","readOnly":true},"verify_time":{"description":"应用审核时间。","example":"2016-03-28T00:00:00Z","format":"date-time","readOnly":true,"type":"string"},"version_id":{"description":"版本号。","example":"3.1.2","readOnly":true,"type":"string"},"version_name":{"description":"版本名称。","example":"测试版本","readOnly":true,"type":"string"}},"type":"object"}],"description":"应用仓库中的应用详细信息。"}},"description":null,"group_id":"fe7dbee2e20f4aa589be7dce935a38ad","host":"appstream.cn-north-4.myhuaweicloud.com","id":"2f7d1fd85f7d4d2ca7fa287832ae64e1","info_version":"v1","method":"post","name":"CreateWarehouseApp","parameters":{},"paths":{"/v1/{project_id}/app-warehouse/apps":{"post":{"description":"在应用仓库中新增应用。","operationId":"CreateWarehouseApp","parameters":[{"description":"用户Token。\n通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","maxLength":2147483647,"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":"body","name":"CreateWarehouseAppRequestbody","required":true,"schema":{"$ref":"#/definitions/CreateWarehouseAppReq"}}],"produces":["application/json"],"responses":{"200":{"description":"成功响应。","examples":{"application/json":{"app_category":"PRODUCTIVITY_AND_COLLABORATION","app_description":"A postman setup exe.","app_file_size":"401","app_icon":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAYAAADDP*************ABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAAC","app_id":"694648268205850627","app_name":"Postman","appfile_store_path":"file/Postman.exe","create_time":"2024-05-07T07:16:27.791729999Z","id":"694648268272959491","modify_time":"2024-05-07T07:16:27.791729999Z","os_type":"Windows","tenant_id":"26a0420e9e284569a23f1b2f7d9b5011","verify_status":"VERIFYING","version_id":"7.9.0.0","version_name":"Canary"}},"schema":{"$ref":"#/definitions/WarehouseApp"}},"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"}},"415":{"description":"请求中提交的资源格式不支持。","schema":{"$ref":"#/definitions/UnsupportedMediaTypeErrorResp"}},"500":{"description":"服务内部错误,具体返回错误码请参见错误码说明。","schema":{"$ref":"#/definitions/InternalServerErrorResp"}},"503":{"description":"服务不可用。","schema":{"$ref":"#/definitions/ServiceUnavailableErrorResp"}}},"schemes":["https"],"security":[{"apig-auth-iam-used-authn5":[]}],"summary":"在应用仓库中新增应用","tags":["AppWareHouse"],"x-api-type":"open-api","x-apiexplorer-hide":"N","x-apig-group":"internal,public","x-apigateway-backend":{"httpVpcEndpoints":{"description":"","method":"POST","name":"wks-appmanager-lb","path":"/v1/{project_id}/app-warehouse/apps","scheme":"https","timeout":30000},"parameters":[{"description":"","in":"path","name":"project_id","origin":"request","value":"project_id"},{"description":"","in":"header","name":"X-Auth-Token","origin":"request","value":"X-Auth-Token"}],"type":"HTTP-VPC"},"x-apigateway-cors":false,"x-apigateway-match-mode":"NORMAL","x-apigateway-ratelimit":"workspace_default_operate","x-apigateway-request-type":"public","x-is-registered":"N","x-request-examples-1":{"app_category":"PRODUCTIVITY_AND_COLLABORATION","app_description":"A postman setup exe.","app_file_size":401,"app_icon":"data:image/png;base64,iVBORw0KGWBUwmyIgfBRgjsA88DJ9OxpLdgbbFDuB+Pt***********w59LFEQHa+0QrAJNBfiSUVORK5CYII=","app_name":"Postman","appfile_store_path":"file/Postman.exe","os_type":"Windows","version_id":"7.9.0.0","version_name":"Canary"},"x-request-examples-url-1":"POST /v1/a4da8115c9d8464ead3a38309130523f/app-warehouse/apps","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"}