• Workspace

workspace
  1. Help Center
  2. Workspace
  3. API Reference
  4. Product Packages
  5. Querying the Product List

Querying the Product List

Function

This interface is used to query the product packages supported by Workspace.

URI

  • URI format

    GET /v1.0/{project_id}/products

  • URI parameter description

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    string

    Specifies the user ID.

  • Retrieval parameter description

    Parameter

    Mandatory

    Type

    Description

    availability_zone

    No

    string

    Specifies an AZ. You can obtain the AZ information from Regions and Endpoints.

Request

  • Request example
GET /v1.0/29dfe82ada564ac2b927e1ff036d9a9b/products?availability_zone=ab-cd

Response

  • Elements

    Name

    Type

    Description

    products

    List data structure [1]

    Specifies the product packages supported by Workspace.

[1] products field data structure description

Name

Type

Description

product_id

string

Specifies the product package ID.

flavor_id

string

Specifies the specification ID.

type

string

Specifies the product type.

  • BASE: indicates the basic product package. Except the operating system, no other commercial software is installed on the product image. In the private image scenario, you can use this package only.
  • ADVANCED: indicates the advanced product package. Some commercial software is installed on the product image.

os_type

string

Specifies the OS type of the product package, for example, Windows Server 2008 R2.

descriptions

string

Specifies the detailed product package information.

  • Response example
    {
        "products": [{
            "product_id": "workspace.s.large.windows",
            "flavor_id": "computev2-2",
            "type": "BASE",
            "os_type": "Windows Server 2008 R2",
            "descriptions": "CPU:2vCPUs,Memory:4GB,Operating System:Windows Server 2008 R2 64bit with windows 7 experience"
        },
        {
            "product_id": "workspace.s2.large.2.windows",
            "flavor_id": "computev2-2",
            "type": "BASE",
            "os_type": "Windows Server 2016",
            "descriptions": "CPU:2vCPUs,Memory:4GB,Operating System:Windows Server 2016 64bit with windows 10 experience"
        },
        {
            "product_id": "workspace.g1.2xlarge.windows",
            "flavor_id": "g1.2xlarge",
            "type": "BASE",
            "os_type": "Windows Server 2008 R2",
            "descriptions": "CPU:8vCPUs,Memory:16GB,Operating System:Windows Server 2008 R2 64bit with windows 7 experience,GPU:M60-1Q(1GB)"
        }]
    }

Returned Values

  • Normal

    200

  • Abnormal

    Returned Value

    Description

    400 Bad Request

    The request syntax is incorrect and cannot be understood by the server.

    401 Unauthorized

    Authentication fails.

    403 Forbidden

    You are not authorized to perform the operation.

    404 Not Found

    The requested resource is not found.

    405 Method Not Allowed

    The method specified in the request is not allowed.

    500 Internal Server Error

    Internal service error. For details about error codes, see Error Code Description.

    503 Service Unavailable

    The service is unavailable.