{"base_path":null,"components":null,"consumes":"[\"application/json\"]","definitions":{"BadRequestErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00211102","readOnly":true,"type":"string"},"error_msg":{"description":"错误描述。","example":"The parameter is invalid.","readOnly":true,"type":"string"}}},"ForbiddenErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00081102","readOnly":true,"type":"string"},"error_msg":{"description":"错误描述。","example":"User does not have permission to access this resource.","readOnly":true,"type":"string"}}},"InternalServerErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00211401","readOnly":true,"type":"string"},"error_msg":{"description":"错误描述。","example":"The requested operation failed. Please try again later.","readOnly":true,"type":"string"}}},"MethodNotAllowedErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00000405","readOnly":true,"type":"string"},"error_msg":{"description":"错误描述。","example":"The method specified in the request is not allowed for this resource.","readOnly":true,"type":"string"}}},"NotFoundErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00211902","readOnly":true,"type":"string"},"error_msg":{"description":"错误描述。","example":"The application does not exist","readOnly":true,"type":"string"}}},"ProductDetailInfo":{"properties":{"architecture":{"description":"产品架构,当前仅支持x86。\n- x86\n- arm","example":"x86","maxLength":255,"minLength":1,"type":"string"},"charge_mode":{"description":"套餐标识。\n- 1:表示包周期。\n- 0:表示按需。","maxLength":1,"minLength":0,"type":"string","x-hcs-ignore":true},"cloud_service_type":{"description":"云服务类型。","example":"hws.service.type.xxxxx","maxLength":255,"minLength":0,"type":"string"},"cond_operation_az":{"description":"产品套餐在可用区的状态,配套status使用。\n> - 此参数是AZ级配置,优选取此参数的值,某个AZ没有在此参数中配置时默认使用status参数的取值。\n> - 配置格式“az(xx)”。()内为某个AZ的flavor状态,()内必须要填有状态,不填为无效配置。\n> - 例如:套餐在某个region的az0正常商用,az1售罄,az2公测,az3正常商用,其他az显示下线,可配置为:\n> - “status”设置为:“abandon” 。\n> - “cond_operation_az”设置为:“az0(normal), az1(sellout), az2(obt), az3(normal)”。 \n> - 说明:如果flavor在某个AZ下的状态与status配置状态不同,必须配置该参数。","example":"cn-north-5a(normal),cn-north-5b(abandon),cn-north-5c(sellout)","minLength":0,"type":"string"},"contain_data_disk":{"description":"套餐计费是否包含了数据盘。","example":false,"type":"boolean"},"cpu":{"description":"CPU。","example":"2","maxLength":255,"minLength":1,"type":"string"},"cpu_desc":{"description":"CPU描述。","example":"云应用通用型|4核|8GB内存","maxLength":255,"minLength":0,"type":"string"},"descriptions":{"description":"产品描述。","example":"GPU图形加速DG4型|32核128G内存32G显存|P02","maxLength":255,"minLength":1,"type":"string"},"domain_ids":{"description":"产品属于专有的domainId。","example":["xxx","xxxx"],"items":{"maxLength":255,"minLength":0,"type":"string"},"maxItems":100,"minItems":0,"type":"array","x-maxLength":100,"x-minLength":0},"expire_time":{"description":"产品套餐过期时间,产品将在该时间点后逐步下架。","example":"2022-03-07T10:40:43Z","format":"date-time","readOnly":true,"type":"string"},"flavor_id":{"description":"规格ID。","example":"c3.large.4","maxLength":255,"minLength":1,"type":"string"},"gpu_desc":{"description":"GPU描述。","example":"GPU图形加速","maxLength":255,"minLength":0,"type":"string"},"is_gpu":{"description":"是否是GPU类型的规格。","example":false,"type":"boolean"},"memory":{"description":"内存大小,单位兆:MB。","example":"4096","maxLength":255,"minLength":1,"type":"string"},"package_type":{"description":"套餐类型:\n- general:表示产品通用套餐。\n- dedicated:表示产品专属主机套餐。","example":"general","maxLength":64,"minLength":0,"type":"string"},"product_id":{"description":"产品id。","example":"workspace.appstream.general.2xlarge.4","maxLength":128,"minLength":1,"type":"string"},"resource_type":{"description":"资源类型。","example":"hws.resource.type.xxxx.vm","maxLength":255,"minLength":0,"type":"string"},"series_type":{"description":"系列类型:\n- d7\n- c7","example":"c6","maxLength":64,"minLength":0,"type":"string"},"sessions":{"description":"套餐默认支持的最大会话数。","example":2,"readOnly":true,"type":"integer"},"status":{"description":"产品套餐在销售模式下的状态,取值自ECS的cond:operation:status。\n不配置时等同于normal在售状态。\n* `normal` - 正常商用\n* `abandon` - 下线(即不显示)\n* `sellout` - 售罄\n* `obt` - 公测\n* `obt_sellout` - 公测售罄\n* `promotion` - 推荐(等同normal,也是商用)","maxLength":16,"minLength":0,"type":"string"},"sub_product_list":{"description":"专属主机的子产品。","example":["xxx","xxxx"],"items":{"maxLength":255,"minLength":0,"type":"string"},"maxItems":100,"minItems":0,"type":"array","x-maxLength":100,"x-minLength":0},"support_gpu_type":{"description":"产品套餐支持的GPU类型。","example":"A40","format":"支持的GPU类型","readOnly":true,"type":"string"},"system_disk_size":{"default":"80","description":"系统盘大小。","example":"80","maxLength":10,"minLength":0,"type":"string"},"system_disk_type":{"default":"SAS","description":"系统盘类型。","example":"SAS","maxLength":32,"minLength":0,"type":"string"},"type":{"description":"产品类型。\n- BASE:表示产品基础套餐,套餐镜像中不包括除操作系统之外的其他商业软件,私有镜像场景只能使用此类套餐。\n- ADVANCED:表示产品高级套餐,套餐镜像中包括了一些商业软件。","example":"BASE","maxLength":55,"minLength":1,"type":"string"},"volume_product_type":{"description":"磁盘产品类型:\n- workspace","example":"workspace","maxLength":255,"minLength":0,"type":"string"}},"type":"object"},"QueryProductsResp":{"description":"查询套餐响应实体类。","properties":{"availability_zone":{"description":"可用分区。将服务创建到指定的可用分区。如果不指定则使用系统随机的可用分区。","example":"az3.manage.x86","maxLength":255,"minLength":0,"type":"string"},"os_type":{"description":"系统类型,当前仅支持Windows。\n* `Linux` -\n* `Windows` -\n* `Other` -","readOnly":true,"type":"string"},"products":{"description":"产品列表。","items":{"$ref":"#/definitions/ProductDetailInfo"},"maxItems":100,"minItems":0,"type":"array","x-maxLength":100,"x-minLength":0}},"type":"object"},"ServiceUnavailableErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00050902","readOnly":true,"type":"string"},"error_msg":{"description":"错误描述。","example":"The service is now unavailable to process the request.","readOnly":true,"type":"string"}}},"UnauthorizedErrorResp":{"description":"API错误响应。","properties":{"error_code":{"description":"错误码,失败时返回。","example":"WKS.00211302","readOnly":true,"type":"string"},"error_msg":{"description":"错误描述。","example":"User authorization error.","readOnly":true,"type":"string"}}}},"description":null,"group_id":"fe7dbee2e20f4aa589be7dce935a38ad","host":"appstream.cn-north-4.myhuaweicloud.com","id":"7139a6ec1cdd44d59320cd4c503c7dc9","info_version":"v1","method":"get","name":"ListProduct","parameters":{},"paths":{"/v1/{project_id}/product":{"get":{"consumes":["application/json"],"description":"查询云应用套餐,按照条件过滤。","operationId":"ListProduct","parameters":[{"description":"用户Token。\n通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","maxLength":2147483647,"minLength":0,"name":"X-Auth-Token","required":false,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..."},{"description":"项目唯一标识。","in":"path","maxLength":128,"minLength":1,"name":"project_id","required":true,"type":"string","x-example":"2b31ed520xxxxxxebedb6e57xxxxxxxx"},{"description":"如果不为空,将按产品ID进行过滤后返回。","in":"query","maxLength":255,"minLength":0,"name":"product_id","required":false,"type":"string"},{"description":"如果不为空,将按规格ID进行过滤后返回。","in":"query","maxLength":255,"minLength":0,"name":"flavor_id","required":false,"type":"string"},{"description":"可用分区,如果不为空,将按可用分区进行过滤后返回。\n-","in":"query","maxLength":255,"minLength":0,"name":"availability_zone","required":false,"type":"string"},{"description":"产品套餐的操作系统类型,当前支持:Windows。\n- Linux\n- Windows\n- Other","in":"query","maxLength":255,"minLength":0,"name":"os_type","required":false,"type":"string"},{"description":"套餐标识。\n- 1:表示包周期。\n- 0:表示按需。","in":"query","maxLength":255,"minLength":0,"name":"charge_mode","required":false,"type":"string","x-hcs-ignore":true},{"description":"架构类型,当前支持:x86。\n- x86\n- arm","in":"query","maxLength":255,"minLength":0,"name":"architecture","required":false,"type":"string"},{"description":"套餐类型:\n- general:表示产品通用套餐。\n- dedicated:表示产品专属主机套餐。","in":"query","maxLength":255,"minLength":0,"name":"package_type","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"成功响应。","examples":{"application/json":{"products":[{"architecture":"x86","charge_mode":"0","cloud_service_type":"hws.service.type.vdi","cond_operation_az":"cn-north-7c(abandon),cn-north-7b(abandon),cn-north-7a(sellout)","cpu":"4","descriptions":"s2.xlarge.2 云应用通用型|4核|8GB内存","domain_ids":[],"flavor_id":"s2.xlarge.2","is_gpu":false,"memory":"8192","package_type":"general","product_id":"workspace.appstream.general.2xlarge.2","resource_type":"hws.resource.type.workspace.appstream","sessions":10,"status":"abandon","type":"BASE","volume_product_type":"workspace"}]}},"schema":{"$ref":"#/definitions/QueryProductsResp"}},"400":{"description":"由于包含语法错误,当前请求无法被服务器理解。","schema":{"$ref":"#/definitions/BadRequestErrorResp"}},"401":{"description":"鉴权失败。","schema":{"$ref":"#/definitions/UnauthorizedErrorResp"}},"403":{"description":"没有操作权限。","schema":{"$ref":"#/definitions/ForbiddenErrorResp"}},"404":{"description":"找不到资源。","schema":{"$ref":"#/definitions/NotFoundErrorResp"}},"405":{"description":"请求中指定的方法不被允许。","schema":{"$ref":"#/definitions/MethodNotAllowedErrorResp"}},"500":{"description":"服务内部错误,具体返回错误码请参见错误码说明。","schema":{"$ref":"#/definitions/InternalServerErrorResp"}},"503":{"description":"服务不可用。","schema":{"$ref":"#/definitions/ServiceUnavailableErrorResp"}}},"security":[{"apig-auth-iam-used-authn5":[]}],"summary":"查询云应用套餐","tags":["ApplicationProduct"],"x-api-type":"open-api","x-apiexplorer-hide":"N","x-apig-group":"internal,public","x-apigateway-backend":{"httpVpcEndpoints":{"description":"","method":"GET","name":"wks-bundlemanager-lb","path":"/v1/{project_id}/product","scheme":"https","timeout":30000},"parameters":[{"description":"","in":"header","name":"X-Auth-Token","origin":"request","value":"X-Auth-Token"},{"description":"","in":"path","name":"project_id","origin":"request","value":"project_id"},{"description":"产品ID,如果不为空,将按产品ID进行过滤后返回。","in":"query","name":"product_id","origin":"request","value":"product_id"},{"description":"可用分区。","in":"query","name":"availability_zone","origin":"request","value":"availability_zone"},{"description":"产品套餐的操作系统类型,当前支持:Windows\n- Linux\n- Windows\n- Other","in":"query","name":"os_type","origin":"request","value":"os_type"},{"description":"套餐标识。\n- 1:表示包周期。\n- 0:表示按需。","in":"query","name":"charge_mode","origin":"request","value":"charge_mode","x-hcs-ignore":true},{"description":"架构类型,当前仅支持:x86。","in":"query","name":"architecture","origin":"request","value":"architecture"},{"description":"套餐类型:\n- general:表示产品通用套餐。\n- dedicated:表示产品专属主机套餐。","in":"query","name":"package_type","origin":"request","value":"package_type"}],"type":"HTTP-VPC"},"x-apigateway-cors":false,"x-apigateway-match-mode":"NORMAL","x-apigateway-ratelimit":"workspace_default_get","x-apigateway-request-type":"public","x-is-registered":"Y","x-request-examples-url-1":"GET /v1/29dfe82ada564ac2b927e1ff036d9a9b/product","x-support-hcs":"Y","x-support-sdk":"Y"}}},"product_short":"WorkspaceApp","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"}