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"}}},"BatchReinstallServerReq":{"description":"批量重建服务器的请求体。","properties":{"server_ids":{"description":"应用服务器id集合。","example":["adf123-123fgasdfxxxx-123sadasdf","2df123-123fgasdfxxxx-123sadasdf"],"items":{"maxLength":128,"minLength":1,"type":"string"},"maxItems":50,"minItems":0,"type":"array","x-annotations":"@Size(max = 50, min = 0)"},"update_access_agent":{"description":"是否自动升级hda版本。","example":true,"type":"boolean"}}},"BatchReinstallServerResp":{"allOf":[{"$ref":"#/definitions/ServerJobInfos"}],"description":"批量重装服务器时的响应体,可根据job_id查询资源是否创建成功。"},"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"}}},"ServerJobInfo":{"properties":{"error_code":{"description":"失败时的错误码。","example":"WKS.00129901","readOnly":true,"type":"string"},"error_message":{"description":"失败原因。","example":"The service is now unavailable to process the request.","readOnly":true,"type":"string"},"job_id":{"description":"任务ID。","example":"84d5dd05-2977-4e37-8409-cf0b027f6a5b","readOnly":true,"type":"string"},"server_id":{"description":"服务器ID。","example":"84d5dd05-2977-4e37-8409-cf0b027f6a5b","readOnly":true,"type":"string"}}},"ServerJobInfos":{"properties":{"items":{"description":"服务器任务信息。","example":[{"error_code":"","error_message":"","job_id":"84d5dd05-2977-4e37-8409-cf0b027f6a5b","server_id":"84d5dd05-2977-4e37-8409-cf0b027f6a5b"},{"error_code":"WKS.00129901","error_message":"The service is now unavailable to process the request.","job_id":"","server_id":"84d5dd05-2977-4e37-8409-cf0b027f6a5b"}],"items":{"$ref":"#/definitions/ServerJobInfo"},"readOnly":true,"type":"array"}}},"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":"7ba5a7e10f77435593ce2946c5508419","info_version":"v1","method":"post","name":"BatchReinstallServer","parameters":{},"paths":{"/v1/{project_id}/app-servers/actions/batch-reinstall":{"post":{"description":"批量重装服务器。\n> - 使用服务器原有的镜像进行重装,当服务器异常无法恢复时或者服务器运行时间久了,性能下降时,可选择重建服务器。注意:重装时系统盘的数据将会被清理掉。","operationId":"BatchReinstallServer","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":"项目唯一标识。","in":"path","maxLength":128,"minLength":1,"name":"project_id","required":true,"type":"string","x-example":"2b31ed520xxxxxxebedb6e57xxxxxxxx"},{"description":"批量重装服务器请求内容。","in":"body","name":"BatchReinstallServerRequestBody","required":true,"schema":{"$ref":"#/definitions/BatchReinstallServerReq"}}],"responses":{"200":{"description":"成功响应。","examples":{"application/json":{"items":[{"error_code":"","error_message":"","job_id":"84d5dd05-2977-4e37-8409-cf0b027f6a5b","server_id":"84d5dd05-2977-4e37-8409-cf0b027f6a5b"},{"error_code":"WKS.00129901","error_message":"The service is now unavailable to process the request.","job_id":"","server_id":"84d5dd05-2977-4e37-8409-cf0b027f6a5b"}]}},"schema":{"$ref":"#/definitions/BatchReinstallServerResp"}},"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":["Server"],"x-api-type":"open-api","x-apiexplorer-hide":"N","x-apig-group":"internal,public","x-apigateway-backend":{"httpVpcEndpoints":{"description":"","method":"post","name":"wks-apsmanager-lb","path":"/v1/{project_id}/app-servers/actions/batch-reinstall","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":10,"x-request-examples-1":{"server_ids":["25b1dd14-0c84-4558-aa57-03a6c54b8e75"],"update_access_agent":false},"x-request-examples-url-1":"POST /v1/a4da8115c9d8464ead3a38309130523f/app-servers/actions/batch-reinstall","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"}