Help Center/ Workspace/ API Reference/ Workspace APIs/ Product Packages/ Querying Hourly Package Types That Can Be Subscribed To
Updated on 2025-07-14 GMT+08:00

Querying Hourly Package Types That Can Be Subscribed To

Function

Queries hourly package types that can be subscribed to.

Debugging

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

URI

GET /v2/{project_id}/products/hour-packages

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

desktop_resource_spec_code

No

String

Resource specification code of the pay-per-use desktop of the hourly package.

resource_spec_code

No

String

Resource specification code of the hourly 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

hour_packages

Array of HourPackage objects

Hourly package types that can be subscribed to.

total_count

Integer

Total number of AZs where Huawei Cloud Workspace is available.

Table 5 HourPackage

Parameter

Type

Description

cloud_service_type

String

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

resource_type

String

Resource type.

resource_spec_code

String

Resource specification code of the hourly package.

desktop_resource_spec_code

String

Resource specification code of the pay-per-use desktop of the hourly package.

descriptions

ResourcePackageDescription object

Product descriptions.

package_duration

Integer

Available duration of the package, in hour.

domain_ids

Array of strings

ID of the dedicated domain (domainId) supported by the product package.

status

String

Product status. The options are normal, sellout, and abandon.

Table 6 ResourcePackageDescription

Parameter

Type

Description

zh_cn

String

Description in Chinese.

en_us

String

Description in English.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 405

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 503

Table 13 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

None

Example Responses

Status code: 200

Response to the request for querying hourly package types that can be subscribed to.

{
  "hour_packages" : [ {
    "cloud_service_type" : "string",
    "resource_type" : "string",
    "resource_spec_code" : "string",
    "desktop_resource_spec_code" : "string",
    "descriptions" : {
      "zh_cn" : "string",
      "en_us" : "string"
    },
    "package_duration" : 0,
    "domain_ids" : [ "string" ],
    "status" : "normal"
  } ],
  "total_count" : 0
}

Status Codes

Status Code

Description

200

Response to the request for querying hourly package types that can be subscribed to.

400

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

401

Authentication failed.

403

No operation permissions.

404

No resources 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.