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

Querying Session Packages (discarded)

Function

Queries session packages.

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

POST /v1/{project_id}/session-type

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Unique ID of a project

Request Parameters

Table 2 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.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

resource_spec_code

No

String

Resource specification code.

session_type

No

String

Session type.

  • CPU

  • GPU

resource_type

No

String

Resource type.

-hws.resource.type.workspace.volume: Workspace desktop disk

-hws.resource.type.workspace.desktop: Workspace desktop

-hws.resource.type.workspace.appstream: Workspace Application Streaming

-hws.resource.type.workspace.appstreamsession: Workspace Application Streaming multi-session

cloud_service_type

No

String

Code of the cloud service type to which the resource belongs.

  • hws.service.type.vdi

  • hws.service.type.marketplace

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

session_types

Array of SessionTypeEntity objects

Session list.
Table 5 SessionTypeEntity

Parameter

Type

Description

resource_spec_code

String

Resource specification code.

session_type

String

Session type.

  • CPU

  • GPU

resource_type

String

Resource type.

-hws.resource.type.workspace.volume: Workspace desktop disk

-hws.resource.type.workspace.desktop: Workspace desktop

-hws.resource.type.workspace.appstream: Workspace Application Streaming

-hws.resource.type.workspace.appstreamsession: Workspace Application Streaming multi-session

cloud_service_type

String

Code of the cloud service type to which the resource belongs.

  • hws.service.type.vdi

  • hws.service.type.marketplace

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

POST /v1/29dfe82ada564ac2b927e1ff036d9a9b/session-type

Example Responses

Status code: 200

Queries the name (fuzzy match).

{
  "session_types" : [ {
    "resource_spec_code" : "workspace.appstreamsession.premium",
    "session_type" : "GPU",
    "resource_type" : "hws.resource.type.workspace.appstreamsession",
    "cloud_service_type" : "hws.service.type.vdi"
  }, {
    "resource_spec_code" : "workspace.appstreamsession.standard",
    "session_type" : "CPU",
    "resource_type" : "hws.resource.type.workspace.appstreamsession",
    "cloud_service_type" : "hws.service.type.vdi"
  } ]
}

Status Codes

Status Code

Description

200

Queries the name (fuzzy match).

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.