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":{"AppConnectionInfo":{"description":"应用连接信息。","properties":{"agent_version":{"description":"aps hda版本。","example":"1.1","readOnly":true,"type":"string"},"app_group_id":{"description":"应用组ID。","example":"573743978327834675","readOnly":true,"type":"string"},"app_group_name":{"description":"应用组名称。","example":"云存储","readOnly":true,"type":"string"},"app_id":{"description":"应用id。","example":"d9531c1aa9063419113ea53","readOnly":true,"type":"string"},"app_name":{"description":"应用名称。","example":"云存储-Notepad++","readOnly":true,"type":"string"},"aps_host_id":{"description":"wdh专属主机ID。","example":"0a6f7b6a-bf79-4215-80c9-c2d4d2e79fd4","readOnly":true,"type":"string"},"aps_instance_id":{"description":"aps服务器ID。","example":"0a6f7b6a-bf79-4215-80c9-c2d4d2e79fd4","readOnly":true,"type":"string"},"aps_instance_name":{"description":"aps服务器名称。","example":"APS-WSKIXL","readOnly":true,"type":"string"},"brokering_time":{"description":"登录应用时间。","example":"2022-03-07T10:40:43.858Z","format":"date-time","readOnly":true,"type":"string"},"client_ip":{"description":"客户端ip。","example":"0.0.0.0","readOnly":true,"type":"string"},"client_mac":{"description":"客户端Mac。","example":"clientMac","readOnly":true,"type":"string"},"client_name":{"description":"客户端名称。","example":"00-e0-72-58-08-33","readOnly":true,"type":"string"},"client_type":{"description":"客户端操作系统类型。","example":"clientType","readOnly":true,"type":"string"},"client_version":{"description":"客户端版本。","example":"1.1","readOnly":true,"type":"string"},"connection_failure_reason":{"description":"连接失败原因。","example":"connectionFailureReason","readOnly":true,"type":"string"},"end_time":{"description":"登录应用结束时间。","example":"2024-03-07T10:40:43Z","format":"date-time","readOnly":true,"type":"string"},"failed_code":{"description":"连接失败状态码。","example":"500","readOnly":true,"type":"string"},"id":{"description":"应用连接唯一标识ID。","example":"8cdf5127036b11ee9f75fa163e289e5a","readOnly":true,"type":"string"},"machine_name":{"description":"应用服务器名称。","example":"APS-XS1QJ3TA7T","readOnly":true,"type":"string"},"primary_server_group_id":{"description":"主服务器组ID。","example":"0a6f7b6a-bf79-4215-80c9-c2d4d2e79fd4","readOnly":true,"type":"string"},"public_ip":{"description":"客户端出口ip。","example":"0.0.0.0","readOnly":true,"type":"string"},"secondary_server_group_id":{"description":"主服务器组ID。","example":"0a6f7b6a-bf79-4215-80c9-c2d4d2e79fd4","readOnly":true,"type":"string"},"sid":{"description":"应用服务器sid。","example":"S-1-5-21-1213649063-4191095369-2401105760-1418","readOnly":true,"type":"string"},"tenant_id":{"description":"租户id。","example":"1","readOnly":true,"type":"string"},"transaction_id":{"description":"事务id。","example":"test","readOnly":true,"type":"string"},"user_name":{"description":"登录用户。","example":"user001@wksapp***.huawei.com","readOnly":true,"type":"string"},"virtual_ip":{"description":"会话虚拟ip。","example":"0.0.0.0","readOnly":true,"type":"string"},"vm_ip":{"description":"应用服务器ip。","example":"0.0.0.0","readOnly":true,"type":"string"},"wi_ip":{"description":"连接IP。","example":"0.0.0.0","readOnly":true,"type":"string"}},"type":"object"},"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"}}},"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"}}},"ListAppConnectionReq":{"description":"请求应用使用记录请求体。","properties":{"agent_version":{"description":"aps hda版本。","example":"1.1","maxLength":50,"minLength":0,"type":"string"},"app_group_id":{"description":"应用组id。","example":"1","maxLength":64,"minLength":0,"type":"string"},"app_group_name":{"description":"应用组名称。","example":"appGroupName","maxLength":1024,"minLength":0,"type":"string"},"app_name":{"description":"应用名称,模糊查询。","example":"appName","maxLength":1024,"minLength":0,"type":"string"},"brokering_end_time":{"description":"登录应用结束时间,只支持导出30天内数据,格式 2022-10-31T08:07:39Z,参数中brokering_start_time与brokering_end_time必须同时存在或都不存在,都不存在时导出近一个月的数据。","example":"2022-03-07T10:40:43Z","format":"date-time","type":"string"},"brokering_start_time":{"description":"登录应用开始时间,只支持导出30天内数据,格式 2022-10-31T08:07:39Z,参数中brokering_start_time与brokering_end_time必须同时存在或都不存在,都不存在时导出近一个月的数据。","example":"2022-03-07T10:40:43Z","format":"date-time","type":"string"},"client_name":{"description":"客户端名称。","example":"clientName","maxLength":1024,"minLength":0,"type":"string"},"client_type":{"description":"客户端操作系统类型:\n- Windows\n- Mac","example":"clientType","maxLength":255,"minLength":0,"type":"string"},"client_version":{"description":"客户端版本。","example":"clientVersion","maxLength":50,"minLength":0,"type":"string"},"connection_failure_reason":{"description":"连接失败原因。","example":"connectionFailureReason","maxLength":1024,"minLength":0,"type":"string"},"failed_code":{"description":"连接失败状态码。","example":"500","maxLength":255,"minLength":0,"type":"string"},"id":{"description":"主键。","example":"1","maxLength":64,"minLength":0,"type":"string"},"machine_name":{"description":"应用服务器名称。","example":"machineName","maxLength":1024,"minLength":0,"type":"string"},"public_ip":{"description":"客户端出口ip。","example":"0.0.0.0","maxLength":50,"minLength":0,"type":"string"},"sid":{"description":"应用服务器sid。","example":"sid","maxLength":128,"minLength":0,"type":"string"},"tenant_id":{"description":"租户id。","example":"1","maxLength":255,"minLength":0,"type":"string"},"user_name":{"description":"登录用户,模糊查询。","example":"userName","maxLength":1024,"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"}}},"ListAppConnectionRsp":{"allOf":[{"$ref":"#/definitions/PageResp"},{"properties":{"items":{"description":"应用使用记录列表。","items":{"$ref":"#/definitions/AppConnectionInfo"},"readOnly":true,"type":"array"}},"type":"object"}],"description":"应用使用记录响应。"},"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"}}},"PageResp":{"description":"API列表查询响应。\n\n**⚠ 警告: 此Model不生成java代码,允许其它Model中引用,请勿直接作为Model使用。**","properties":{"count":{"description":"总数。","example":0,"maximum":2147483647,"minimum":0,"type":"integer"}}},"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":"3d1a9b1d67f148598513e328a78a1a43","info_version":"v1","method":"post","name":"ListAppConnection","parameters":{},"paths":{"/v1/{project_id}/session/app-connection":{"post":{"description":"查询应用使用记录。","operationId":"ListAppConnection","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"},{"default":10,"description":"单次查询的大小[1-100],默认值10。","in":"query","maximum":100,"minimum":1,"name":"limit","required":false,"type":"integer","x-example":"10"},{"default":0,"description":"查询的偏移量,默认值0。","in":"query","maximum":2147483647,"minimum":0,"name":"offset","required":false,"type":"integer","x-example":"0"},{"description":"list app connection.","in":"body","name":"ListAppConnectionRequestBody","required":true,"schema":{"$ref":"#/definitions/ListAppConnectionReq"}}],"produces":["application/json"],"responses":{"200":{"description":"成功响应。","examples":{"application/json":{"count":2,"items":[{"agent_version":"23.5.0.0529","app_group_id":"573743978327834675","app_group_name":"云存储","app_name":"云存储-Notepad++","brokering_time":"2023-06-06T14:13:48Z","client_ip":"10.*73.109.160","client_mac":"00-e0-***-58-08-33","client_name":"DESKTOP-KDB5TN1","client_type":"Windows 10","client_version":"23.5.0.0","connection_failure_reason":"","failed_code":"","id":"5af4a8c1047411ee9f75fa163e289e5a","machine_name":"APS-XS1QJ3TA7T","sid":"S-1-5-21-1213649063-4191095369-2401105760-1418","tenant_id":"a4da8115c9d8464ead3a38309130523f","user_name":"user001@wksapp***.huawei.com","virtual_ip":"","vm_ip":"10.*.248.130","wi_ip":"192.**.10.*00\\#192.**.10.23"},{"agent_version":"23.5.0.0529","app_group_id":"573743978327834675","app_group_name":"云存储","app_name":"云存储-Notepad++","brokering_time":"2023-06-06T14:02:00Z","client_ip":"10.*73.109.160","client_mac":"00-e0-**-58-08-33","client_name":"DESKTOP-KDB5TN1","client_type":"Windows 10","client_version":"23.5.0.0","connection_failure_reason":"","failed_code":"","id":"b5442cb1047211ee9f75fa163e289e5a","machine_name":"APS-XS1QJ3TA7T","sid":"S-1-5-21-1213649063-4191095369-2401105760-1418","tenant_id":"a4da8115c9d8464ead3a38309130523f","user_name":"user001@wksapp***.huawei.com","virtual_ip":"","vm_ip":"10.*.248.130","wi_ip":"192.**.10.*00\\#192.**.10.23"}]}},"schema":{"$ref":"#/definitions/ListAppConnectionRsp"}},"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/app-connection","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"},{"description":"","in":"query","name":"limit","origin":"request","value":"limit"},{"description":"","in":"query","name":"offset","origin":"request","value":"offset"}],"type":"HTTP-VPC"},"x-apigateway-cors":false,"x-apigateway-match-mode":"NORMAL","x-apigateway-ratelimit":"workspace_default_get","x-apigateway-request-type":"public","x-is-registered":"Y","x-request-examples-1":{"brokering_end_time":"2025-05-24T10:22:55Z","brokering_start_time":"2025-04-24T16:00:00Z"},"x-request-examples-text-1":{"brokering_end_time":"2025-05-24T10:22:55Z","brokering_start_time":"2025-04-24T16:00:00Z"},"x-request-examples-url-1":"POST /v1/a4da8115c9d8464ead3a38309130523f/session/app-connection?limit=10&offset=0","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"}