# 查询云应用套餐 - ListProduct #### 功能介绍 查询云应用套餐，按照条件过滤。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/WorkspaceApp/doc?api=ListProduct)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-workspace/workspace_09_0128.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | workspace:baseResource:list | List | - | - | - | - | #### URI GET /v1/{project_id}/product 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目唯一标识。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | product_id | 否 | String | 如果不为空，将按产品ID进行过滤后返回。 | | flavor_id | 否 | String | 如果不为空，将按规格ID进行过滤后返回。 | | availability_zone | 否 | String | 可用分区，如果不为空，将按可用分区进行过滤后返回。 - 获取方式详见可用区管理ListAvailabilityZone："GET /v1/{project_id}/availability-zone"。获取方式详见可用区管理ListAvailabilityZone："GET /v1/{project_id}/availability-zone/summary"。 | | os_type | 否 | String | 产品套餐的操作系统类型，当前支持：Windows。 - Linux - Windows - Other | | charge_mode | 否 | String | 套餐标识。 - 1：表示包周期。 - 0：表示按需。 | | architecture | 否 | String | 架构类型，当前支持：x86。 - x86 - arm | | package_type | 否 | String | 套餐类型： - general：表示产品通用套餐。 - dedicated：表示产品专属主机套餐。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | availability_zone | String | 可用分区。将服务创建到指定的可用分区。如果不指定则使用系统随机的可用分区。 | | os_type | String | 系统类型，当前仅支持Windows。 - *Linux* - - *Windows* - - *Other* - | | products | Array of [ProductDetailInfo] objects | 产品列表。 | 表5ProductDetailInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | product_id | String | 产品id。 | | flavor_id | String | 规格ID。 | | type | String | 产品类型。 - BASE：表示产品基础套餐，套餐镜像中不包括除操作系统之外的其他商业软件，私有镜像场景只能使用此类套餐。 - ADVANCED：表示产品高级套餐，套餐镜像中包括了一些商业软件。 | | architecture | String | 产品架构，当前仅支持x86。 - x86 - arm | | cpu | String | CPU。 | | cpu_desc | String | CPU描述。 | | memory | String | 内存大小，单位兆：MB。 | | is_gpu | Boolean | 是否是GPU类型的规格。 | | system_disk_type | String | 系统盘类型。 | | system_disk_size | String | 系统盘大小。 | | gpu_desc | String | GPU描述。 | | descriptions | String | 产品描述。 | | charge_mode | String | 套餐标识。 - 1：表示包周期。 - 0：表示按需。 | | contain_data_disk | Boolean | 套餐计费是否包含了数据盘。 | | resource_type | String | 资源类型。 | | cloud_service_type | String | 云服务类型。 | | volume_product_type | String | 磁盘产品类型： - workspace | | sessions | Integer | 套餐默认支持的最大会话数。 | | status | String | 产品套餐在销售模式下的状态，取值自ECS的cond:operation:status。 不配置时等同于normal在售状态。 - *normal* - 正常商用 - *abandon* - 下线（即不显示） - *sellout* - 售罄 - *obt* - 公测 - *obt_sellout* - 公测售罄 - *promotion* - 推荐(等同normal，也是商用) | | cond_operation_az | String | 产品套餐在可用区的状态，配套status使用。 说明： - 此参数是AZ级配置，优选取此参数的值，某个AZ没有在此参数中配置时默认使用status参数的取值。 - 配置格式"az(xx)"。()内为某个AZ的flavor状态，()内必须要填有状态，不填为无效配置。 - 例如：套餐在某个region的az0正常商用，az1售罄，az2公测，az3正常商用，其他az显示下线，可配置为： - "status"设置为："abandon" 。 - "cond_operation_az"设置为："az0(normal), az1(sellout), az2(obt), az3(normal)"。 - 说明：如果flavor在某个AZ下的状态与status配置状态不同，必须配置该参数。 | | sub_product_list | Array of strings | 专属主机的子产品。 | | domain_ids | Array of strings | 产品属于专有的domainId。 | | package_type | String | 套餐类型： - general：表示产品通用套餐。 - dedicated：表示产品专属主机套餐。 | | series_type | String | 系列类型： - d7 - c7 | | expire_time | String | 产品套餐过期时间,产品将在该时间点后逐步下架。 | | support_gpu_type | String | 产品套餐支持的GPU类型。 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | **状态码：401** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | **状态码：403** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | **状态码：404** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | **状态码：405** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | **状态码：500** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | **状态码：503** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | #### 请求示例 ``` GET /v1/29dfe82ada564ac2b927e1ff036d9a9b/product ``` #### 响应示例 **状态码：200** 成功响应。 ``` { "products" : [ { "product_id" : "workspace.appstream.general.2xlarge.2", "flavor_id" : "s2.xlarge.2", "type" : "BASE", "architecture" : "x86", "cpu" : "4", "memory" : "8192", "is_gpu" : false, "descriptions" : "s2.xlarge.2 云应用通用型|4核|8GB内存", "charge_mode" : "0", "resource_type" : "hws.resource.type.workspace.appstream", "cloud_service_type" : "hws.service.type.vdi", "volume_product_type" : "workspace", "sessions" : 10, "status" : "abandon", "cond_operation_az" : "cn-north-7c(abandon),cn-north-7b(abandon),cn-north-7a(sellout)", "domain_ids" : [ ], "package_type" : "general" } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 成功响应。 | | 400 | 由于包含语法错误，当前请求无法被服务器理解。 | | 401 | 鉴权失败。 | | 403 | 没有操作权限。 | | 404 | 找不到资源。 | | 405 | 请求中指定的方法不被允许。 | | 500 | 服务内部错误，具体返回错误码请参见错误码说明。 | | 503 | 服务不可用。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-workspace/ErrorCode_0.html)。