查询产品套餐列表 - ListProducts

功能介绍

该接口用于查询云桌面支持的产品套餐列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v2/{project_id}/products

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。

表2 Query参数
参数	是否必选	参数类型	描述
product_id	否	String	产品ID。指定该参数会返回支持变更规格的套餐信息。
availability_zone	否	String	可用分区。
os_type	否	String	产品套餐的操作系统类型，当前支持：Windows、Linux。
charge_mode	否	String	周期套餐标识。0表示包周期，1表示按需。
architecture	否	String	架构类型，当前支持：arm、x86。
package_type	否	String	套餐系列。
limit	否	Integer	每页数量，范围0-100，默认100。
offset	否	Integer	偏移量，默认0。

请求参数

无

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
os_type	String	套餐所支持操作系统类型。请求参数有os_type时，才有此参数。
architecture	String	产品架构。请求参数有package_type=agile时，才有此参数。
availability_zone	String	可用分区。请求参数有availability_zone时，才有此参数。
products	Array of Product objects	产品列表。
total_count	Integer	对象总数。

表4 Product
参数	参数类型	描述
product_id	String	产品id。
type	String	产品类型。取值为： BASE：表示产品基础套餐，套餐镜像中不包括除操作系统之外的其他商业软件，私有镜像场景只能使用此类套餐。
architecture	String	产品架构，当前支持：arm、x86。
cpu	String	cpu。
cpu_desc	String	cpu描述。
memory	String	内存。
is_gpu	Boolean	是否是GPU类型的规格。
vram	String	显存大小，单位GB。
system_disk_type	String	系统盘类型。
system_disk_size	String	系统盘大小，单位GB。
data_disk_size	String	数据盘大小，单位GB。
gpu_desc	String	GPU描述。
bill_switch	String	话单开关，默认on,on-出话单模式,off-关话单模式,只支持反序列化，不支持序列化，不在接口中展示。
descriptions	String	产品描述。
product_desc	Map<String,String>	产品名称<语言，各语言对应的产品描述>。
charge_mode	String	周期套餐标识。0表示包周期，1表示按需。
contain_data_disk	Boolean	套餐计费是否包含了数据盘,off-不包含。
resource_type	String	资源规格。
cloud_service_type	String	云服务编码。
volume_product_type	String	磁盘产品类型。
domain_ids	Array of strings	该产品套餐支持的专有域id（domainId）。
status	String	产品状态，normal：正常、sellout：售空、abandon：下线。
package_type	String	套餐类型。 ultimate：尊享版 enterprise：企业版 general: 通用办公版 workstation: 云工作站 dedicated: 专属办公版 solver: 解算版 agile: 敏捷办公版
name	Map<String,String>	产品名称<语言，各语言对应的产品名>。
share_space_size	Integer	协同方数。该套餐支持的最大协同人数。

状态码：400

表5 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：401

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：403

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：404

表8 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：405

表9 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：500

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：503

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

GET /v2/0e3f393ae380f5d12facc005678bcd4b/products

响应示例

状态码：200

查询产品列表响应。

{
  "products" : [ {
    "product_id" : "workspace.x86.ultimate.large2",
    "type" : "BASE",
    "architecture" : "x86",
    "cpu" : "2",
    "memory" : "4096",
    "is_gpu" : false,
    "system_disk_type" : "SAS",
    "system_disk_size" : "140",
    "bill_switch" : "on",
    "descriptions" : "尊享办公|2核|4GB内存",
    "charge_mode" : "0",
    "contain_data_disk" : false,
    "resource_type" : "hws.resource.type.workspace.desktop",
    "cloud_service_type" : "hws.service.type.vdi",
    "volume_product_type" : "workspace",
    "domain_ids" : [ ],
    "status" : "normal",
    "package_type" : "ultimate",
    "name" : {
      "en_us" : "Ultimate Desktop",
      "zh_cn" : "尊享办公型"
    }
  } ],
  "total_count" : 1
}

状态码

状态码	描述
200	查询产品列表响应。
400	由于包含语法错误，当前请求无法被服务器理解。
401	鉴权失败。
403	没有操作权限。
404	找不到资源。
405	请求中指定的方法不被允许。
500	服务内部错误，具体返回错误码请参见错误码说明。
503	服务不可用。