huawei-cloud-api-definitions-Workspace 0.1.20260425

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":null,"components":null,"consumes":"[\"application/json\",\"application/json;charset=utf-8\"]","definitions":{"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_msg":{"description":"错误描述。","maxLength":1000,"minLength":0,"type":"string"}}},"BatchInquiryCommonInfo":{"description":"批量询价/下单公共参数。","properties":{"desktop_ids":{"description":"包周期桌面ID列表。 不可同时存在普通桌面和池桌面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>"},"desktop_pool_id":{"description":"桌面池ID。当desktop_pool_id与desktop_ids同时存在时,取desktop_ids的值,两者不可同时为空。","maxLength":64,"minLength":0,"type":"string"},"promotion_plan_id":{"description":"促销计划ID。","maxLength":255,"minLength":0,"type":"string"}}},"BillingResult":{"description":"批价基础结果。","type":"object"},"CloudServiceRatingResult":{"description":"询价结果。","properties":{"official_website_rating_result":{"$ref":"#/definitions/OfficialWebsiteRatingResult","readOnly":true},"optional_discount_rating_results":{"description":"优惠询价结果。","items":{"$ref":"#/definitions/OptionalDiscountRatingResult"},"readOnly":true,"type":"array"},"order_request_id":{"description":"下单请求体中的orderRequestId。","readOnly":true,"type":"string"}}},"EstimateAddSubResourceResponseBody":{"description":"询价结果。","properties":{"cloud_service_rating_results":{"description":"询价结果。","items":{"$ref":"#/definitions/CloudServiceRatingResult"},"readOnly":true,"type":"array"},"currency":{"description":"币种,比如CNY。","readOnly":true,"type":"string"}}},"EstimateAddSubResourcesRequestBody":{"allOf":[{"$ref":"#/definitions/BatchInquiryCommonInfo"},{},{"properties":{"sub_resource_sku":{"description":"新增附属资源SKU码。","maxLength":255,"minLength":1,"type":"string"}},"type":"object"}],"description":"包周期新增附属资源询价请求体。"},"OfficialWebsiteRatingResult":{"allOf":[{"$ref":"#/definitions/BillingResult"},{"properties":{"amount":{"description":"订单总额,即最终优惠后的订单金额(预留实例只包含预付部分)。","readOnly":true,"type":"number"},"discount_amount":{"description":"总优惠额(预留实例只包含预付部分)。","readOnly":true,"type":"number"},"measure_id":{"description":"度量单位。","readOnly":true,"type":"integer"},"official_website_amount":{"description":"官网价(预留实例只包含预付部分)。","readOnly":true,"type":"number"},"official_website_discount_amount":{"description":"官网价优惠额(预留实例只包含预付部分)。","readOnly":true,"type":"number"},"optional_discount_amount":{"description":"可选折扣优惠额(预留实例只包含预付部分)。","readOnly":true,"type":"number"},"original_amount":{"description":"订单原总额,即优惠前订单总额(预留实例只包含预付部分)。","readOnly":true,"type":"number"},"per_amount":{"description":"总分期金额(批量询价的商品分期周期类型一致,才会有总分期金额,分期周期类型不一致,该信息没有)。","readOnly":true,"type":"number"},"per_discount_amount":{"description":"总分期金额的优惠额(perDiscountAmount = perOriginalAmount - perAmount)。","readOnly":true,"type":"number"},"per_original_amount":{"description":"总分期金额原价。","readOnly":true,"type":"number"},"per_period_type":{"description":"分期周期类型 2:月 4:小时。","readOnly":true,"type":"integer"},"product_rating_results":{"description":"产品询价结果。","items":{"$ref":"#/definitions/ProductResult"},"readOnly":true,"type":"array"}},"type":"object"}],"description":"结果。"},"OptionalDiscountRatingResult":{"allOf":[{"$ref":"#/definitions/BillingResult"},{"properties":{"amount":{"description":"订单总额,即最终优惠后的订单金额(预留实例只包含预付部分)。","readOnly":true,"type":"number"},"best_offer":{"description":"是否为最优折扣0:不是最优折扣;为缺省值。1:是最优折扣;最优折扣:在商务折扣、伙伴折扣和促销折扣中选择(优惠金额相等则按此顺序排优先级),折扣券不参与最优折扣的计算。","readOnly":true,"type":"integer"},"discount_amount":{"description":"总优惠额(预留实例只包含预付部分)。","readOnly":true,"type":"number"},"discount_id":{"description":"折扣优惠Id。","readOnly":true,"type":"string"},"discount_name":{"description":"折扣名称。","readOnly":true,"type":"string"},"discount_ratio":{"description":"sameRatioFlag为1时有值,表示该折扣的折扣率。","readOnly":true,"type":"number"},"discount_type":{"description":"折扣优惠类型。","readOnly":true,"type":"integer"},"measure_id":{"description":"度量单位。","readOnly":true,"type":"integer"},"official_website_amount":{"description":"官网价(预留实例只包含预付部分)。","readOnly":true,"type":"number"},"official_website_discount_amount":{"description":"官网价优惠额(预留实例只包含预付部分)。","readOnly":true,"type":"number"},"optional_discount_amount":{"description":"可选折扣优惠额(预留实例只包含预付部分)。","readOnly":true,"type":"number"},"original_amount":{"description":"订单原总额,即优惠前订单总额(预留实例只包含预付部分)。","readOnly":true,"type":"number"},"per_amount":{"description":"总分期金额(批量询价的商品分期周期类型一致,才会有总分期金额,分期周期类型不一致,该信息没有)。","readOnly":true,"type":"number"},"per_discount_amount":{"description":"总分期金额的优惠额(perDiscountAmount = perOriginalAmount - perAmount)。","readOnly":true,"type":"number"},"per_official_website_amount":{"description":"总分期金额的官网价(批量询价的商品分期周期类型一致,才会有总分期金额的官网价,分期周期类型不一致,该信息没有)。","readOnly":true,"type":"number"},"per_official_website_discount_amount":{"description":"总分期金额的官网价官网价优惠额,即: perOfficialWebsiteDiscountAmount =perOriginalAmount-perOfficialWebsiteAmount (批量询价的商品分期周期类型一致,才会有总分期金额的官网价,分期周期类型不一致,该信息没有)。","readOnly":true,"type":"number"},"per_optional_discount_amount":{"description":"总分期金额的可选折扣优惠额,如商务折扣、伙伴折扣、促销折扣和折扣券选用时的优惠额 perOptionalDiscountAmount= perOfficialWebsiteAmount- perAmount (批量询价的商品分期周期类型一致,才会有总分期金额的官网价,分期周期类型不一致,该信息没有)。","readOnly":true,"type":"number"},"per_original_amount":{"description":"总分期金额原价。","readOnly":true,"type":"number"},"per_period_type":{"description":"分期周期类型 2:月 4:小时。","readOnly":true,"type":"integer"},"product_rating_results":{"description":"产品询价结果。","items":{"$ref":"#/definitions/ProductResult"},"readOnly":true,"type":"array"},"promotion_info":{"description":"折扣优惠基本信息;调用者在确定好折扣优惠后、下单时,使用此字段值,填入到订购/变更接口中的promotionInfo字段。","readOnly":true,"type":"string"},"same_ratio_flag":{"description":"sameRatioFlag。","readOnly":true,"type":"integer"}},"type":"object"}],"description":"结果。"},"ProductResult":{"description":"产品计算结果。","properties":{"amount":{"description":"总额,即最终优惠后的金额(预留实例只包含预付部分)。","readOnly":true,"type":"number"},"discount_amount":{"description":"优惠额(预留实例只包含预付部分)。","readOnly":true,"type":"number"},"extend_params":{"description":"扩展参数。","readOnly":true,"type":"string"},"id":{"description":"对应请求体中的ID。","readOnly":true,"type":"string"},"measure_id":{"description":"度量单位。","readOnly":true,"type":"integer"},"official_website_amount":{"description":"官网价(非所有接口有该字段)(预留实例只包含预付部分)。","readOnly":true,"type":"number"},"official_website_discount_amount":{"description":"官网价优惠额(非所有接口有该字段)(预留实例只包含预付部分)。","readOnly":true,"type":"number"},"optional_discount_amount":{"description":"可选折扣优惠额(预留实例只包含预付部分),如商务折扣、伙伴折扣、促销折扣和折扣券选用时的优惠额(非所有接口有该字段)。","readOnly":true,"type":"number"},"original_amount":{"description":"原总额,即优惠前总额(预留实例只包含预付部分)。","readOnly":true,"type":"number"},"per_amount":{"description":"总分期金额(批量询价的商品分期周期类型一致,才会有总分期金额,分期周期类型不一致,该信息没有)。","readOnly":true,"type":"number"},"per_discount_amount":{"description":"总分期金额的优惠额(perDiscountAmount = perOriginalAmount - perAmount)。","readOnly":true,"type":"number"},"per_official_website_amount":{"description":"分期金额的官网价。","readOnly":true,"type":"number"},"per_official_website_discount_amount":{"description":"分期金额的官网价官网价优惠额,即:perOfficialWebsiteDiscountAmount =perOriginalAmount-perOfficialWebsiteAmount。","readOnly":true,"type":"number"},"per_optional_discount_amount":{"description":"分期金额的可选折扣优惠额,如商务折扣、伙伴折扣、促销折扣和折扣券选用时的优惠额 perOptionalDiscountAmount= perOfficialWebsiteAmount- perAmount。","readOnly":true,"type":"number"},"per_original_amount":{"description":"总分期金额原价。","readOnly":true,"type":"number"},"per_period_type":{"description":"分期周期类型 2:月 4:小时。","readOnly":true,"type":"integer"},"product_id":{"description":"产品ID。","readOnly":true,"type":"string"}}}},"description":null,"group_id":"7383c32d5d5e4d0481c071faeb994404","host":"workspace.cn-north-4.myhuaweicloud.com","id":"3a2e3570206f4cdeb35bfe996a2eb194","info_version":"v2","method":"post","name":"EstimateAddResources","parameters":{},"paths":{"/v2/{project_id}/periodic/inquiry/add-resources":{"post":{"consumes":["application/json"],"description":"包周期桌面增配变更批量询价。","operationId":"EstimateAddResources","parameters":[{"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":"用户Token。\n\n通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","maxLength":40000,"minLength":1,"name":"X-Auth-Token","required":false,"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":"包周期桌面池批量询价请求体。","in":"body","name":"EstimateAddResourcesRequestBody","required":true,"schema":{"$ref":"#/definitions/EstimateAddSubResourcesRequestBody"}}],"produces":["application/json"],"responses":{"200":{"description":"包周期桌面池批量询价响应体。","examples":{"application/json":{"cloud_service_rating_results":[{"official_website_rating_result":{"amount":0,"discount_amount":0,"measure_id":0,"official_website_amount":0,"official_website_discount_amount":0,"optional_discount_amount":0,"original_amount":0,"per_amount":0,"per_discount_amount":0,"per_original_amount":0,"per_period_type":0,"product_rating_results":[{"amount":0,"discount_amount":0,"extend_params":"string","id":"string","measure_id":0,"official_website_amount":0,"official_website_discount_amount":0,"optional_discount_amount":0,"original_amount":0,"per_amount":0,"per_discount_amount":0,"per_official_website_amount":0,"per_official_website_discount_amount":0,"per_optional_discount_amount":0,"per_original_amount":0,"per_period_type":0,"product_id":"string"}]},"optional_discount_rating_results":[{"amount":0,"best_offer":0,"discount_amount":0,"discount_id":"string","discount_name":"string","discount_ratio":0,"discount_type":0,"measure_id":0,"official_website_amount":0,"official_website_discount_amount":0,"optional_discount_amount":0,"original_amount":0,"per_amount":0,"per_discount_amount":0,"per_official_website_amount":0,"per_official_website_discount_amount":0,"per_optional_discount_amount":0,"per_original_amount":0,"per_period_type":0,"product_rating_results":[{"amount":0,"discount_amount":0,"extend_params":"string","id":"string","measure_id":0,"official_website_amount":0,"official_website_discount_amount":0,"optional_discount_amount":0,"original_amount":0,"per_amount":0,"per_discount_amount":0,"per_official_website_amount":0,"per_official_website_discount_amount":0,"per_optional_discount_amount":0,"per_original_amount":0,"per_period_type":0,"product_id":"string"}],"promotion_info":"string","same_ratio_flag":0}],"order_request_id":"string"}],"currency":"string"}},"schema":{"$ref":"#/definitions/EstimateAddSubResourceResponseBody"}},"400":{"description":"由于包含语法错误,当前请求无法被服务器理解。","schema":{"$ref":"#/definitions/BaseResponse"}},"409":{"description":"操作冲突。","schema":{"$ref":"#/definitions/BaseResponse"}},"500":{"description":"服务器内部错误。","schema":{"$ref":"#/definitions/BaseResponse"}}},"summary":"包周期桌面增配变更批量询价","tags":["Inquiry"],"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-methodAnnotations":["@EnableAuth","@IamAuthMeta(authLevel = IamAuthLevel.PROJECT,  authContextInitializerName = \"workspaceCommonAuthContextInitializer\", abacAction = \"workspace:orders:batchInquiry\",  needApigwJwtAuthCheck = false, needRbacCheck = false)","@CtsMeta(serviceType = \"Workspace\", resourceType = \"workspace\", traceName = \"estimateAddResources\")"],"x-request-examples-1":{"desktop_ids":["string"],"desktop_pool_id":"string","promotion_plan_id":"string","sub_resource_sku":"string"},"x-request-examples-text-1":{"desktop_ids":["string"],"desktop_pool_id":"string","promotion_plan_id":"string","sub_resource_sku":"string"},"x-support-sdk":"Y"}}},"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"}