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":{"AppGroup":{"allOf":[{"$ref":"#/definitions/BaseAppGroup"},{"properties":{"app_count":{"description":"应用数量。","example":10,"readOnly":true,"type":"integer"}},"type":"object"}],"description":"应用组。"},"AppTypeEnum":{"description":"服务器组应用类型:\n* `SESSION_DESKTOP_APP` - 会话桌面app\n* `COMMON_APP` - 普通app","enum":["SESSION_DESKTOP_APP","COMMON_APP"],"example":"SESSION_DESKTOP_APP","type":"string"},"AuthorizationTypeEnum":{"default":"APP_GROUP","description":"授权类型,基于应用(组)授权,默认为APP_GROUP授权。\n* `APP` - 按照应用授权(***尚未支持***)。\n* `APP_GROUP` - 按照应用组授权。","enum":["APP","APP_GROUP"],"example":"APP_GROUP","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"}}},"BaseAppGroup":{"description":"应用组。","properties":{"app_server_group_id":{"description":"应用服务器组ID。","example":"1","readOnly":true,"type":"string"},"app_server_group_name":{"description":"应用服务器组名称。","example":"name","readOnly":true,"type":"string"},"app_type":{"$ref":"#/definitions/AppTypeEnum","readOnly":true},"authorization_type":{"$ref":"#/definitions/AuthorizationTypeEnum"},"create_at":{"description":"发布时间。","example":"2022-03-07T10:40:43.858Z","format":"date-time","readOnly":true,"type":"string"},"description":{"description":"应用组描述。","example":"XXX公司 软件开发应用组","readOnly":true,"type":"string"},"id":{"description":"应用组ID。","example":"1","readOnly":true,"type":"string"},"name":{"description":"应用组名称。","example":"流程开发应用组","readOnly":true,"type":"string"},"tenant_id":{"description":"租户ID。","example":"2b31ed520xxxxxxebedb6e57xxxxxxxx","readOnly":true,"type":"string"}}},"CreateAppGroupReq":{"description":"创建应用组,允许创建应用组之后再绑定应用服务器组。","properties":{"app_server_group_id":{"description":"应用服务器组ID。","example":"1","maxLength":128,"minLength":0,"type":"string"},"app_type":{"$ref":"#/definitions/AppTypeEnum"},"authorization_type":{"$ref":"#/definitions/AuthorizationTypeEnum"},"description":{"default":"","description":"应用组描述。","example":"XXX公司 软件开发应用组","maxLength":255,"minLength":0,"type":"string"},"name":{"description":"应用组名称,名称需满足如下规则:\n1. 由中文,英文大小写,数字,_-组成。\n2. 长度范围1~64个字符。","example":"流程开发应用组","maxLength":64,"minLength":1,"pattern":"[\\w\\u4e00-\\u9fa5\\u002d_]{1,64}$","type":"string"}},"required":["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"}}},"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":"b0ccb83871c240caa6bab5f5bef442e5","info_version":"v1","method":"post","name":"CreateAppGroup","parameters":{},"paths":{"/v1/{project_id}/app-groups":{"post":{"description":"该API用于创建应用组。\n> - 应用服务器中安装了不同的应用,这些应用可以组成不同的应用组,进行集中的管理和维护,向用户(组)发布。","operationId":"CreateAppGroup","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":"CreateAppGroupRequestBody","required":true,"schema":{"$ref":"#/definitions/CreateAppGroupReq"}}],"responses":{"200":{"description":"操作成功。","examples":{"application/json":{"app_server_group_id":"","authorization_type":"APP_GROUP","create_at":"2023-06-06T14:13:58.671Z","description":"开放性API测试。","id":"575772274859184144","name":"开放性API创建应用组测试","tenant_id":"a4da8115c9d8464ead3a38309130523f"}},"schema":{"$ref":"#/definitions/AppGroup"}},"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":["ApplicationGroup"],"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-groups","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_operate","x-apigateway-request-type":"public","x-is-registered":"Y","x-order":1,"x-request-examples-1":{"app_server_group_id":"","description":"开放性API测试。","name":"开放性API创建应用组测试"},"x-request-examples-url-1":"POST /v1/29dfe82ada564ac2b927e1ff036d9a9b/app-groups","x-support-hcs":"Y","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"}