huawei-cloud-api-definitions-Workspace 0.1.20260116

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":null,"components":null,"consumes":"[\"application/json\",\"application/json;charset=utf-8\",\"application/json;charset=UTF-8\"]","definitions":{"ApplyDesktopsInternetReq":{"description":"开通桌面上网能力请求体。","properties":{"bandwidth_size":{"description":"带宽大小,单位Mbit/s。默认1Mbit/s~2000Mbit/s(具体范围以各区域配置为准,请参见控制台对应页面显示)。","format":"int32","maximum":2000,"minimum":1,"type":"integer"},"count":{"description":"需要购买EIP的数量,当desktop_ids为空时需要填,兼容单独购买EIP场景。","format":"int32","maximum":100,"minimum":0,"type":"integer"},"desktop_ids":{"description":"需要开通上网功能的桌面id列表。","items":{"maxLength":255,"minLength":0,"type":"string"},"maxItems":100,"minItems":0,"type":"array","x-maxLength":100,"x-minLength":0,"x-type":"List<@Size(min=0, max=255) String>"},"eip_charge_mode":{"description":"eip带宽计费模式\n- TRAFFIC:按流量计费。\n- BANDWIDTH:按带宽计费。","enum":["TRAFFIC","BANDWIDTH"],"maxLength":255,"minLength":0,"type":"string"},"eip_type":{"description":"支持的类型请参考EIP服务支持的类型。可通过调用如下链接的接口查询,https://support.huaweicloud.com/api-eip/ShowPublicIpType.html。","maxLength":255,"minLength":0,"type":"string"},"enterprise_project_id":{"default":"0","description":"企业项目ID,默认\"0。\"","maxLength":36,"minLength":0,"pattern":"^[a-zA-Z0-9_-]+$","type":"string"}},"required":["bandwidth_size","eip_charge_mode","eip_type"]},"ApplyDesktopsInternetRsp":{"description":"创建云办公带宽响应。","properties":{"job_id":{"description":"任务id。","example":"fa9e41e1-1221-47c3-a43c-67a1271e2093","readOnly":true,"type":"string"}}},"BaseResponse":{"description":"API响应基类。","properties":{"encoded_authorization_message":{"description":"加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。","readOnly":true,"type":"string"},"error_code":{"description":"错误码。","maxLength":12,"minLength":0,"type":"string"},"error_detail":{"description":"错误详情。","maxLength":1000,"minLength":0,"type":"string"},"error_msg":{"description":"错误描述。","maxLength":1000,"minLength":0,"type":"string"}}}},"description":null,"group_id":"7383c32d5d5e4d0481c071faeb994404","host":"workspace.cn-north-4.myhuaweicloud.com","id":"53c1dfcc37984f4d803c960dbea22830","info_version":"v2","method":"post","name":"ApplyDesktopsInternet","parameters":{},"paths":{"/v2/{project_id}/eips":{"post":{"description":"开通桌面上网功能。","operationId":"ApplyDesktopsInternet","parameters":[{"description":"项目ID。","in":"path","maxLength":255,"minLength":1,"name":"project_id","required":true,"type":"string","x-annotations":"@Size(max = 255, min = 1)"},{"description":"请求参数。","in":"body","name":"ApplyDesktopsInternetRequestBody","required":true,"schema":{"$ref":"#/definitions/ApplyDesktopsInternetReq"}}],"responses":{"200":{"description":"开通上网功能响应。","examples":{"application/json":{"job_id":"fa9e41e1-1221-47c3-a43c-67a1271e2093"}},"schema":{"$ref":"#/definitions/ApplyDesktopsInternetRsp"}},"default":{"description":"默认响应。","schema":{"$ref":"#/definitions/BaseResponse"}}},"summary":"开通桌面上网功能","tags":["Network"],"x-api-type":"open-api","x-apiexplorer-hide":"N","x-apig-group":"public,internal_token,internal_appcode","x-apigateway-request-type":"public","x-is-registered":"Y","x-methodAnnotations":["@EnableAuth","@IamAuthMeta(authLevel = IamAuthLevel.PROJECT,  authContextInitializerName = \"workspaceCommonAuthContextInitializer\", abacAction = \"workspace:networks:createEips\",  needApigwJwtAuthCheck = false, needRbacCheck = false)","@CtsMeta(serviceType = \"Workspace\", resourceType = \"workspace\", traceName = \"applyDesktopInternet\", traceNameCn = \"开通桌面上网功能\")"],"x-request-examples-1":{"bandwidth_size":1,"desktop_ids":["90f05916-bc71-4e26-a534-d036188d96e3"],"eip_charge_mode":"string","eip_type":"5_bgp"},"x-request-examples-text-1":{"bandwidth_size":1,"desktop_ids":["90f05916-bc71-4e26-a534-d036188d96e3"],"eip_charge_mode":"string","eip_type":"5_bgp"},"x-request-examples-url-1":"/v2/0e69423d4400f4a82f67c0059a1e4cc8/eips","x-support-sdk":"Y","x-workspace-api-auth":"CBC"}}},"product_short":"Workspace","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"}