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"}}},"ConflictErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00211103","readOnly":true,"type":"string"},"error_msg":{"description":"错误描述。","example":"The request could not be completed due to a conflict of the resource.","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"}}},"JobIdInfo":{"properties":{"job_id":{"description":"任务ID。","example":"84d5dd05-2977-4e37-8409-cf0b027f6a5b","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"}}},"UpdateTsvi":{"description":"服务器更新虚拟会话IP配置请求。","example":{"enable":true,"id":"3f791197-d166-4c8e-81e4-38c40ffc1989"},"properties":{"enable":{"description":"**⚠ 预留字段,不使用,是否启用虚拟IP功能与服务器组配置保持一致。\n是否启用虚拟IP功能。\n开关只在租户配置允许启用虚拟IP场景有效,否则忽略传值并设置为关闭。","example":false,"type":"boolean"},"id":{"description":"服务器ID。","example":"3f791197-d166-4c8e-81e4-38c40ffc1989","maxLength":128,"minLength":1,"type":"string"}},"required":["enable","id"],"type":"object"},"UpdateTsviReq":{"description":"批量服务器更新虚拟会话IP配置请求内容。","properties":{"items":{"description":"批量请求列表,一次请求数量区间 [1, 20]。","example":[{"enable":true,"id":"3f791197-d166-4c8e-81e4-38c40ffc1989"},{"enable":true,"id":"62f48b59-0ebb-4b1e-ad35-f64948a0591b"}],"items":{"allOf":[{"$ref":"#/definitions/UpdateTsvi"}],"type":"object"},"maxItems":20,"minItems":1,"type":"array"}},"required":["items"],"type":"object"},"UpdateTsviResp":{"allOf":[{"$ref":"#/definitions/JobIdInfo"}],"description":"批量服务器更新虚拟会话IP配置响应,可根据job_id查询任务状态。"}},"description":null,"group_id":"fe7dbee2e20f4aa589be7dce935a38ad","host":"appstream.cn-north-4.myhuaweicloud.com","id":"f2b21ff701ca465bb1a6aedb850b56f5","info_version":"v1","method":"patch","name":"BatchUpdateTsvi","parameters":{},"paths":{"/v1/{project_id}/app-servers/actions/batch-update-tsvi":{"patch":{"description":"批量更新服务器虚拟会话IP配置,按需重启机器。","operationId":"BatchUpdateTsvi","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":"批量更新服务器虚拟会话IP配置。","in":"body","name":"BatchUpdateTsviRequestBody","required":true,"schema":{"$ref":"#/definitions/UpdateTsviReq"}}],"responses":{"200":{"description":"成功响应。","examples":{"application/json":{"job_id":"575768277444198400"}},"schema":{"$ref":"#/definitions/UpdateTsviResp"}},"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"}},"409":{"description":"请求存在冲突无法处理该请求。","schema":{"$ref":"#/definitions/ConflictErrorResp"}},"500":{"description":"服务内部错误,具体返回错误码请参见错误码说明。","schema":{"$ref":"#/definitions/InternalServerErrorResp"}},"503":{"description":"服务不可用。","schema":{"$ref":"#/definitions/ServiceUnavailableErrorResp"}}},"schemes":["https"],"security":[{"apig-auth-iam-used-authn5":[]}],"summary":"批量更新服务器虚拟会话IP配置","tags":["Server"],"x-api-type":"open-api","x-apiexplorer-hide":"N","x-apig-group":"internal,public","x-apigateway-backend":{"httpVpcEndpoints":{"description":"","method":"patch","name":"wks-apsmanager-lb","path":"/v1/{project_id}/app-servers/actions/batch-update-tsvi","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":12,"x-request-examples-1":{"items":[{"enable":true,"id":"3f791197-d166-4c8e-81e4-38c40ffc1989"},{"enable":true,"id":"62f48b59-0ebb-4b1e-ad35-f64948a0591b"}]},"x-request-examples-url-1":"PATCH /v1/a4da8115c9d8464ead3a38309130523f/app-servers/actions/batch-update-tsvi","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":"批量更新服务器虚拟会话IP配置","tags":"服务器管理","uri":null,"version":"2.0"}