查询成本数据-ListCosts
功能介绍
客户在自建平台查询成本分析数据。
- 原始成本：当月的原始成本数据和费用中心账单之间存在1小时左右的时延，最终以实际出账日（次月3日）以后的数据为准，在次月4日12点后可查看。
- 摊销成本：摊销成本为非实时数据，每24小时刷新一次，有24~48小时左右的延迟。CDN、VPC等按月结算的产品，当月消费需在次月4日12点后查看。
接口约束
该接口只允许使用客户AK/SK或者Token调用。
上个月的数据需在出账后查询。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见策略授权参考。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
描述
访问级别
资源类型（*为必须）
条件键
别名
costCenter:costAnalysis:listCosts
授予查看成本分析的权限
read
-
-
-
URI
POST /v4/costs/cost-analysed-bills/query
参数 | 是否必选 | 取值范围 | 描述 |
|---|---|---|---|
X-Language | 否 | 最大长度：8 | 语言，预留字段。
缺省为zh_CN。 |
请求消息
请求参数
参数 | 是否必选 | 参数类型 | 取值范围 | 描述 |
|---|---|---|---|---|
time_condition | 是 | TimeCondition Object | - | 时间条件，具体请参见表 TimeCondition。 |
groupby | 是 | List<GroupBy> | 最大个数：2 | 查询维度，具体请参见表3。 说明： 如需使用两个维度查询时，参数type取值不能同时是两个tag或者两个cost_unit。 |
cost_type | 是 | String | 最大长度：256 | 成本类型。
|
amount_type | 是 | String | 展示的金额类型。
| |
filters | 否 | List<Filter> | 最小长度：0 最大长度：100 | 过滤条件，具体请参见表4。 此参数不携带或携带值为空列表或携带值为null时，不作为筛选条件。 |
offset | 否 | Integer | [0-200000] | 偏移量，从0开始，默认值为0。 说明： offset用于分页处理，如不涉及分页，请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset =1，则返回满足条件的第二个数据至最后一个数据。 例如，满足查询条件的结果共10条数据，limit取值为10，offset取值为1，则返回的数据为2~10，第一条数据不返回。 |
limit | 否 | Integer | [1-1000] | 每次查询的记录数，默认为10。 |
参数 | 是否必选 | 参数类型 | 取值范围 | 描述 |
|---|---|---|---|---|
time_measure_id | 是 | Integer | [1-2] | 时间单位。
|
begin_time | 是 | String | 32 | 查询开始时间，东八区时间，必须为日期格式。
|
end_time | 是 | String | 32 | 查询结束时间，东八区时间，必须为日期格式。
须知： 按天或按月查询均只支持查询18个月内的成本数据。 |
参数 | 是否必选 | 参数类型 | 取值范围 | 描述 |
|---|---|---|---|---|
type | 是 | String | 最大长度：64 |
|
key | 是 | String | 最大长度：128 |
|
参数 | 是否必选 | 参数类型 | 取值范围 | 描述 |
|---|---|---|---|---|
operator | 是 | Integer | [0-1] | 运算符。
|
filter_factor | 是 | FilterFactor Object | - | 过滤器因子，具体请参见表 FilterFactor。 |
参数 | 是否必选 | 参数类型 | 取值范围 | 描述 |
|---|---|---|---|---|
key | 是 | String | 最大长度：256 | 维度分组条件。
|
value | 是 | List<String> | 最小个数：1 最大个数：100 | 过滤器值。 说明： 当 key 为 CHARGING_MODE时，value 值对应如下：
当 key 为 BILL_TYPE时，value 值对应如下：
|
请求示例
POST https://bss.myhuaweicloud.com/v4/costs/cost-analysed-bills/query HTTP/1.1 Content-Type: application/json X-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ { "amount_type": "PAYMENT_AMOUNT", "offset": 0, "cost_type": "ORIGINAL_COST", "limit": 10, "groupby": [{ "type": "dimension", "key": "CLOUD_SERVICE_TYPE" }], "filters": [{ "filter_factor": { "value": ["cn-north-1"], "key": "REGION_CODE", }, "operator": 0 }], "time_condition": { "end_time": "2021-07-15", "begin_time": "2021-07-14", "time_measure_id": 1 } }
响应消息
响应参数
参数 | 参数类型 | 取值范围 | 描述 |
|---|---|---|---|
error_code | String | 最大长度：20 | 状态码。具体请参考状态码。只有失败才返回该字段。 |
error_msg | String | 最大长度：1000 | 错误描述信息。只有失败才返回该字段。 |
currency | String | 最大长度：8 | 货币。
|
total_count | Integer | - | 总条数。 |
cost_data | List<CostDataByDimension> | - | 按天或按月的明细金额，具体请参见表 CostDataByDimension。 |
参数 | 参数类型 | 取值范围 | 描述 |
|---|---|---|---|
dimensions | List<DimensionGroup> | 最大个数：1 | 维度列表，具体请参见表 DimensionGroup。 |
costs | List<Cost> | 最大个数：10000 | 成本值，具体请参见表 Cost。 |
amount_by_costs | String | 最大长度：64 | 此维度值对应整个时间跨度的成本汇总金额。 |
official_amount_by_costs | String | 最大长度：64 | 此维度值对应整个时间跨度的官网价汇总金额。 |
参数 | 参数类型 | 取值范围 | 描述 |
|---|---|---|---|
key | String | 最大长度：128 | 分组条件。
|
value | String | - | 维度值。 说明： 当 key 为 CHARGING_MODE时，value 值对应如下：
当 key 为 BILL_TYPE时，value 值对应如下：
|
参数 | 参数类型 | 取值范围 | 描述 |
|---|---|---|---|
time_dimension_value | String | 最大长度：20 | 时间维度值。
|
time_measure_id | Int | - | 时间单位。
|
amount | String | 最大长度：64 | 应付或实付的成本金额或均摊金额，具体取决于请求参数。 |
official_amount | String | 最大长度：64 | 官网价金额。 |
响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time
{
"currency": "CNY",
"total_count": 1,
"cost_data": [
{
"dimensions": [
{
"key": "tag",
"value": "Group:noTagKey"
}
],
"costs": [
{
"time_dimension_value": "2021-08",
"time_measure_id": 2,
"amount": "13225.00",
"official_amount": "13225.00"
}
],
"amount_by_costs": "13225.00",
"official_amount_by_costs": "13225.00"
}
]
} 
