客户运营能力客户运营能力

更新时间:2021/06/24 GMT+08:00
分享

查询使用量类型列表

功能介绍

客户在自建平台查询资源的使用量类型列表。

接口约束

该接口可以使用客户AK/SK或者Token调用。

调试

您可以在API Explorer中直接运行调试该接口。

URI

GET /v2/products/usage-types

参数说明请参见表1

表1 Header参数

参数

是否必选

取值范围

描述

X-Language

最大长度:8

语言。

  • 中文:zh_CN
  • 英文:en_US

缺省为zh_CN。

表2 查询参数

参数

是否必选

参数类型

取值范围

描述

resource_type_code

String

最大长度:64

资源类型编码,例如ECS的VM为“hws.resource.type.vm”。您可以调用查询资源类型列表接口获取。

limit

Integer

[1-100]

每次查询的数量,默认值为10。

offset

Integer

[0-最大整数]

偏移量,从0开始。默认值为0。

说明:

offset用于分页处理,如不涉及分页,请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1,则返回满足条件的第二个数据至最后一个数据。

例如,满足查询条件的结果共10条数据,limit取值为10,offset取值为1,则返回的数据为2~10,第一条数据不返回。

请求消息

请求参数

无。

请求示例

POST https://bss.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-TokenMIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
X-Language: zh_CN

响应消息

响应参数

参数

参数类型

取值范围

描述

error_code

String

最大长度:20

状态码。

具体请参考状态码。只有失败才返回该字段。

error_msg

String

最大长度:1000

错误描述信息。只有失败才返回该字段。

total_count

Integer

-

总数。

usage_types

list<UsageType>

-

使用量类型列表,具体请参见表3

表3 UsageType

参数

参数类型

取值范围

描述

code

String

最大长度:64

使用量类型编码。如:reqNumber。

name

String

最大长度:1024

使用量类型名称。如:调用次数。

resource_type_code

String

最大长度:64

资源类型编码。例如ECS的VM为“hws.resource.type.vm”。

service_type_code

String

最大长度:64

云服务类型编码。例如ECS的云服务类型编码为“hws.service.type.ec2”。

响应示例

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": "视频联接流量",
            "resource_type_code": "hws.resource.type.live.videoconnect",
            "service_type_code": "hws.service.type.live"
        },
        {
            "code": "reqNumber",
            "name": "调用次数",
            "resource_type_code": "hws.resource.type.pca.quantity",
            "service_type_code": "hws.service.type.ccm"
        },
        {
            "code": "dailyalarmnum",
            "name": "告警数",
            "resource_type_code": "hws.resource.type.aicms.cdfl",
            "service_type_code": "hws.service.type.aimgs"
        }
    ]
}

状态码

HTTP状态码

错误码

错误描述

403

CBC.0151

访问拒绝。

500

CBC.0999

其他错误。

400

CBC.0100

参数错误。

分享:

    相关文档

    相关产品