Help Center/ SecMaster/ API Reference/ SecMaster APIs (V1)/ Metering and Billing/ Querying the SecMaster Offerings Available at the Current Site
Updated on 2025-12-18 GMT+08:00

Querying the SecMaster Offerings Available at the Current Site

Function

This API is used to query the SecMaster offerings available at the current site.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/subscriptions/products

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. You can obtain it by calling the IAM API for obtaining a user token. The token is the value of X-Subject-Token in the response header.

X-Language

Yes

String

Current environment language. zh-cn: simplified Chinese; en-us: English.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

basic

basic object

Product code object for the basic edition.

standard

standard object

Product code object for the standard edition.

professional

professional object

Product code object for the professional edition.

large_screen

large_screen object

Product code object for the large screen module.

log_collection

log_collection object

Product code object for log collection.

log_retention

log_retention object

Product code object for log retention.

log_analysis

log_analysis object

Product code object for log analysis.

soar

soar object

Product code object for the security orchestration module.

Table 4 basic

Parameter

Type

Description

cloud_service_type

String

Main service type of the cloud service product. The default value is hws.service.type.sa for SecMaster.

resource_type

String

Resource type code.

resource_spec_code

String

Resource specification code.

resource_size_measure_id

Integer

Resource capacity measurement ID.

usage_factor

String

Usage factor. This parameter is mandatory for pay-per-use billing. The value is the same as the usage factor in SDRs. The mappings between cloud services and usage factors are as follows:

Currently, SecMaster supports the following options:

duration: time. This is mainly used for the basic, standard, and professional editions.

count: times. This is mainly used for security orchestration.

flow: traffic. This is mainly used for log analysis and collection.

retention: retention. This is mainly used for log retention.

usage_measure_id

Integer

Usage measurement unit. This parameter is mandatory for a pay-per-use inquiry. For example, the resources are billed by the hour, the usage value is 1, and the usage measurement unit is hour. The options are:

4: hour

10: GB. Bandwidth usage is measured in GB based on traffic.

11: MB. Bandwidth usage is measured in MB based on traffic.

13: Byte. The bandwidth usage is measured by byte based on traffic.

region_id

String

Code of the current region. The default value is null, indicating the current region.

Table 5 standard

Parameter

Type

Description

cloud_service_type

String

Main service type of the cloud service product. The default value is hws.service.type.sa for SecMaster.

resource_type

String

Resource type code.

resource_spec_code

String

Resource specification code.

resource_size_measure_id

Integer

Resource capacity measurement ID.

usage_factor

String

Usage factor. This parameter is mandatory for pay-per-use billing. The value is the same as the usage factor in SDRs. The mappings between cloud services and usage factors are as follows:

Currently, SecMaster supports the following options:

duration: time. This is mainly for the basic, standard, and professional editions.

count: times. This is mainly used for security orchestration.

flow: traffic. This is mainly used for log analysis and collection.

retention: retention. This is mainly used for log retention.

usage_measure_id

Integer

Usage measurement unit. This parameter is mandatory for a pay-per-use inquiry. For example, the resources are billed by the hour, the usage value is 1, and the usage measurement unit is hour. The options are:

4: hour

10: GB. Bandwidth usage is measured in GB based on traffic.

11: MB. Bandwidth usage is measured in MB based on traffic.

13: Byte. The bandwidth usage is measured by byte based on traffic.

region_id

String

Code of the current region. The default value is null, indicating the current region.

Table 6 professional

Parameter

Type

Description

cloud_service_type

String

Main service type of the cloud service product. The default value is hws.service.type.sa for SecMaster.

resource_type

String

Resource type code.

resource_spec_code

String

Resource specification code.

resource_size_measure_id

Integer

Resource capacity measurement ID.

usage_factor

String

Usage factor. This parameter is mandatory for pay-per-use billing. The value is the same as the usage factor in SDRs. The mappings between cloud services and usage factors are as follows.

Currently, SecMaster supports the following options:

duration: time. This is mainly used for the basic, standard, and professional editions.

count: times. This is mainly used for security orchestration.

flow: traffic. This is mainly used for log analysis and collection.

retention: retention. This is mainly used for log retention.

usage_measure_id

Integer

Usage measurement unit. This parameter is mandatory for a pay-per-use inquiry. For example, the resources are billed by the hour, the usage value is 1, and the usage measurement unit is hour. The options are:

4: hour

10: GB. Bandwidth usage is measured in GB based on traffic.

11: MB. Bandwidth usage is measured in MB based on traffic.

13: Byte. The bandwidth usage is measured by byte based on traffic.

region_id

String

Code of the current region. The default value is null, indicating the current region.

Table 7 large_screen

Parameter

Type

Description

cloud_service_type

String

Main service type of the cloud service product. The default value is hws.service.type.sa for SecMaster.

resource_type

String

Resource type code.

resource_spec_code

String

Resource specification code.

resource_size_measure_id

Integer

Resource capacity measurement ID.

usage_factor

String

Usage factor. This parameter is mandatory for pay-per-use billing. The value is the same as the usage factor in SDRs. The mappings between cloud services and usage factors are as follows.

Currently, SecMaster supports the following options:

duration: time. This is mainly used for the basic, standard, and professional editions.

count: times. This is mainly used for security orchestration.

flow: traffic. This is mainly used for log analysis and collection.

retention: retention. This is mainly used for log retention.

usage_measure_id

Integer

Usage measurement unit. This parameter is mandatory for a pay-per-use inquiry. For example, the resources are billed by the hour, the usage value is 1, and the usage measurement unit is hour. The options are:

4: hour

