tencentcloud-sdk-nodejs-billing 4.0.612 → 4.0.614

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -142,6 +142,26 @@ export interface VoucherInfos {
142
142
  ExcludedProducts: Array<ExcludedProducts>
143
143
  }
144
144
 
145
+ /**
146
+ * DescribeBillSummary返回参数结构体
147
+ */
148
+ export interface DescribeBillSummaryResponse {
149
+ /**
150
+ * 数据是否准备好,0准备中,1已就绪。(Ready=0,为当前UIN首次进行初始化出账,预计需要5~10分钟出账,请于10分钟后重试即可)
151
+ */
152
+ Ready?: number
153
+
154
+ /**
155
+ * 账单多维度汇总消费详情
156
+ */
157
+ SummaryDetail?: Array<SummaryDetail>
158
+
159
+ /**
160
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
161
+ */
162
+ RequestId?: string
163
+ }
164
+
145
165
  /**
146
166
  * DescribeCostSummaryByProduct请求参数结构体
147
167
  */
@@ -157,12 +177,12 @@ export interface DescribeCostSummaryByProductRequest {
157
177
  EndTime: string
158
178
 
159
179
  /**
160
- * 每次获取数据量
180
+ * 每次获取数据量,最大值为100
161
181
  */
162
182
  Limit: number
163
183
 
164
184
  /**
165
- * 偏移量
185
+ * 偏移量,默认从0开始
166
186
  */
167
187
  Offset: number
168
188
 
@@ -178,13 +198,43 @@ export interface DescribeCostSummaryByProductRequest {
178
198
  }
179
199
 
180
200
  /**
181
- * 消耗汇总详情
201
+ * cos产品用量明细返回数据结构
182
202
  */
183
- export interface ConsumptionSummaryTotal {
203
+ export interface CosDetailSets {
184
204
  /**
185
- * 折后总价
205
+ * 存储桶名称
186
206
  */
187
- RealTotalCost: string
207
+ BucketName: string
208
+
209
+ /**
210
+ * 用量开始时间
211
+ */
212
+ DosageBeginTime: string
213
+
214
+ /**
215
+ * 用量结束时间
216
+ */
217
+ DosageEndTime: string
218
+
219
+ /**
220
+ * 子产品名称
221
+ */
222
+ SubProductCodeName: string
223
+
224
+ /**
225
+ * 计费项名称
226
+ */
227
+ BillingItemCodeName: string
228
+
229
+ /**
230
+ * 用量
231
+ */
232
+ DosageValue: string
233
+
234
+ /**
235
+ * 单位
236
+ */
237
+ Unit: string
188
238
  }
189
239
 
190
240
  /**
@@ -389,6 +439,30 @@ export interface ConsumptionBusinessSummaryDataItem {
389
439
  * 费用趋势
390
440
  */
391
441
  Trend: ConsumptionSummaryTrend
442
+
443
+ /**
444
+ * 现金
445
+ 注意:此字段可能返回 null,表示取不到有效值。
446
+ */
447
+ CashPayAmount?: string
448
+
449
+ /**
450
+ * 赠送金
451
+ 注意:此字段可能返回 null,表示取不到有效值。
452
+ */
453
+ IncentivePayAmount?: string
454
+
455
+ /**
456
+ * 代金券
457
+ 注意:此字段可能返回 null,表示取不到有效值。
458
+ */
459
+ VoucherPayAmount?: string
460
+
461
+ /**
462
+ * 分成金
463
+ 注意:此字段可能返回 null,表示取不到有效值。
464
+ */
465
+ TransferPayAmount?: string
392
466
  }
393
467
 
394
468
  /**
@@ -1081,6 +1155,60 @@ export interface ConsumptionResourceSummaryDataItem {
1081
1155
  * 消耗类型
1082
1156
  */
1083
1157
  ConsumptionTypeName: string
1158
+
1159
+ /**
1160
+ * 折前价
1161
+ 注意:此字段可能返回 null,表示取不到有效值。
1162
+ */
1163
+ RealCost?: string
1164
+
1165
+ /**
1166
+ * 费用起始时间
1167
+ 注意:此字段可能返回 null,表示取不到有效值。
1168
+ */
1169
+ FeeBeginTime?: string
1170
+
1171
+ /**
1172
+ * 费用结束时间
1173
+ 注意:此字段可能返回 null,表示取不到有效值。
1174
+ */
1175
+ FeeEndTime?: string
1176
+
1177
+ /**
1178
+ * 天数
1179
+ 注意:此字段可能返回 null,表示取不到有效值。
1180
+ */
1181
+ DayDiff?: string
1182
+
1183
+ /**
1184
+ * 每日消耗
1185
+ 注意:此字段可能返回 null,表示取不到有效值。
1186
+ */
1187
+ DailyTotalCost?: string
1188
+
1189
+ /**
1190
+ * 订单号
1191
+ 注意:此字段可能返回 null,表示取不到有效值。
1192
+ */
1193
+ OrderId?: string
1194
+
1195
+ /**
1196
+ * 代金券
1197
+ 注意:此字段可能返回 null,表示取不到有效值。
1198
+ */
1199
+ VoucherPayAmount?: string
1200
+
1201
+ /**
1202
+ * 赠送金
1203
+ 注意:此字段可能返回 null,表示取不到有效值。
1204
+ */
1205
+ IncentivePayAmount?: string
1206
+
1207
+ /**
1208
+ * 分成金
1209
+ 注意:此字段可能返回 null,表示取不到有效值。
1210
+ */
1211
+ TransferPayAmount?: string
1084
1212
  }
