Updated on 2024-09-26 GMT+08:00

Querying Measurement Units

Function

This API is used to query the resource usage, measurement unit for the duration and amount of a yearly/monthly resource, as well as the measurement unit type on the self-built platform.

Constraints

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

Debugging

You can debug the API in API Explorer which supports automatic authentication. API Explorer can automatically generate and debug example SDK code.

URI

GET /v2/bases/measurements

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

Request

Request Parameters

None

Example Request

GET https://bss-intl.myhuaweicloud.com/v2/bases/measurements 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.

measure_units

List<MeasureUnitRest>

-

Measurement unit information. For details, see Table 2.

Table 2 MeasureUnitRest

Parameter

Type

Value Range

Description

measure_id

Integer

-

Measurement unit ID.

For example, 10 indicates GB.

measure_name

String

A maximum of 128 characters

Measurement unit name, which is returned based on the language type.

Example: GB.

abbreviation

String

A maximum of 64 characters

Abbreviation of a measurement unit name.

For example, the abbreviation of GB is G.

measure_type

Integer

-

Measurement type.

  • 1: Currency
  • 2: Duration
  • 3: Traffic
  • 4: Quantity
  • 6: length
  • 7: Capacity
  • 9: Number of lines
  • 10: Period
  • 11: Frequency
  • 12: Count
  • 15: Capacity x duration
  • 16: Bandwidth
  • 17: Capacity-duration
  • 18: Query rate
  • 19: Bandwidth (1000)
  • 20: Performance test usage
  • 21: Area
  • 22: Video
  • 23: Throughput
  • 26: Deduction unit for a general resource package
  • 27: Number of cores x Duration
  • 28: Memory x Duration
  • 29: IOPS x Duration
  • 30: Throughput x Duration
  • 31: Number/Duration
  • 40: Traffic (1000)
  • 41: 1K tokens
  • 103: Hong Kong dollar
  • 104: tokens

Example Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time  
{
    "measure_units": [
        {
            "measure_id": 0,
            "measure_name": "Day",
            "abbreviation": "d",
            "measure_type": 2
        },
        {
            "measure_id": 1,
            "measure_name": "USD",
            "abbreviation": "YDollar",
            "measure_type": 1
        },
        {
            "measure_id": 10,
            "measure_name": "GB",
            "abbreviation": "G",
            "measure_type": 3
        }
    ]
}

Returned Values

  • 4xx: This class of HTTP status code is intended for situations in which the error seems to have been caused by the client, for example, the request contains bad syntax or incorrect parameters. You must ensure the request is correct.
  • 5xx: This class of HTTP status code is intended for cases in which the Huawei Cloud server is aware that it has encountered an error or is otherwise incapable of performing the request. In this case, contact Huawei Cloud customer service.

HTTP Value

Error Code

Description

403

CBC.0151

Access denied.

500

CBC.0999

Other errors.