10: GB. Bandwidth usage is measured in GB based on traffic.

11: MB. Bandwidth usage is measured in MB based on traffic.

13: Byte. The bandwidth usage is measured by byte based on traffic.

region_id

String

Code of the current region. The default value is null, indicating the current region.

Table 8 log_collection

Parameter

Type

Description

cloud_service_type

String

Main service type of the cloud service product. The default value is hws.service.type.sa for SecMaster.

resource_type

String

Resource type code.

resource_spec_code

String

Resource specification code.

resource_size_measure_id

Integer

Resource capacity measurement ID.

usage_factor

String

Usage factor. This parameter is mandatory for pay-per-use billing. The value is the same as the usage factor in SDRs. The mappings between cloud services and usage factors are as follows.

Currently, SecMaster supports the following options:

duration: time. This is mainly used for the basic, standard, and professional editions.

count: times. This is mainly used for security orchestration.

flow: traffic. This is mainly used for log analysis and collection.

retention: retention. This is mainly used for log retention.

usage_measure_id

Integer

Usage measurement unit. This parameter is mandatory for a pay-per-use inquiry. For example, the resources are billed by the hour, the usage value is 1, and the usage measurement unit is hour. The options are:

4: hour

10: GB. Bandwidth usage is measured in GB based on traffic.

11: MB. Bandwidth usage is measured in MB based on traffic.

13: Byte. The bandwidth usage is measured by byte based on traffic.

region_id

String

Code of the current region. The default value is null, indicating the current region.

Table 9 log_retention

Parameter

Type

Description

cloud_service_type

String

Main service type of the cloud service product. The default value is hws.service.type.sa for SecMaster.

resource_type

String

Resource type code.

resource_spec_code

String

Resource specification code.

resource_size_measure_id

Integer

Resource capacity measurement ID.

usage_factor

String

Usage factor. This parameter is mandatory for pay-per-use billing. The value is the same as the usage factor in SDRs. The mappings between cloud services and usage factors are as follows.

Currently, SecMaster supports the following options:

duration: time. This is mainly used for the basic, standard, and professional editions.

count: times. This is mainly used for security orchestration.

flow: traffic. This is mainly used for log analysis and collection.

retention: retention. This is mainly used for log retention.

usage_measure_id

Integer

Usage measurement unit. This parameter is mandatory for a pay-per-use inquiry. For example, the resources are billed by the hour, the usage value is 1, and the usage measurement unit is hour. The options are:

4: hour

10: GB. Bandwidth usage is measured in GB based on traffic.

11: MB. Bandwidth usage is measured in MB based on traffic.

13: Byte. The bandwidth usage is measured by byte based on traffic.

region_id

String

Code of the current region. The default value is null, indicating the current region.

Table 10 log_analysis

Parameter

Type

Description

cloud_service_type

String

Main service type of the cloud service product. The default value is hws.service.type.sa for SecMaster.

resource_type

String

Resource type code.

resource_spec_code

String

Resource specification code.

resource_size_measure_id

Integer

Resource capacity measurement ID.

usage_factor

String

Usage factor. This parameter is mandatory for pay-per-use billing. The value is the same as the usage factor in SDRs. The mappings between cloud services and usage factors are as follows.

Currently, SecMaster supports the following options:

duration: time. This is mainly used for the basic, standard, and professional editions.

count: times. This is mainly used for security orchestration.

flow: traffic. This is mainly used for log analysis and collection.

retention: retention. This is mainly used for log retention.

usage_measure_id

Integer

Usage measurement unit. This parameter is mandatory for a pay-per-use inquiry. For example, the resources are billed by the hour, the usage value is 1, and the usage measurement unit is hour. The options are:

4: hour

10: GB. Bandwidth usage is measured in GB based on traffic.

11: MB. Bandwidth usage is measured in MB based on traffic.

13: Byte. The bandwidth usage is measured by byte based on traffic.

region_id

String

Code of the current region. The default value is null, indicating the current region.

Table 11 soar

Parameter

Type

Description

cloud_service_type

String

Main service type of the cloud service product. The default value is hws.service.type.sa for SecMaster.

resource_type

String

Resource type code.

resource_spec_code

String

Resource specification code.

resource_size_measure_id

Integer

Resource capacity measurement ID.

usage_factor

String

Usage factor. This parameter is mandatory for pay-per-use billing. The value is the same as the usage factor in SDRs. The mappings between cloud services and usage factors are as follows.

Currently, SecMaster supports the following options:

duration: time. This is mainly used for the basic, standard, and professional editions.

count: times. This is mainly used for security orchestration.

flow: traffic. This is mainly used for log analysis and collection.

retention: retention. This is mainly used for log retention.

usage_measure_id

Integer

Usage measurement unit. This parameter is mandatory for a pay-per-use inquiry. For example, the resources are billed by the hour, the usage value is 1, and the usage measurement unit is hour. The options are:

4: hour

10: GB. Bandwidth usage is measured in GB based on traffic.

11: MB. Bandwidth usage is measured in MB based on traffic.

13: Byte. The bandwidth usage is measured by byte based on traffic.

region_id

String

Code of the current region. The default value is null, indicating the current region.

Status code: 400

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

Range

N/A

error_msg

String

Definition

Error description.

Range

N/A

Status code: 403

Table 13 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

Range

N/A

error_msg

String

Definition

Error description.

Range

N/A

Status code: 500

Table 14 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

Range

N/A

error_msg

String

Definition

Error description.

Range

N/A

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

List of the SecMaster offerings supported at the current site

400

Parameter error.

403

No permissions.

500

Internal error.

Error Codes

See Error Codes.