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\",\"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"}}},"CreateChangeOrderReq":{"description":"创建变更订单请求体。","properties":{"enterprise_project_id":{"description":"企业项目ID。","maxLength":36,"minLength":0,"type":"string"},"exclusive_lites_product_id":{"description":"专享主机桌面数的productId,当是resizeExclusiveLites,必传。","maxLength":255,"minLength":1,"type":"string"},"expand_new_size":{"description":"扩容后云硬盘的总大小,当是expandVolumes,必传。范围10-32760,大小为10的倍数。","format":"int32","maximum":32760,"minimum":10,"type":"integer"},"expand_volume_id":{"description":"扩容的云硬盘的ID,当是expandVolumes,必传。","maxLength":255,"minLength":1,"type":"string"},"extend_param":{"$ref":"#/definitions/OrderExtendParam"},"new_quantity":{"description":"专享主机变更桌面数后桌面路数的总大小,当是jobType是resizeExclusiveLites,必传。","format":"int32","maximum":300,"minimum":0,"type":"integer"},"period_num":{"description":"周期数。","format":"int32","maximum":2147483647,"minimum":0,"type":"integer"},"period_type":{"description":"周期类型,2:包月;3:包年。","format":"int32","maximum":255,"minimum":0,"type":"integer"},"resize_product_id":{"description":"变更后规格产品ID,当是resizeDesktops,必传。","maxLength":255,"minLength":1,"type":"string"},"type":{"description":"类型 resizeDesktops(变更规格)、expandVolumes(扩容磁盘)。","maxLength":255,"minLength":1,"type":"string"}},"required":["type"]},"CreateOrderRsp":{"description":"创建订单响应体。","properties":{"order_id":{"description":"订单号,下单成功时返回订单ID。","readOnly":true,"type":"string"}}},"OrderExtendParam":{"description":"订单的扩展参数。","properties":{"is_auto_pay":{"description":"是否自动付款。true:自动支付; false:不自动支付;默认false。","maxLength":255,"minLength":0,"type":"string"}}}},"description":null,"group_id":"7383c32d5d5e4d0481c071faeb994404","host":"workspace.cn-north-4.myhuaweicloud.com","id":"531d025a5270446ea7c53e0ceadb4403","info_version":"v2","method":"post","name":"CreateChangeOrder","parameters":{},"paths":{"/v2/{project_id}/periodic/{desktop_id}/change/order":{"post":{"consumes":["application/json"],"description":"变更规格、扩容磁盘。","operationId":"CreateChangeOrder","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":"桌面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"},{"description":"创建变更请求体。","in":"body","name":"CreateChangeOrderRequestBody","required":true,"schema":{"$ref":"#/definitions/CreateChangeOrderReq"}},{"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"}],"produces":["application/json"],"responses":{"200":{"description":"创建订单相应体。","examples":{"application/json":{"order_id":"CS2108102036B2CAI"}},"schema":{"$ref":"#/definitions/CreateOrderRsp"}},"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.PROJECT, abacAction = \"workspace:orders:change\",  needApigwJwtAuthCheck = false, needRbacCheck = false, authContextInitializerName = \"changeOrdersAuthContextInitializer\")","@CtsMeta(serviceType = \"Workspace\", resourceType = \"workspace\", traceName = \"createChangeOrder\")"],"x-request-examples-1":{"resize_product_id":"workspacehost.k.large4","type":"resizeDesktops"},"x-request-examples-text-1":{"resize_product_id":"workspacehost.k.large4","type":"resizeDesktops"},"x-request-examples-url-1":"/v2/0bec5db98280d2d02fd6c00c2de791ce/periodic/f8f7fe7a-9043-44ff-815e-ad20fc779d18/change/order","x-support-isv":"ZR","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"}