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":{"ErrorResp":{"description":"API错误响应","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00129901","maxLength":16,"minLength":1,"type":"string"},"error_msg":{"description":"错误描述。","example":"The request message is invalid.","maxLength":255,"minLength":1,"type":"string"}}},"VNC":{"properties":{"protocol":{"description":"登录协议。","example":"https","readOnly":true,"type":"string"},"type":{"description":"登录类型:\n* `novnc`\n* `vnc`","example":"novnc","readOnly":true,"type":"string"},"url":{"description":"远程登录控制台地址。","example":"https://cn-north-5-conso*******_auto.html?token=58843dfe-4e75-******dc2c42&lang=EN","readOnly":true,"type":"string"}}}},"description":null,"group_id":"fe7dbee2e20f4aa589be7dce935a38ad","host":"appstream.cn-north-4.myhuaweicloud.com","id":"83e1805805844b01a2dbc9e4c6489191","info_version":"v1","method":"get","name":"ShowServerVnc","parameters":{},"paths":{"/v1/{project_id}/app-servers/{server_id}/actions/vnc":{"get":{"description":"获取VNC远程登录地址。","operationId":"ShowServerVnc","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":"path","maxLength":128,"minLength":1,"name":"server_id","required":true,"type":"string"}],"responses":{"200":{"description":"成功响应。","examples":{"application/json":{"type":"novnc","url":"https://cn-north-5-conso*******_auto.html?token=58843dfe-4e75-******dc2c42&lang=EN"}},"schema":{"$ref":"#/definitions/VNC"}},"400":{"description":"由于包含语法错误,当前请求无法被服务器理解。","schema":{"$ref":"#/definitions/ErrorResp"}},"401":{"description":"鉴权失败。","schema":{"$ref":"#/definitions/ErrorResp"}},"403":{"description":"没有操作权限。","schema":{"$ref":"#/definitions/ErrorResp"}},"404":{"description":"找不到资源。","schema":{"$ref":"#/definitions/ErrorResp"}},"405":{"description":"请求中指定的方法不被允许。","schema":{"$ref":"#/definitions/ErrorResp"}},"500":{"description":"服务内部错误,具体返回错误码请参见错误码说明。","schema":{"$ref":"#/definitions/ErrorResp"}},"503":{"description":"服务不可用。","schema":{"$ref":"#/definitions/ErrorResp"}}},"schemes":["https"],"security":[{"apig-auth-iam-used-authn5":[]}],"summary":"获取VNC远程登录地址","tags":["Server"],"x-api-type":"open-api","x-apiexplorer-hide":"N","x-apig-group":"internal,public","x-apigateway-backend":{"httpVpcEndpoints":{"description":"","method":"get","name":"wks-apsmanager-lb","path":"/v1/{project_id}/app-servers/{server_id}/actions/vnc","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":"path","name":"server_id","origin":"request","value":"server_id"}],"type":"HTTP-VPC"},"x-apigateway-cors":false,"x-apigateway-match-mode":"NORMAL","x-apigateway-ratelimit":"workspace_base_get","x-apigateway-request-type":"public","x-is-registered":"N","x-request-examples-url-1":"GET /v1/26a0420e9e284569a23f1b2f7d9b5011/app-servers/wksapp-12f749da-3d84-4f2c-99c9-9bd1bfdc8cf0/actions/vnc","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":"获取VNC远程登录地址","tags":"服务器管理","uri":null,"version":"2.0"}