请登录后查看
ListCustomerselfResourceRecordDetails
查询资源详单
功能描述:客户在客户自建平台查询自己的资源详单,用于反映各类资源的消耗情况。
该接口只允许使用客户AK/SK或者Token调用。
名称 | 类型 | IN | 必选 | 描述 |
---|---|---|---|---|
X-Language | string | header | 否 | |国际站默认英文,枚举:zh_cn:中文 en_us:英文| |
X-Auth-Token | string | header | 是 | 客户Token调用 |
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
cycle | string | 是 | 查询的资源详单所在账期,东八区时间,格式为YYYY-MM。 示例:2019-01。 说明: 不支持2019年1月份之前的资源详单。 |
cloud_service_type | string | 否 | 云服务类型编码,例如OBS的云服务类型编码为“hws.service.type.obs”。您可以调用查询云服务类型列表接口获取。 此参数不携带或携带值为空串或携带值为null时,不作为筛选条件。 |
resource_type | string | 否 | 资源类型编码,例如ECS的VM为“hws.resource.type.vm”。您可以调用查询资源类型列表接口获取。 此参数不携带或携带值为空串或携带值为null时,不作为筛选条件。 |
region | string | 否 | 云服务区编码,例如:“ap-southeast-1”。具体请参见地区和终端节点对应云服务的“区域”列的值。 此参数不携带或携带值为空串或携带值为null时,不作为筛选条件。 |
res_instance_id | string | 否 | 资源实例ID。 此参数不携带或携带值为空串或携带值为null时,不作为筛选条件。 |
charge_mode | integer | 否 | 计费模式。 1 : 包年/包月3:按需10:预留实例11:节省计划。 此参数不携带或者携带值为null时,返回所有计费模式的资源详单数据记录。 |
bill_type | integer | 否 | 账单类型: 1:消费-新购2:消费-续订3:消费-变更4:退款-退订5:消费-使用8:消费-自动续订9:调账-补偿14:消费-服务支持计划月末扣费15:消费-税金16:调账-扣费17:消费-保底差额 说明: 保底差额=客户签约保底合同后,如果没有达到保底消费,客户需要补交的费用,仅限于直销或者伙伴顾问销售类子客户,且为后付费用户。 20:退款-变更100:退款-退订税金23:消费-节省计划抵扣 24:退款-包年/包月转按需101:调账-补偿税金102:调账-扣费税金 此参数不携带或者携带值为null时,返回所有账单类型的资源详单数据记录。 |
enterprise_project_id | string | 否 | 企业项目标识(企业项目ID)。 default项目对应ID:0未归集(表示该云服务不支持企业项目管理能力)项目对应ID:null 此参数不携带或携带值为空串或携带值为null时,不作为筛选条件。 |
include_zero_record | boolean | 否 | 返回是否包含应付金额为0的记录。 true: 包含false: 不包含 此参数不携带或携带值为空串或携带值为null时,不作为筛选条件。 |
offset | integer | 否 | 偏移量,从0开始。默认值为0。 说明: offset用于分页处理,如不涉及分页,请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1,则返回满足条件的第二个数据至最后一个数据。 例如,满足查询条件的结果共10条数据,limit取值为10,offset取值为1,则返回的数据为2~10,第一条数据不返回。 |
limit | integer | 否 | 页面大小。默认值为10。 |
method | string | 否 | 查询方式。 oneself:客户自己sub_customer:企业子客户all:客户自己和企业子客户 此参数不携带或携带值为空串或携带值为null时,默认值为“all”,如果没有企业子客户,all的时候也是查询客户自己的数据。 |
sub_customer_id | string | 否 | 企业子账号ID。 说明: 如果method取值不为sub_customer,则此参数无效。如果method取值为sub_customer,则此参数不能为空。 |
statistic_type | integer | 否 | 统计类型。默认值为1。 1:按账期2:按天3:按明细 |
query_type | string | 否 | |参数名称:查询类型。默认值为BILLCYCLE。| |参数的约束及描述:默认值为BILLCYCLE。BILLCYCLE:按月 DAILY:按天 仅当statistic_type=2或3时,支持传递query_type=DAILY。该参数不携带或携带值为null或携带为空串时,取默认值BILLCYCLE。| |
bill_cycle_begin | string | 否 | |账期开始时间。格式为YYYY-MM-DD。| |参数的约束及描述:仅当query_type=DAILY时,必须传递账期开始时间。该参数不携带或携带值为null或携带为空串时,不作为筛选条件。| |
bill_cycle_end | string | 否 | |参数名称:账期结束时间。格式为YYYY-MM-DD。| |参数的约束及描述:仅当query_type=DAILY时,必须传递账期结束时间。该参数不携带或携带值为null或携带为空串时,不作为筛选条件。| |
payer_account_id | string | 否 | |参数名称:支付账号ID。| |参数的约束及描述:普通客户、财务独立企业子客户查询消费记录,只能查询到客户自己的消费记录,该参数不携带或携带为自身ID时,查询的都只是自身的消费记录; 企业主客户查询消费记录,不携带时,查询的是自身的、财务托管企业子、财务独立企业子的消费记录;入参自身ID时,查询的是自身的、财务托管企业子的消费记录;也可入参其名下财务独立企业子的客户ID,只查询该财务独立企业子的消费记录; 财务托管企业子查询消费记录,入参自身ID时,查询的是未与企业主关联时的消费记录;入参企业主客户ID时,查询的是与企业主关联后的消费记录;不携带时查询以上全部消费记录| |
查询资源详单返回
名称 | 类型 | 描述 |
---|---|---|
monthly_records | Array of MonthlyBillRes objects | 资源详单数据记录。 具体请参见表1。 |
total_count | integer | 结果集数量,只有成功才返回这个参数。 |
currency | string | 货币单位代码: USD:美元 |
名称 | 类型 | 描述 |
---|---|---|
cycle | string | 资源详单数据所在账期,东八区时间,格式为YYYY-MM。 例如2020-01。 |
bill_date | string | 消费日期,东八区时间,格式为YYYY-MM-DD。 说明: 当statistic_type=2时该字段才有值,否则返回null。 |
bill_type | integer | 账单类型。 1:消费-新购2:消费-续订3:消费-变更4:退款-退订5:消费-使用8:消费-自动续订9:调账-补偿14:消费-服务支持计划月末扣费15:消费-税金16:调账-扣费17:消费-保底差额 说明: 保底差额=客户签约保底合同后,如果没有达到保底消费,客户需要补交的费用,仅限于直销或者伙伴顾问销售类子客户,且为后付费用户。 20:退款-变更 23:消费-节省计划抵扣 24:退款-包年/包月转按需 100:退款-退订税金101:调账-补偿税金102:调账-扣费税金 |
customer_id | string | 消费的客户账号ID。 如果是普通客户或者企业子客户查询消费记录,只能查询到客户自己的消费记录,且此处显示的是客户自己的客户ID。如果是企业主查询消费记录,可以查询到企业主以及企业子客户的消费记录,此处为消费的实际客户ID。如果是企业主自己的消费记录,则为企业主ID;如果是某个企业子客户的消费记录,则此处为企业子账号ID。 |
region | string | 云服务区编码,例如:“ap-southeast-1”。具体请参见地区和终端节点对应云服务的“区域”列的值。 |
region_name | string | 云服务区名称,例如:“中国-香港”。具体请参见地区和终端节点对应云服务的“区域名称”列的值。 |
cloud_service_type | string | 云服务类型编码,例如OBS的云服务类型编码为“hws.service.type.obs”。您可以调用查询云服务类型列表接口获取。 |
resource_Type_code | string | 资源类型编码,例如ECS的VM为“hws.resource.type.vm”。您可以调用查询资源类型列表接口获取。 |
cloud_service_type_name | string | 云服务类型名称。例如ECS的云服务类型名称为“弹性云服务器”。 |
resource_type_name | string | 资源类型名称。例如ECS的资源类型名称为“云主机”。 |
res_instance_id | string | 资源实例ID。 |
resource_name | string | 资源名称。客户在创建资源的时候,可以输入资源名称,有些资源也可以在管理资源时,修改资源名称。 |
resource_tag | string | 资源标签。客户在管理资源的时候,可以设置资源标签。 |
sku_code | string | SKU编码,在账单中唯一标识一个资源的规格。 |
enterprise_project_id | string | 企业项目标识(企业项目ID)。 default项目对应ID:0未归集(表示该云服务不支持企业项目管理能力)项目对应ID:null其余项目对应ID获取方法请参见如何获取企业项目ID。 |
enterprise_project_name | string | 企业项目名称。 |
charge_mode | integer | 计费模式。 1 : 包年/包月3:按需10:预留实例11:节省计划。 |
consume_amount | number | 客户购买云服务类型的消费金额,包含代金券、现金券,精确到小数点后8位。 说明: consume_amount的值等于cash_amount,credit_amount,coupon_amount,flexipurchase_coupon_amount,stored_card_amount,bonus_amount,debt_amount,adjustment_amount的总和。 |
cash_amount | number | 现金支付金额。 |
credit_amount | number | 信用额度支付金额。 |
coupon_amount | number | 代金券支付金额。 |
flexipurchase_coupon_amount | number | 现金券支付金额。 |
stored_card_amount | number | 储值卡支付金额。 |
bonus_amount | number | 奖励金支付金额(用于现网客户未使用完的奖励金)。 |
debt_amount | number | 欠费金额。 |
adjustment_amount | number | 欠费核销金额。 |
official_amount | number | 官网价。 |
discount_amount | number | 对应官网价折扣金额。 |
measure_id | integer | 金额单位。 1:元 |
period_type | integer | 周期类型: 19:年20:月24:天25:小时5:一次性 |
root_resource_id | string | 根资源标识。 |
parent_resource_id | string | 父资源标识。 |
trade_id | string | 订单ID 或 交易ID。 账单类型为1,2,3,4,8时为订单ID;其它场景下为: 交易ID(非月末扣费:应收ID;月末扣费:账单ID)。 |
id | string | |参数名称:唯一标识。| |参数约束及描述:该字段为预留字段。| |
product_spec_desc | string | 产品的规格描述。 |
sub_service_type_code | string | 该字段为预留字段。 |
sub_service_type_name | string | 该字段为预留字段。 |
sub_resource_type_code | string | 该字段为预留字段。 |
sub_resource_type_name | string | 该字段为预留字段。 |
sub_resource_id | string | 该字段为预留字段。 |
sub_resource_name | string | 该字段为预留字段。 |
pre_order_id | string | |参数名称:原订单ID| |参数的约束及描述:该参数非必填,且只允许字符串| |
az_code_infos | Array of AzCodeInfo objects | |参数名称:可用区信息列表| |参数的约束及描述:该参数非必填,且只允许字符串| |
payer_account_id | string | |参数名称:支付账号ID。| |参数的约束及描述:如果是普通客户或者财务独立企业子客户或者企业主客户查询消费记录,此处为客户自己的客户ID。如果是财务托管企业子查询消费记录,此处为企业主客户ID或自己的客户ID。| |
effective_time | string | |参数名称:费用对应的资源使用的开始时间| |参数的约束及描述:费用对应的资源使用的开始时间,statistic_type=3有效,statistic_type=1或者2该字段保留。| |
expire_time | string | |参数名称:费用对应的资源使用的结束时间| |参数的约束及描述:费用对应的资源使用的结束时间,statistic_type=3有效,statistic_type=1或者2该字段保留。| |
consume_time | string | |参数名称:消费时间| |参数约束及描述:消费时间,UTC时间,格式:yyyy-MM-ddTHH:mm:ssZ。包周期、预留实例预付为交易时间,按需、预留实例按时计费为话单生失效时间。 说明:当statistic_type=3时有效。| |
be_id | string | |参数名称:华为云运营实体ID。| |参数约束及描述:华为云运营实体ID。| |
extend_params | ResRelation object | |参数名称:资源关系信息。| |参数约束及描述:资源关系信息。该字段为预留字段。| |
名称 | 类型 | 描述 |
---|---|---|
az_code | string | |参数名称:可用区编码| |参数的约束及描述:该参数非必填,且只允许字符串| |
名称 | 类型 | 描述 |
---|---|---|
self_resource_id | string | |参数名称:当前费用对应的资源ID| |参数约束及描述:当前费用对应的资源ID| |
relation_infos | Array of RelationInfo objects | |参数名称:当前费用对应资源ID关联的资源信息。| |参数约束及描述:当前费用对应资源ID关联的资源信息,数组个数不超过2层| |
名称 | 类型 | 描述 |
---|---|---|
relative_resource_id | string | |参数名称:关联资源ID。| |参数约束及描述:关联资源ID。| |
relative_type | string | |参数名称:关联资源类型。| |参数约束及描述:关联资源类型,父资源:PARENT;根资源:ROOT| |
|CBC.0100:输入参数校验失败 parameter error|
"POST https://bss-intl.myhuaweicloud.com/v2/bills/customer-bills/res-records/query"
{
"cycle": "2018-12",
"cloud_service_type": "hws.service.type.ec2",
"resource_type": "hws.resource.type.vm",
"region": "cn-north-1",
"res_instance_id": "76*****7f",
"charge_mode": 1,
"bill_type": 1,
"enterprise_project_id": "6***f3-3**4-4**2-9a3e-a****c24",
"include_zero_record": true,
"method": "sub_customer",
"sub_customer_id": "05b5fef62300d2ad0f98c00befba72c0",
"offset": 1,
"limit": 10
}
查询资源详单返回
{
"monthly_records": [
{
"cycle": "2020-03",
"bill_type": 8,
"customer_id": "8caf348df5fa4529aba5aea760608845",
"region": "ap-southeast-1",
"region_name": "中国-香港",
"cloud_service_type": "hws.service.type.ec2",
"resource_Type_code": "hws.resource.type.vm",
"res_instance_id": "01154-73310087-0",
"resource_name": null,
"resource_tag": null,
"sku_code": "5_sbgp",
"enterprise_project_id": "-1",
"enterprise_project_name": "未归集",
"charge_mode": 10,
"consume_amount": 4.46,
"cash_amount": 0,
"credit_amount": 0,
"coupon_amount": 0,
"flexipurchase_coupon_amount": 0,
"stored_card_amount": 0,
"bonus_amount": 0,
"debt_amount": 4.46,
"adjustment_amount": null,
"official_amount": 4.46,
"discount_amount": 0,
"id": "037e8a2b******01-5f9eb5153cba_1",
"measure_id": 1,
"sub_service_type_code": null,
"sub_service_type_name": null,
"sub_resource_type_code": null,
"sub_resource_type_name": null,
"sub_resource_id": null,
"sub_resource_name": null,
"period_type": 20,
"root_resource_id": null,
"parent_resource_id": null,
"trade_id": "CSYD******214V3CC02",
"product_spec_desc": "普通IO|200GB",
"pre_order_id": "CS23******54B1AEW4J",
"az_code_infos": [
{
"az_code": "cn-north-1c"
}
],
"payer_account_id": "053a******89b88480",
"effective_time": "2024-07-06T16:00:00Z",
"expire_time": "2024-07-07T16:00:00Z",
"consume_time": "2024-11-06T16:00:00Z",
"be_id": 0
}
],
"total_count": 1,
"currency": "USD"
}