huawei-cloud-api-definitions-Workspace 0.1.20250711

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":null,"components":null,"consumes":"[\"application/json\"]","definitions":{"BaseResponse":{"description":"API响应基类","properties":{"error_code":{"description":"错误码。","maxLength":12,"minLength":0,"type":"string"},"error_msg":{"description":"错误描述。","maxLength":1000,"minLength":0,"type":"string"}}},"DesktopSubnet":{"description":"子网信息","properties":{"cidr":{"description":"桌面所在子网网段","maxLength":255,"minLength":1,"type":"string"},"id":{"description":"桌面所在子网Id","maxLength":255,"minLength":1,"type":"string"},"name":{"description":"桌面所在子网名称","maxLength":255,"minLength":1,"type":"string"}}},"NetworkInfo":{"description":"桌面网络信息:vpc、子网、私有ip、弹性ip、安全组","properties":{"port_info":{"$ref":"#/definitions/Port"},"public_ip_info":{"$ref":"#/definitions/PublicIp"},"security_groups":{"description":"桌面绑定的安全组列表","items":{"$ref":"#/definitions/SecurityGroupInfo"},"maxItems":100,"minItems":0,"type":"array","x-maxLength":100,"x-minLength":0},"subnet_info":{"$ref":"#/definitions/DesktopSubnet"},"vpc_info":{"$ref":"#/definitions/Vpc"}}},"Port":{"description":"私有IP信息。","properties":{"id":{"description":"私有IP唯一标识","maxLength":255,"minLength":0,"type":"string"},"ip_address":{"description":"私有IP地址","maxLength":55,"minLength":0,"type":"string"}}},"PublicIp":{"description":"弹性IP信息。","properties":{"id":{"description":"弹性IP唯一标识","maxLength":255,"minLength":0,"type":"string"},"public_ip_address":{"description":"弹性IP地址","maxLength":55,"minLength":0,"type":"string"}}},"SecurityGroupInfo":{"properties":{"id":{"description":"安全组ID。","maxLength":255,"minLength":0,"type":"string"}},"required":["id"]},"ShowDesktopNetworkRsp":{"description":"查询桌面网络响应体","properties":{"computer_id":{"description":"桌面ID","maxLength":255,"minLength":1,"type":"string"},"computer_name":{"description":"桌面名称","maxLength":255,"minLength":1,"type":"string"},"network_infos":{"description":"桌面网络信息","items":{"$ref":"#/definitions/NetworkInfo"},"maxItems":100,"minItems":0,"type":"array","x-maxLength":100,"x-minLength":0}}},"Vpc":{"description":"vpc信息","properties":{"cidr":{"description":"桌面所在vpc网段","maxLength":255,"minLength":1,"type":"string"},"id":{"description":"桌面所在vpcId","maxLength":255,"minLength":1,"type":"string"},"name":{"description":"桌面所在vpc名称","maxLength":255,"minLength":1,"type":"string"}}}},"description":null,"group_id":"7383c32d5d5e4d0481c071faeb994404","host":"workspace.cn-north-4.myhuaweicloud.com","id":"466f9c84c86f4e4783574afd15307657","info_version":"v2","method":"get","name":"ShowDesktopNetwork","parameters":{},"paths":{"/v2/{project_id}/desktops/{desktop_id}/networks":{"get":{"description":"查询桌面vpc、子网、privateIp、EIP、安全组","operationId":"ShowDesktopNetwork","parameters":[{"description":"用户Token。\n\n通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","maxLength":40000,"minLength":1,"name":"X-Auth-Token","required":true,"type":"string","x-annotations":"@Size(max = 40000, min = 1)","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX...","x-is-registered":"N"},{"description":"发送的实体的MIME类型。","in":"header","maxLength":255,"minLength":1,"name":"Content-Type","required":false,"type":"string","x-annotations":"@Size(max = 255, min = 1)","x-example":"application/json"},{"description":"项目ID。","in":"path","maxLength":255,"minLength":1,"name":"project_id","required":true,"type":"string","x-annotations":"@Size(max = 255, min = 1)","x-example":"2b31ed520xxxxxxebedb6e57xxxxxxxx"},{"description":"桌面ID。","in":"path","maxLength":255,"minLength":1,"name":"desktop_id","required":true,"type":"string","x-annotations":"@Size(max = 255, min = 1)","x-example":"2b31e-d520xxxx-xxebedb6-e57xxxxxx"}],"responses":{"200":{"description":"正常","schema":{"$ref":"#/definitions/ShowDesktopNetworkRsp"}},"400":{"description":"由于包含语法错误,当前请求无法被服务器理解。","schema":{"$ref":"#/definitions/BaseResponse"}},"401":{"description":"鉴权失败。","schema":{"$ref":"#/definitions/BaseResponse"}},"403":{"description":"没有操作权限。","schema":{"$ref":"#/definitions/BaseResponse"}},"404":{"description":"找不到资源。","schema":{"$ref":"#/definitions/BaseResponse"}},"409":{"description":"操作冲突。","schema":{"$ref":"#/definitions/BaseResponse"}},"500":{"description":"服务内部错误,具体返回错误码请参见错误码说明。","schema":{"$ref":"#/definitions/BaseResponse"}}},"summary":"查询桌面网络","tags":["Desktop"],"x-api-type":"open-api","x-apiexplorer-hide":"N","x-apig-group":"internal_token,public","x-apigateway-request-type":"public","x-is-registered":"Y","x-support-sdk":"Y"}}},"product_short":"Workspace","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询桌面网络","tags":"桌面","uri":null,"version":"2.0"}