Help Center/ Workspace/ API Reference/ Workspace Application Streaming APIs/ Product Package Management/ Querying Application Streaming Packages
Updated on 2026-05-21 GMT+08:00
View PDF
Share

Querying Application Streaming Packages

Function

Queries Application Streaming packages by filtering based on conditions.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    workspace:baseResource:list

    List

    -

    -

    -

    -

URI

GET /v1/{project_id}/product

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Unique ID of a project
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

product_id

No

String

If this parameter is not left empty, data is filtered by product ID and returned.

flavor_id

No

String

If this parameter is not left empty, data is filtered by specification ID and returned.

availability_zone

No

String

AZ. If this parameter is not left empty, data is filtered by AZ and returned.

  • For details about AZs, see ListAvailabilityZone: "GET /v1/{project_id}/availability-zone". For details about AZs, see ListAvailabilityZone: "GET /v1/{project_id}/availability-zone/summary".

os_type

No

String

OS of a product package. Currently, Windows is supported.

  • Linux

  • Windows

  • Other.

charge_mode

No

String

Package ID.

  • 1: yearly/monthly

  • 0: pay-per-use

architecture

No

String

Architecture type. Currently, x86 is supported.

  • x86

  • arm

package_type

No

String

Package type:

  • general: general package

  • dedicated: dedicated host package

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

availability_zone

String

AZ. Creates a service in a specified AZ. If this parameter is not specified, a random AZ will be used.

os_type

String

OS type. Only Windows is supported.

  • Linux

  • Windows

  • Other

products

Array of ProductInfo objects

Product list.
Table 5 ProductInfo

Parameter

Type

Description

product_id

String

Product ID.

flavor_id

String

Specification ID.

type

String

Product type.

  • BASE: basic product package. OS is the only commercial software product in the package. Only this type of package can be used for private images.

  • ADVANCED: advanced product package. The package image contains some commercial software products.

architecture

String

Product architecture. Currently, only x86 is supported.

  • x86

  • arm.

cpu

String

CPU.

cpu_desc

String

CPU description.

memory

String

Memory size, in MB.

is_gpu

Boolean

Whether the specifications are of the GPU type.

system_disk_type

String

System disk type.

system_disk_size

String

System disk size.

gpu_desc

String

GPU description.

descriptions

String

Product description.

charge_mode

String

Package ID.

  • 1: yearly/monthly

  • 0: pay-per-use

contain_data_disk

Boolean

Whether data disks are included in the package billing.

resource_type

String

Resource type.

cloud_service_type

String

Cloud service type.

volume_product_type

String

Disk type.

  • workspace

sessions

Integer

Maximum number of sessions supported by a package by default.

status

String

Status of a product package in sales mode. The value is from cond:operation:status of ECS.

If this parameter is not set, its default value is normal.

normal: in normal commercial use.

abandon: offline (not displayed).

sellout: sold out.

obt: under open beta testing (OBT).

obt_sellout: sold out under OBT.

promotion: recommended (equivalent to normal, also for commercial use).

cond_operation_az

String

Status of a product package in an AZ. This parameter is used together with status.

NOTE:

  • This parameter takes effect AZ-wide. If an AZ is not configured in this parameter, the value of the parameter status is used by default. Otherwise, this parameter is used.

  • Format: az(xx). The value in parentheses is the flavor status of the AZ. If the parentheses are left blank, the configuration is invalid.

  • For example, a package is in commercial use in AZ 0 and AZ 3, sold out in AZ 1, in OBT in AZ 2, and out of service in other AZs. Then, configure parameters as follows:

  • status: abandon

  • "cond_operation_az": az0(normal), az1(sellout), az2(obt), az3(normal)

  • Note: This parameter is mandatory if the flavor status in an AZ is different from the configured status.

sub_product_list

Array of strings

Subproducts of a DeH.

domain_ids

Array of strings

Dedicated domainId of the product.

package_type

String

Package type:

  • general: general package

  • dedicated: dedicated host package

series_type

String

Series type.

  • d7

  • c7

expire_time

String

Expiration time of a product package. Products will be gradually brought offline after this time.

support_gpu_type

String

GPU types supported by the product package.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 405

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 503

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Example Requests

GET /v1/29dfe82ada564ac2b927e1ff036d9a9b/product

Example Responses

Status code: 200

Response to a successful request.

{
  "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 Application Streaming General-Purpose | 4 vCPUs | 8 GB memory",
    "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"
  } ]
}

Status Codes

Status Code

Description

200

Response to a successful request.

400

The request cannot be understood by the server due to malformed syntax.

401

Authentication failed.

403

Permissions required.

404

Resources not found.

405

The method specified in the request is not allowed.

500

An internal service error occurred. For details, see the error code description.

503

Service unavailable.

Error Codes

See Error Codes.