1085
1213
 
1086
1214
  /**
@@ -1191,6 +1319,21 @@ export interface DescribeBillDetailRequest {
1191
1319
  Context?: string
1192
1320
  }
1193
1321
 
1322
+ /**
1323
+ * 商品详细信息
1324
+ */
1325
+ export interface ProductInfo {
1326
+ /**
1327
+ * 商品详情名称标识
1328
+ */
1329
+ Name: string
1330
+
1331
+ /**
1332
+ * 商品详情
1333
+ */
1334
+ Value: string
1335
+ }
1336
+
1194
1337
  /**
1195
1338
  * 消耗按项目汇总详情
1196
1339
  */
@@ -1219,6 +1362,30 @@ export interface ConsumptionProjectSummaryDataItem {
1219
1362
  * 产品消耗详情
1220
1363
  */
1221
1364
  Business: Array<ConsumptionBusinessSummaryDataItem>
1365
+
1366
+ /**
1367
+ * 现金
1368
+ 注意:此字段可能返回 null,表示取不到有效值。
1369
+ */
1370
+ CashPayAmount?: string
1371
+
1372
+ /**
1373
+ * 赠送金
1374
+ 注意:此字段可能返回 null,表示取不到有效值。
1375
+ */
1376
+ IncentivePayAmount?: string
1377
+
1378
+ /**
1379
+ * 代金券
1380
+ 注意:此字段可能返回 null,表示取不到有效值。
1381
+ */
1382
+ VoucherPayAmount?: string
1383
+
1384
+ /**
1385
+ * 分成金
1386
+ 注意:此字段可能返回 null,表示取不到有效值。
1387
+ */
1388
+ TransferPayAmount?: string
1222
1389
  }
1223
1390
 
1224
1391
  /**
@@ -1310,18 +1477,31 @@ export interface DescribeCostSummaryByProductResponse {
1310
1477
  }
1311
1478
 
1312
1479
  /**
1313
- * 商品详细信息
1480
+ * DescribeBillSummaryByTag返回参数结构体
1314
1481
  */
