Help Center/Host Security Service/API Reference/API Description/Quota Management/Querying Product and Offering Information
Updated on 2026-04-03 GMT+08:00
View PDF
Share

Querying Product and Offering Information

Function

This API is used to query product and offering information.

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, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/product/productdata/offering-infos

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

ID of the enterprise project that a server belongs.

An enterprise project can be configured only after the enterprise project function is enabled.

Enterprise project ID. The value 0 indicates the default enterprise project. To query servers in all enterprise projects, set this parameter to all_granted_eps. If you have only the permission on an enterprise project, you need to transfer the enterprise project ID to query the server in the enterprise project. Otherwise, an error is reported due to insufficient permission.

site_code

No

String

Site information.

  • HWC_CN: Chinese mainland

  • HWC_HK: international

  • HWC_EU: Europe

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

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 a user token.

region

No

String

Region ID

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

[items]

Array of ResourceProductDataObjectInfo objects

Offering Data List

Table 5 ResourceProductDataObjectInfo

Parameter

Type

Description

charging_mode

String

Billing modes

  • packet_cycle: yearly/monthly

  • on_demand: pay-per-use

is_auto_renew

Boolean

Whether to enable automatic renewal.

version_info

Map<String,Array<ShowPeriodResponseInfo>>

Version information. The value of the key is the edition enabled by the server. The options are as follows:

  • hss.version.basic: basic edition

  • hss.version.advanced: professional edition

  • hss.version.enterprise: enterprise edition

  • hss.version.premium: premium edition

  • hss.version.wtp: WTP edition

  • hss.version.container.enterprise: container edition

Table 6 ShowPeriodResponseInfo

Parameter

Type

Description

period_vals

String

Value string of the required duration. Multiple values are separated by commas (,). For example: 1,2,3,4,5,6,7,8,9

period_unit

String

Required duration unit

  • year:

  • month

  • day:

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

[ {
  "charging_mode" : "packet_cycle",
  "is_auto_renew" : false,
  "version_info" : {
    "hss.version.enterprise" : [ {
      "period_vals" : "1,2,3,4,5,6,7,8,9",
      "period_unit" : "month"
    }, {
      "period_vals" : "1,2,3,5",
      "period_unit" : "year"
    } ],
    "hss.version.premium" : [ {
      "period_vals" : "1,2,3,4,5,6,7,8,9",
      "period_unit" : "month"
    }, {
      "period_vals" : "1,2,3,5",
      "period_unit" : "year"
    } ]
  }
}, {
  "charging_mode" : "on_demand",
  "is_auto_renew" : false,
  "version_info" : {
    "hss.version.enterprise" : [ {
      "period_vals" : "1,2,3,4,5,6,7,8,9",
      "period_unit" : "month"
    }, {
      "period_vals" : "1,2,3,5",
      "period_unit" : "year"
    } ]
  }
} ]

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Quota Management