Help Center > > API Reference> Product Management> Quering Product Information> Querying Usage Types

Querying Usage Types

Updated at: Dec 15, 2021 GMT+08:00

Function

This API is used to query resource usage types on the partner sales platform.

Constraints

This API can be invoked using the partner AK/SK or token.

URI

GET /v2/products/usage-types

Table 1 Header parameter

Parameter

Mandatory

Value Range

Description

X-Language

No

A maximum of 8 characters

Language.

  • zh_CN: Chinese
  • en_US: English

Default value: zh_CN

Table 2 Request parameters

Parameter

Mandatory

Type

Value Range

Description

resource_type_code

No

String

A maximum of 64 characters

Resource type code. For example, the VM resource type code of ECS is hws.resource.type.vm. To obtain a specific resource type, call the API in Querying Resource Types.

limit

No

Integer

1 to 100

Number of records queried each time. The default value is 10.

offset

No

Integer

0 to Maximum integer

Offset, which starts from 0. The default value is 0.

NOTE:

This parameter is used for pagination. Retain its default value 0 if pagination is not required. offset indicates the offset relative to the first data record among all that meets the conditions configured. If you set offset to 1, the second and subsequent data records are returned.

For example, there are 10 data records, and if you set limit to 10 and offset to 1, the second to the tenth data records are returned.

Request

Request Parameters

None

Example Request

POST https://bss-intl.myhuaweicloud.com/v2/products/usage-types?resource_type_code=hws.resource.type.vm&offset=0&limit=100 HTTP/1.1
Content-Type: application/json
X-Auth-Token: MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
X-Language: zh_CN

Response

Response Parameters

Parameter

Type

Value Range

Description

error_code

String

A maximum of 20 characters

Error code.

For details, see Returned Values. This parameter is returned only when the query failed.

error_msg

String

A maximum of 1000 characters

Error description. This parameter is returned only when the query failed.

total_count

Integer

-

Total number.

usage_types

List<UsageType>

-

Usage type list. For details, see Table 3.

Table 3 UsageType

Parameter

Type

Value Range

Description

code

String

A maximum of 64 characters

Usage type code, for example, reqNumber.

name

String

A maximum of 1024 characters

Usage type name, for example, the number of invoking times.

resource_type_code

String

A maximum of 64 characters

Resource type code. For example, the resource type code of VM is hws.resource.type.vm.

service_type_code

String

A maximum of 64 characters

Cloud service type code. For example, the cloud service type code of OBS is hws.service.type.obs.

Example Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time  
{
    "total_count": 1133,
    "usage_types": [
        {
            "code": "flow",
            "name": "Video connection traffic",
            "resource_type_code": "hws.resource.type.live.videoconnect",
            "service_type_code": "hws.service.type.live"
        },
        {
            "code": "reqNumber",
            "name": "Invoking times",
            "resource_type_code": "hws.resource.type.pca.quantity",
            "service_type_code": "hws.service.type.ccm"
        },
        {
            "code": "dailyalarmnum",
            "name": "Alarms",
            "resource_type_code": "hws.resource.type.aicms.cdfl",
            "service_type_code": "hws.service.type.aimgs"
        }
    ]
}

Returned Values

HTTP Value

Error Code

Description

403

CBC.0151

Access denied.

500

CBC.0999

Other errors.

400

CBC.0100

Parameter error.

Did you find this page helpful?

Submit successfully!

Thank you for your feedback. Your feedback helps make our documentation better.

Failed to submit the feedback. Please try again later.

Which of the following issues have you encountered?







Please complete at least one feedback item.

Content most length 200 character

Content is empty.

OK Cancel