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"}}},"ExportTaskRsp":{"description":"导出任务返回体。","properties":{"task_id":{"description":"导出任务id。","example":"2b31ed520xxxxxxebedb6e57xxxxxxxx","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"}}},"ListUserConnectionReq":{"description":"请求用户登录记录响应体。","properties":{"agent_version":{"description":"aps hda版本。","example":"23.2.2.0423","maxLength":50,"minLength":0,"type":"string"},"client_name":{"description":"客户端名称。","example":"Y002516E2p1","maxLength":255,"minLength":0,"type":"string"},"client_type":{"description":"客户端操作系统类型:\n- Mac\n- Windows","example":"Windows 10","maxLength":255,"minLength":0,"type":"string"},"client_version":{"description":"客户端版本。","example":"23.2.2.0","maxLength":255,"minLength":0,"type":"string"},"connect_flag":{"description":"连接标志,目前值为0。","example":"0","maxLength":50,"minLength":0,"type":"string"},"connect_type":{"description":"用户连接类别,1代表共享桌面,2代表普通应用。","example":"2","maxLength":32,"minLength":0,"type":"string"},"failed_code":{"description":"连接失败状态码。","example":"500","maxLength":255,"minLength":0,"type":"string"},"failed_reason":{"description":"连接失败原因。","example":"failedReason","maxLength":255,"minLength":0,"type":"string"},"id":{"description":"登录记录唯一标识ID。","example":"8cdf5127036b11ee9f75fa163e289e5a","maxLength":64,"minLength":0,"type":"string"},"login_end_time":{"description":"登录应用结束时间,只支持导出30天内数据,格式 2022-10-31T08:07:39Z,参数中login_start_time与login_end_time必须同时存在或都不存在,都不存在时导出近一个月的数据。","example":"2022-03-07T10:40:43Z","format":"date-time","type":"string"},"login_start_time":{"description":"登录应用开始时间,只支持导出30天内数据,格式 2022-10-31T08:07:39Z,参数中login_start_time与login_end_time必须同时存在或都不存在,都不存在时导出近一个月的数据。","example":"2022-03-07T10:40:43Z","format":"date-time","type":"string"},"machine_name":{"description":"应用服务器名称。","example":"APS-XS1QJ3TA7T","maxLength":255,"minLength":0,"type":"string"},"machine_sid":{"description":"应用服务器sid。","example":"S-1-5-21-1213649063-4191095369-2401105760-1418","maxLength":128,"minLength":0,"type":"string"},"public_ip":{"description":"客户端出口ip。","example":"0.0.0.0","maxLength":50,"minLength":0,"type":"string"},"tenant_id":{"description":"租户id。","example":"a4da8115***464ead3a309130523f","maxLength":255,"minLength":0,"type":"string"},"update_time":{"description":"登录应用开始时间,只支持导出30天内数据,格式 2022-10-31T08:07:39Z。","example":"2022-03-07T10:40:43Z","format":"date-time","type":"string"},"user_name":{"description":"登录用户名称。","example":"user001@wksapp***.huawei.com","maxLength":255,"minLength":0,"type":"string"},"virtual_ip":{"description":"会话虚拟ip。","example":"0.0.0.0","maxLength":50,"minLength":0,"type":"string"},"vm_ip":{"description":"应用服务器ip。","example":"0.0.0.0","maxLength":50,"minLength":0,"type":"string"},"wi_ip":{"description":"连接IP。","example":"0.0.0.0","maxLength":50,"minLength":0,"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"}}},"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"}}}},"description":null,"group_id":"fe7dbee2e20f4aa589be7dce935a38ad","host":"appstream.cn-north-4.myhuaweicloud.com","id":"bf367475d2134b2994ac74586f684db8","info_version":"v1","method":"post","name":"ExportUserConnection","parameters":{},"paths":{"/v1/{project_id}/session/user-connection/export":{"post":{"description":"导出用户登录记录。","operationId":"ExportUserConnection","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":"ExportUserConnectionRequestBody","required":true,"schema":{"$ref":"#/definitions/ListUserConnectionReq"}}],"produces":["application/json"],"responses":{"200":{"description":"成功响应。","schema":{"$ref":"#/definitions/ExportTaskRsp"}},"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":["Session"],"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}/session/user-connection/export","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_export","x-apigateway-request-type":"public","x-is-registered":"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"}