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"}}},"CreateHotspotSessionConfigReq":{"description":"创建热点会话迁移配置请求。","properties":{"hotspot_exit_session_num":{"description":"热点时退出会话个数。","example":1,"maximum":100,"minimum":0,"type":"integer"},"hotspot_session_migration_enable":{"default":false,"description":"是否开启热点会话迁移。取值为:\nfalse:表示关闭。\ntrue:表示开启。","example":false,"type":"boolean"},"non_migrate_users":{"description":"热点时不迁移用户id列表。","items":{"$ref":"#/definitions/UserInfo"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["hotspot_exit_session_num","hotspot_session_migration_enable"],"type":"object"},"CreateHotspotSessionConfigResp":{"description":"创建热点会话迁移配置返回体。","properties":{"hotspot_exit_session_num":{"description":"热点时退出会话个数。","maximum":100,"minimum":0,"type":"integer"},"hotspot_session_migration_enable":{"default":false,"description":"是否开启热点会话迁移。取值为:\nfalse:表示关闭。\ntrue:表示开启。","type":"boolean"},"id":{"description":"唯一标识。","type":"string"},"non_migrate_users":{"description":"热点时不迁移用户id列表。","items":{"$ref":"#/definitions/UserInfo"},"maxItems":1000,"minItems":0,"type":"array"}},"type":"object"},"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"}}},"UserInfo":{"description":"用户信息。","properties":{"user_id":{"description":"用户id。","example":"xxx-xxx","maxLength":128,"minLength":1,"type":"string"},"user_name":{"description":"用户名","example":"user001","maxLength":128,"minLength":1,"type":"string"}}}},"description":null,"group_id":"fe7dbee2e20f4aa589be7dce935a38ad","host":"appstream.cn-north-4.myhuaweicloud.com","id":"2224efcc6191439f836e7088a39ab507","info_version":"v1","method":"post","name":"CreateHotspotSessionConfig","parameters":{},"paths":{"/v1/{project_id}/hotspot-session-config":{"post":{"description":"创建热点会话迁移配置。","operationId":"CreateHotspotSessionConfig","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...","x-is-registered":"N"},{"description":"项目ID。","in":"path","maxLength":128,"minLength":1,"name":"project_id","required":true,"type":"string","x-example":"2b31ed520xxxxxxebedb6e57xxxxxxxx"},{"description":"创建热点会话迁移配置请求体。","in":"body","name":"CreateHotspotSessionConfigRequestBody","required":true,"schema":{"$ref":"#/definitions/CreateHotspotSessionConfigReq"}}],"responses":{"200":{"description":"成功响应。","examples":{"application/json":{"hotspot_exit_session_num":2,"hotspot_session_migration_enable":true,"non_migrate_users":[{"user_id":"da16f9b8btest029cc171a4f7286353","user_name":"test"}]}},"schema":{"$ref":"#/definitions/CreateHotspotSessionConfigResp"}},"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":["hotspotSession"],"x-api-type":"open-api","x-apiexplorer-hide":"N","x-apig-group":"internal,public","x-apigateway-backend":{"httpVpcEndpoints":{"description":"","method":"POST","name":"wks-policymanager-lb","path":"/v1/{project_id}/hotspot-session-config","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":5,"x-request-examples-url-1":"POST /v1/a4da8115c9d8464ead3a38309130523f/hotspot-session-config","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":"hotspotSession","uri":null,"version":"2.0"}