Querying Usage Types

Function

This API is used to query resource usage types on the customer 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/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** Query 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. If this parameter is not included in the request parameters or is left empty, it cannot be used as a filter criterion. If the value is "", it can be used as a filter criterion.
offset	No	Integer	0 to 100000000	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, if there are 10 records that meet query conditions, when you set limit to 10 and offset to 1, the second to the tenth records are returned. If there are 20 records that meet query conditions, when you set offset to 0 and limit to 10 for the first page and set offset to 10 and limit to 10 for the second page, then each page will respectively have 10 records.
limit	No	Integer	1 to 100	Number of records queried each time. The default value is 10.

Request

Request Parameters

None

Example Request

GET https://bss-intl.myhuaweicloud.com/v2/products/usage-types?offset=0&limit=3 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.
resource_type_name	String	A maximum of 200 characters	Resource type. For example, the resource type of ECS is Cloud Host.
service_type_name	String	A maximum of 200 characters	Cloud service type. For example, the cloud service type of ECS is Elastic Cloud Server.

Example Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time  
{
 "total_count": 6048,
 "usage_types": [
  {
   "code": "flow",
            "name": "Video connection traffic",
   "resource_type_code": "hws.resource.type.live.videoconnect",
   "service_type_code": "hws.service.type.live",
   "resource_type_name": "Video connection",
   "service_type_name": "Live streaming"
  },
  {
   "code": "reqNumber",
            "name": "Invoking times",
   "resource_type_code": "hws.resource.type.pca.quantity",
   "service_type_code": "hws.service.type.ccm",
   "resource_type_name": "Number of private certificates",
   "service_type_name": "The cloud certificate management service"
  },
  {
   "code": "dailyalarmnum",
            "name": "Alarms",
   "resource_type_code": "hws.resource.type.aicms.cdfl",
   "service_type_code": "hws.service.type.aimgs",
   "resource_type_name": "The fault identification and root cause locating service",
   "service_type_name": "The modeling service"
  }
 ]
}

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.