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\",\"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_detail":{"description":"错误详情。","maxLength":1000,"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"},"type":"array","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"},"handle_type":{"description":"处理类型\n- ONLY_FOR_EXPAND:仅对新扩容桌面生效\n- FOR_EXPAND_AND_IDLE:对新扩容桌面与空闲桌面生效\n- FOR_EXPAND_AND_ALL:对新扩容桌面与已有全部桌面生效","enum":["ONLY_FOR_EXPAND","FOR_EXPAND_AND_IDLE","FOR_EXPAND_AND_ALL"],"maxLength":55,"minLength":1,"type":"string"},"promotion_plan_id":{"description":"促销计划ID。","maxLength":255,"minLength":0,"type":"string"}}},"CreateBatchChangeOrderRequestBody":{"properties":{"add_sub_resources_param":{"$ref":"#/definitions/EstimateAddSubResourcesRequestBody"},"add_volume_param":{"$ref":"#/definitions/EstimateAddVolumeRequestBody"},"agency_urn":{"description":"授权给Billing服务的委托URN。使用RAM共享密钥创建包周期云桌面或添加包周期磁盘、重建系统时,需要传入该字段。","maxLength":1500,"minLength":0,"type":"string"},"change_image_param":{"$ref":"#/definitions/CreateChangeImageOrderRequestBody"},"delete_sub_resources_param":{"$ref":"#/definitions/CreateDeleteSubResourcesOrderRequestBody"},"extend_volume_param":{"$ref":"#/definitions/EstimateExtendVolumeRequestBody"},"resize_param":{"$ref":"#/definitions/CreateResizeOrderRequestBody"},"type":{"description":"下单类型。\n - ADD_VOLUME:增加磁盘\n - EXTEND_VOLUME:扩容磁盘\n - RESIZE:变更规格\n - CHANGE_IMAGE:切换镜像\n - ADD_SUB_RESOURCES:购买桌面协同资源\n - DELETE_SUB_RESOURCES:退订桌面协同资源","enum":["ADD_VOLUME","EXTEND_VOLUME","RESIZE","CHANGE_IMAGE","ADD_SUB_RESOURCES","DELETE_SUB_RESOURCES"],"type":"string"}}},"CreateBatchChangeOrderResponseBody":{"properties":{"orders":{"description":"批量生成订单结果。","items":{"$ref":"#/definitions/OrderV5"},"readOnly":true,"type":"array"}},"type":"object"},"CreateChangeImageOrderRequestBody":{"allOf":[{"$ref":"#/definitions/EstimateChangeImageRequestBody"},{"properties":{"delay_time":{"description":"立即重建时给用户预留的保存数据的时间(单位:分钟)。","format":"int32","maximum":15,"minimum":0,"type":"integer"},"desktop_ids":{"description":"桌面id","items":{"description":"桌面id。","maxLength":255,"minLength":0,"type":"string"},"maxItems":1000,"minItems":0,"type":"array","x-maxLength":1000,"x-minLength":0},"encrypt_type":{"$ref":"#/definitions/EncryptType"},"kms_id":{"description":"密钥ID,encrypt_type为ENCRYPTED时必传。","maxLength":255,"minLength":0,"type":"string"},"message":{"description":"下发重建系统盘任务时,给用户发送的提示信息。","maxLength":400,"minLength":0,"type":"string"}},"type":"object"}],"description":"包周期重建系统盘询价请求体。"},"CreateDeleteSubResourcesOrderRequestBody":{"allOf":[{"$ref":"#/definitions/BatchInquiryCommonInfo"},{"required":["sub_resource_type"]},{"properties":{"sub_resource_type":{"description":"待删除附属资源类型:DESKTOP_SHARER(桌面协同资源)。","maxLength":255,"minLength":1,"type":"string"}},"type":"object"}],"description":"包周期删除附属资源询价请求体。"},"CreateResizeOrderRequestBody":{"allOf":[{"$ref":"#/definitions/EstimateResizeRequestBody"},{"properties":{"mode":{"description":"是否支持开机状态下执行变更规格操作。固定传值STOP_DESKTOP,如果桌面处于开机状态,会先关机再变更规格。","maxLength":255,"minLength":0,"type":"string"}},"type":"object"}],"description":"包周期变更规格询价请求体。"},"EncryptType":{"default":"KEEP","description":"加密类型。\n- KEEP:保持原有加密状态\n- UNENCRYPTED:不加密\n- ENCRYPTED:加密(需同步上传kms_id)","enum":["KEEP","UNENCRYPTED","ENCRYPTED"],"maxLength":255,"minLength":0,"type":"string"},"EstimateAddSubResourcesRequestBody":{"allOf":[{"$ref":"#/definitions/BatchInquiryCommonInfo"},{"required":["sub_resource_sku"]},{"properties":{"sub_resource_sku":{"description":"新增附属资源SKU码。","maxLength":255,"minLength":1,"type":"string"}},"type":"object"}],"description":"包周期新增附属资源询价请求体。"},"EstimateAddVolumeRequestBody":{"allOf":[{"$ref":"#/definitions/BatchInquiryCommonInfo"},{"required":["volume_size","volume_type"]},{"properties":{"desktop_pool_disk_id":{"description":"需要添加的的桌面池磁盘ID,修复不一致磁盘必传。","maxLength":255,"minLength":1,"type":"string"},"iops":{"description":"iops,云硬盘每秒进行读写的操作次数。","maximum":16380000,"minimum":0,"type":"integer"},"kms_id":{"description":"如果磁盘加密,传递的密钥Id。","maxLength":255,"minLength":0,"type":"string"},"throughput":{"description":"吞吐量,云硬盘每秒成功传送的数据量,即读取和写入的数据量。","maximum":4095000,"minimum":0,"type":"integer"},"volume_size":{"description":"新增磁盘大小。","maximum":8200,"minimum":10,"type":"integer"},"volume_type":{"description":"新增磁盘类型。","maxLength":255,"minLength":1,"type":"string"}},"type":"object"}],"description":"包周期桌面池添加磁盘、切换镜像询价请求体。"},"EstimateChangeImageRequestBody":{"allOf":[{"$ref":"#/definitions/BatchInquiryCommonInfo"},{"properties":{"image_id":{"description":"云市场镜像ID,建议使用image_id。","maxLength":255,"minLength":0,"type":"string"},"image_spec_code":{"description":"云市场镜像的specCode,即将停用。image_spec_code与image_id同时存在时取image_id的值,两者不可同时为空。","maxLength":255,"minLength":0,"type":"string"},"image_type":{"description":"镜像类型。仅重建系统盘/更换镜像使用\n\n- private:私有镜像。\n- gold:公共镜像。","maxLength":55,"minLength":1,"type":"string"}},"type":"object"}],"description":"包周期桌面池由不收费镜像切换至收费镜像的询价请求体。"},"EstimateExtendVolumeRequestBody":{"allOf":[{"$ref":"#/definitions/BatchInquiryCommonInfo"},{"required":["desktop_pool_disk_id","new_size"]},{"properties":{"desktop_pool_disk_id":{"description":"需要扩容的桌面池磁盘ID。","maxLength":255,"minLength":1,"type":"string"},"new_size":{"description":"扩容后的磁盘大小,整池操作时必须大于当前桌面池模板值。","maximum":8200,"minimum":10,"type":"integer"}},"type":"object"}],"description":"包周期扩容磁盘询价请求体。"},"EstimateResizeRequestBody":{"allOf":[{"$ref":"#/definitions/BatchInquiryCommonInfo"},{"required":["product_id"]},{"properties":{"product_id":{"description":"目标规格产品ID。","maxLength":255,"minLength":1,"type":"string"}},"type":"object"}]},"OrderV5":{"properties":{"job_id":{"description":"jobId。","readOnly":true,"type":"string"},"order_id":{"description":"订单id。","readOnly":true,"type":"string"},"order_status":{"description":"订单状态:0:初始化; 1:待审核; 2:待退款; 3:处理中; 4:已取消; 5:已完成; 6:待支付; 7:补偿中; 8:待审批; 9:待确认; 10:待发货; 11:待收货; 12:待上门取货; 13:换新中; 14:待商家收货。","readOnly":true,"type":"integer"},"result":{"description":"结果,SUCCESS:成功; FAIL:失败。","readOnly":true,"type":"string"},"result_code":{"description":"result=FAIL时,必填,表示该订单失败原因。","readOnly":true,"type":"string"},"result_msg":{"description":"失败信息,和result_code结对出现。","readOnly":true,"type":"string"}},"type":"object"}},"description":null,"group_id":"7383c32d5d5e4d0481c071faeb994404","host":"workspace.cn-north-4.myhuaweicloud.com","id":"97b2690316474f68b22165b027309ba8","info_version":"v2","method":"post","name":"CreateDesktopPoolChangeOrder","parameters":{},"paths":{"/v2/{project_id}/desktop-pool/periodic/change/order":{"post":{"consumes":["application/json"],"description":"包周期桌面池批量变更下单。","operationId":"CreateDesktopPoolChangeOrder","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":"包周期桌面池批量变更下单请求体。","in":"body","name":"CreateDesktopPoolChangeOrderRequestBody","required":true,"schema":{"$ref":"#/definitions/CreateBatchChangeOrderRequestBody"}}],"produces":["application/json"],"responses":{"200":{"description":"包周期桌面池批量变更下单响应体。","examples":{"application/json":{"orders":[{"order_id":"CS25052414519W9OP","order_status":6}]}},"schema":{"$ref":"#/definitions/CreateBatchChangeOrderResponseBody"}},"400":{"description":"由于包含语法错误,当前请求无法被服务器理解。","schema":{"$ref":"#/definitions/BaseResponse"}},"409":{"description":"操作冲突。","schema":{"$ref":"#/definitions/BaseResponse"}},"500":{"description":"服务器内部错误。","schema":{"$ref":"#/definitions/BaseResponse"}}},"summary":"包周期桌面池批量变更下单","tags":["Order"],"x-api-type":"open-api","x-apiexplorer-hide":"N","x-apig-group":"public,internal_token","x-apigateway-request-type":"public","x-is-registered":"Y","x-methodAnnotations":["@EnableAuth","@IamAuthMeta(authLevel = IamAuthLevel.INSTANCE_LIST, abacAction = \"workspace:orders:change\",  needApigwJwtAuthCheck = false, needRbacCheck = false, authContextInitializerName = \"changeOrdersAuthContextInitializer\", needAbacResourceCheck = true)","@CtsMeta(serviceType = \"Workspace\", resourceType = \"workspace\", traceName = \"createDesktopPoolChangeOrder\", traceNameCn = \"包周期桌面池批量变更下单\")"],"x-request-examples-1":{"add_volume_param":{"desktop_pool_id":"b046ac8e-0994-4c09-a8a8-bd989d218120","volume_size":10,"volume_type":"SAS"},"type":"ADD_VOLUME"},"x-request-examples-text-1":{"add_volume_param":{"desktop_pool_id":"b046ac8e-0994-4c09-a8a8-bd989d218120","volume_size":10,"volume_type":"SAS"},"type":"ADD_VOLUME"},"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"}