1315
- export interface ProductInfo {
1482
+ export interface DescribeBillSummaryByTagResponse {
1316
1483
  /**
1317
- * 商品详情名称标识
1318
- */
1319
- Name: string
1484
+ * 数据是否准备好,0未准备好,1准备好
1485
+ Ready=0,为当前UIN首次进行初始化出账,预计需要5~10分钟,请于10分钟后重试
1486
+ */
1487
+ Ready?: number
1320
1488
 
1321
1489
  /**
1322
- * 商品详情
1490
+ * 各标签值花费分布详情
1491
+ 注意:此字段可能返回 null,表示取不到有效值。
1492
+ */
1493
+ SummaryOverview?: Array<TagSummaryOverviewItem>
1494
+
1495
+ /**
1496
+ * 总数
1497
+ 注意:此字段可能返回 null,表示取不到有效值。
1498
+ */
1499
+ SummaryTotal?: SummaryTotal
1500
+
1501
+ /**
1502
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1323
1503
  */
1324
- Value: string
1504
+ RequestId?: string
1325
1505
  }
1326
1506
 
1327
1507
  /**
@@ -1518,12 +1698,12 @@ export interface DescribeCostSummaryByRegionRequest {
1518
1698
  EndTime: string
1519
1699
 
1520
1700
  /**
1521
- * 每次获取数据量
1701
+ * 每次获取数据量,最大值为100
1522
1702
  */
1523
1703
  Limit: number
1524
1704
 
1525
1705
  /**
1526
- * 偏移量
1706
+ * 偏移量,默认从0开始
1527
1707
  */
1528
1708
  Offset: number
1529
1709
 
@@ -1816,12 +1996,12 @@ export interface DescribeCostSummaryByProjectRequest {
1816
1996
  EndTime: string
1817
1997
 
1818
1998
  /**
1819
- * 每次获取数据量
1999
+ * 每次获取数据量,最大值为100
1820
2000
  */
1821
2001
  Limit: number
1822
2002
 
1823
2003
  /**
1824
- * 偏移量
2004
+ * 偏移量,默认从0开始
1825
2005
  */
1826
2006
  Offset: number
1827
2007
 
@@ -1836,6 +2016,77 @@ export interface DescribeCostSummaryByProjectRequest {
1836
2016
  NeedRecordNum?: number
1837
2017
  }
1838
2018
 
2019
+ /**
2020
+ * 账单多维度汇总消费详情
2021
+ */
2022
+ export interface SummaryDetail {
2023
+ /**
2024
+ * 账单维度编码
2025
+ 注意:此字段可能返回 null,表示取不到有效值。
2026
+ */
2027
+ GroupKey?: string
2028
+
2029
+ /**
2030
+ * 账单维度值
2031
+ 注意:此字段可能返回 null,表示取不到有效值。
2032
+ */
2033
+ GroupValue?: string
2034
+
2035
+ /**
2036
+ * 原价,单位为元。TotalCost字段自账单3.0(即2021-05)之后开始生效,账单3.0之前返回"-"。合同价的情况下,TotalCost字段与官网价格存在差异,也返回“-”。
2037
+ */
2038
+ TotalCost?: string
2039
+
2040
+ /**
2041
+ * 优惠后总价
2042
+ */
2043
+ RealTotalCost?: string
2044
+
2045
+ /**
2046
+ * 现金账户支出:通过现金账户支付的金额
2047
+ */
2048
+ CashPayAmount?: string
2049
+
2050
+ /**
2051
+ * 赠送账户支出:使用赠送金支付的金额
2052
+ */
2053
+ IncentivePayAmount?: string
2054
+
2055
+ /**
2056
+ * 优惠券支出:使用各类优惠券(如代金券、现金券等)支付的金额
2057
+ */
2058
+ VoucherPayAmount?: string
2059
+
2060
+ /**
2061
+ * 分成金账户支出:通过分成金账户支付的金额
2062
+ 注意:此字段可能返回 null,表示取不到有效值。
2063
+ */
2064
+ TransferPayAmount?: string
2065
+
2066
+ /**
2067
+ * 产品汇总信息
2068
+ 注意:此字段可能返回 null,表示取不到有效值。
2069
+ */
2070
+ Business?: Array<BusinessSummaryInfo>
2071
+ }
2072
+
2073
+ /**
2074
+ * 购买商品信息
2075
+ */
2076
+ export interface UsageDetails {
2077
+ /**
2078
+ * 商品名
2079
+ 注意:此字段可能返回 null,表示取不到有效值。
2080
+ */
2081
+ ProductName: string
2082
+
2083
+ /**
2084
+ * 商品细节
2085
+ 注意:此字段可能返回 null,表示取不到有效值。
2086
+ */
2087
+ SubProductName: string
2088
+ }
2089
+
1839
2090
  /**
1840
2091
  * 使用记录
1841
2092
  */
@@ -1903,20 +2154,23 @@ export interface DescribeDosageCosDetailByDateResponse {
1903
2154
  }
1904
2155
 
1905
2156
  /**
1906
- * 购买商品信息
2157
+ * DescribeBillSummary请求参数结构体
1907
2158
  */
1908
- export interface UsageDetails {
2159
+ export interface DescribeBillSummaryRequest {
1909
2160
  /**
1910
- * 商品名
1911
- 注意:此字段可能返回 null,表示取不到有效值。
1912
- */
1913
- ProductName: string
2161
+ * 账单月份,格式为2023-04
2162
+ */
2163
+ Month: string
1914
2164
 
1915
2165
  /**
1916
- * 商品细节
1917
- 注意:此字段可能返回 null,表示取不到有效值。
1918
- */
1919
- SubProductName: string
2166
+ * 账单维度类型,枚举值如下:business、project、region、payMode、tag
2167
+ */
2168
+ GroupType: string
2169
+
2170
+ /**
2171
+ * 标签键,GroupType=tag获取标签维度账单时传
2172
+ */
2173
+ TagKey?: Array<string>
1920
2174
  }
1921
2175
 
1922
2176
  /**
@@ -2535,31 +2789,50 @@ export interface BillDetail {
2535
2789
  }
2536
2790
 
2537
2791
  /**
2538
- * DescribeBillSummaryByTag返回参数结构体
2792
+ * 产品汇总信息
2539
2793
  */
2540
- export interface DescribeBillSummaryByTagResponse {
2794
+ export interface BusinessSummaryInfo {
2541
2795
  /**
2542
- * 数据是否准备好,0未准备好,1准备好
2543
- Ready=0,为当前UIN首次进行初始化出账,预计需要5~10分钟,请于10分钟后重试
2544
- */
2545
- Ready?: number
2796
+ * 产品编码
2797
+ */
2798
+ BusinessCode?: string
2546
2799
 
2547
2800
  /**
2548
- * 各标签值花费分布详情
2549
- 注意:此字段可能返回 null,表示取不到有效值。
2550
- */
2551
- SummaryOverview?: Array<TagSummaryOverviewItem>
2801
+ * 产品名称:用户所采购的各类云产品,例如:云服务器 CVM
2802
+ */
2803
+ BusinessCodeName?: string
2552
2804
 
2553
2805
  /**
2554
- * 总数
2806
+ * 原价,单位为元。TotalCost字段自账单3.0(即2021-05)之后开始生效,账单3.0之前返回"-"。合同价的情况下,TotalCost字段与官网价格存在差异,也返回“-”。
2555
2807
  注意:此字段可能返回 null,表示取不到有效值。
2556
2808
  */
2557
- SummaryTotal?: SummaryTotal
2809
+ TotalCost?: string
2558
2810
 
2559
2811
  /**
2560
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2812
+ * 优惠后总价
2561
2813
  */
2562
- RequestId?: string
2814
+ RealTotalCost?: string
2815
+
2816
+ /**
2817
+ * 现金账户支出:通过现金账户支付的金额
2818
+ */
2819
+ CashPayAmount?: string
2820
+
2821
+ /**
2822
+ * 赠送账户支出:使用赠送金支付的金额
2823
+ */
2824
+ IncentivePayAmount?: string
2825
+
2826
+ /**
2827
+ * 优惠券支出:使用各类优惠券(如代金券、现金券等)支付的金额
2828
+ */
2829
+ VoucherPayAmount?: string
2830
+
2831
+ /**
2832
+ * 分成金账户支出:通过分成金账户支付的金额
2833
+ 注意:此字段可能返回 null,表示取不到有效值。
2834
+ */
2835
+ TransferPayAmount?: string
2563
2836
  }
2564
2837
 
2565
2838
  /**
@@ -2973,43 +3246,13 @@ export interface ConditionProject {
2973
3246
  }
2974
3247
 
2975
3248
  /**
2976
- * cos产品用量明细返回数据结构
3249
+ * 消耗汇总详情
2977
3250
  */
2978
- export interface CosDetailSets {
2979
- /**
2980
- * 存储桶名称
2981
- */
2982
- BucketName: string
2983
-
2984
- /**
2985
- * 用量开始时间
2986
- */
2987
- DosageBeginTime: string
2988
-
2989
- /**
2990
- * 用量结束时间
2991
- */
2992
- DosageEndTime: string
2993
-
2994
- /**
2995
- * 子产品名称
2996
- */
2997
- SubProductCodeName: string
2998
-
2999
- /**
3000
- * 计费项名称
3001
- */
3002
- BillingItemCodeName: string
3003
-
3004
- /**
3005
- * 用量
3006
- */
3007
- DosageValue: string
3008
-
3251
+ export interface ConsumptionSummaryTotal {
3009
3252
  /**
3010
- * 单位
3253
+ * 折后总价
3011
3254
  */
3012
- Unit: string
3255
+ RealTotalCost: string
3013
3256
  }
3014
3257
 
3015
3258
  /**
@@ -3084,12 +3327,12 @@ export interface DescribeCostSummaryByResourceRequest {
3084
3327
  EndTime: string
3085
3328
 
3086
3329
  /**
3087
- * 每次获取数据量
3330
+ * 每次获取数据量,最大值为100
3088
3331
  */
3089
3332
  Limit: number
3090
3333
 
3091
3334
  /**
3092
- * 偏移量
3335
+ * 偏移量,默认从0开始
3093
3336
  */
3094
3337
  Offset: number
3095
3338
 
@@ -1,5 +1,5 @@
1
1
  import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
2
- import { DescribeCostSummaryByProductRequest, DescribeCostSummaryByProjectResponse, DescribeDosageDetailByDateRequest, DescribeBillSummaryByProductRequest, DescribeBillSummaryByPayModeResponse, DescribeBillSummaryByTagRequest, DescribeBillSummaryByProductResponse, DescribeBillSummaryByRegionResponse, DescribeVoucherInfoResponse, DescribeAccountBalanceRequest, DescribeBillDetailRequest, DescribeCostSummaryByProductResponse, DescribeDosageDetailByDateResponse, DescribeBillListResponse, DescribeAccountBalanceResponse, DescribeCostSummaryByRegionRequest, DescribeBillSummaryByRegionRequest, DescribeBillSummaryByPayModeRequest, DescribeCostSummaryByProjectRequest, DescribeDosageCosDetailByDateResponse, DescribeBillResourceSummaryResponse, DescribeVoucherInfoRequest, DescribeVoucherUsageDetailsRequest, DescribeDealsByCondRequest, DescribeBillResourceSummaryRequest, PayDealsRequest, DescribeBillListRequest, PayDealsResponse, DescribeBillSummaryByTagResponse, DescribeCostSummaryByResourceResponse, DescribeBillDetailResponse, DescribeCostDetailRequest, DescribeVoucherUsageDetailsResponse, DescribeDealsByCondResponse, DescribeBillSummaryByProjectRequest, DescribeBillSummaryByProjectResponse, DescribeCostSummaryByResourceRequest, DescribeCostDetailResponse, DescribeDosageCosDetailByDateRequest, DescribeCostSummaryByRegionResponse } from "./billing_models";
2
+ import { DescribeBillSummaryResponse, DescribeCostSummaryByProductRequest, DescribeCostSummaryByProjectResponse, DescribeDosageDetailByDateRequest, DescribeBillSummaryByProductRequest, DescribeBillSummaryByPayModeResponse, DescribeBillSummaryByTagRequest, DescribeBillSummaryByProductResponse, DescribeBillSummaryByRegionResponse, DescribeVoucherInfoResponse, DescribeAccountBalanceRequest, DescribeBillDetailRequest, DescribeCostSummaryByProductResponse, DescribeBillSummaryByTagResponse, DescribeDosageDetailByDateResponse, DescribeBillListResponse, DescribeAccountBalanceResponse, DescribeCostSummaryByRegionRequest, DescribeBillSummaryByRegionRequest, DescribeBillSummaryByPayModeRequest, DescribeCostSummaryByProjectRequest, DescribeDosageCosDetailByDateResponse, DescribeBillSummaryRequest, DescribeBillResourceSummaryResponse, DescribeVoucherInfoRequest, DescribeVoucherUsageDetailsRequest, DescribeDealsByCondRequest, DescribeBillResourceSummaryRequest, PayDealsRequest, DescribeBillListRequest, PayDealsResponse, DescribeCostSummaryByResourceResponse, DescribeBillDetailResponse, DescribeCostDetailRequest, DescribeVoucherUsageDetailsResponse, DescribeDealsByCondResponse, DescribeBillSummaryByProjectRequest, DescribeBillSummaryByProjectResponse, DescribeCostSummaryByResourceRequest, DescribeCostDetailResponse, DescribeDosageCosDetailByDateRequest, DescribeCostSummaryByRegionResponse } from "./billing_models";
3
3
  /**
4
4
  * billing client
5
5
  * @class
@@ -37,6 +37,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
37
37
  2.对于账单明细数据量级很大(例如每月账单明细量级超过20w)的客户,通过 API 调用账单数据效率较低,建议您开通账单数据存储功能,通过存储桶中获取账单文件进行分析。[账单存储至COS桶](https://cloud.tencent.com/document/product/555/61275)
38
38
  */
39
39
  DescribeBillDetail(req: DescribeBillDetailRequest, cb?: (error: string, rep: DescribeBillDetailResponse) => void): Promise<DescribeBillDetailResponse>;
40
+ /**
41
+ * 该接口支持通过传参,按照产品、项目、地域、计费模式和标签五个维度获取账单费用明细。
42
+ */
43
+ DescribeBillSummary(req: DescribeBillSummaryRequest, cb?: (error: string, rep: DescribeBillSummaryResponse) => void): Promise<DescribeBillSummaryResponse>;
40
44
  /**
41
45
  * 查询订单
42
46
  */
@@ -72,6 +72,12 @@ class Client extends TencentCloudCommon.AbstractClient {
72
72
  async DescribeBillDetail(req, cb) {
73
73
  return this.request("DescribeBillDetail", req, cb);
74
74
  }
75
+ /**
76
+ * 该接口支持通过传参,按照产品、项目、地域、计费模式和标签五个维度获取账单费用明细。
77
+ */
78
+ async DescribeBillSummary(req, cb) {
79
+ return this.request("DescribeBillSummary", req, cb);
80
+ }
75
81
  /**
76
82
  * 查询订单
77
83
  */