Tenant Cloud Management and Audit Billing Management Data structure

Data structure

Last Updated At: 2026-08-02 00:05:54

ListResourceSummaryGatewayList

ListResourceSummaryGatewayList

Referenced by the following interfaces: ListResourceSummaryGateway

name required NULL allowed type description
BizStatus no yes Uint64 Status. 0: terminated; 1: normal.
Example: 1
BizIsolatedTime no yes String The point in time when the resource was released. This is a new parameter. This parameter is not available for the version earlier than V342.
Example: 2018-10-24 10:00:00
Uin no yes String uin
Example: 100004603015
AppId no yes Uint64 app ID
Example: 1255000011
ResourceId no yes String Resource ID.
Example: ins-08cxpupy
AddTime no yes String Creation time.
Example: 2018-10-24 10:00:00
ProductCode yes no String The product code.
Example: p_cvm
SubProductCode yes no String The sub-product code.
Example: sp_cvm_s1
ModifyTime no yes String The point in time when the resource was last modified, including the point in time when the resource was released.
Example: 2018-10-24 10:00:00
RegionId no yes Uint64 The region ID.
Example: 50010
ZoneId no yes Uint64 The region ID.
Example: 40010
ProjectId no yes String ID of the project to which the resources belong.
Example: pr-f1d8de1a
ProductName yes no String Product name.
Example: Virtual Host
ProductGroupName no yes String Product category name.
Example: Compute
SubProductName yes no String The name of the sub-product.
Example: Virtual host (S1 model).
RegionName no yes String The region name.
Example: Region A
ZoneName no yes String The availability zone name.
Example: Region-1
ProductDisplayCode no yes String Product display code.
Example: p_cvm
ProductDisplayName no yes String The display name of the product.
Example: CVM
SubProductDisplayCode no yes String Product display code.
Example: sp_cvm_sh1
SubProductDisplayName no yes String Sub-product display name.
Example: sh1 model

DescribeBillFeeByTagGatewayTotal

Total amount.

Referenced by the following interfaces: DescribeBillFeeByTagGateway

name required NULL allowed type description
RealTotalCost no yes String The total expense amount.
Example: 47699.20
VoucherPayAmount no yes String The voucher amount.
Example: 10.00
PayableAmount no yes String The amount payable.
Example: 47689.20
TaxAmount no yes String Tax-deducted amount.
Example: 0.00
PayAmountIncludedTax no yes String Payment amount including tax.
Example: 47689.20

GetPkgDownloadListItem

The details of bills.

Referenced by the following interfaces: DescribeBillDownloadListGateway

name required NULL allowed type description
MonthName yes no String The billing month.
Example: 2024-11
BeginTime yes no String The beginning of the billing month.
Example: 2018-10-24 10:00:00
EndTime yes no String The end of the billing month.
Example: 2018-10-24 10:00:00
BillStatus yes no Uint64 The status. 0: unsettled. 1: settled but the bill not generated. 2: settled and the bill is being generated. 4. settled and the bill generated.
Example: 0
PayableAmount yes yes String The amount payable.
Example: 4000000
VoucherPayAmount yes yes String The amount deducted by using vouchers.
Example: 4000000
DownloadUrl yes yes String The download URL. This value of this parameter is valid only if the value of the Status parameter is 4.
Example: http://example.com
PeriodType yes no String Cycle type of the current month. Valid values: byUsedTime, byPayTime.
Example: byUsedTime
BillDate yes no Uint64 The statement closing date.
Example: 3
RealTotalCost yes yes String The billing cost. If the bill is unsettled, the value of this parameter is null.
Example: 4000000
AutoConfirmTime yes no String Time when a bill is confirmed automatically.
Example: 2018-12-18 00:00:00
FileStatus yes no Uint64 Bill file status. 1: not generated; 2: generating.
Example: 1
TaskId yes yes String The task ID.
Example: 1213
ConfirmTime yes no String The confirmation time of a bill.
Example: ""
IsDeferConfirm yes no Uint64 Whether to delay confirmation. 0: no; 1: yes.
Example: 0

Tags

List of tags.

Referenced by the following interfaces: DescribeBillDownloadByResourceGateway, DescribeBillDownloadRecordListGateway, DescribeBillDownloadResourceDetailGateway, DescribeBillSummaryByResourceGateway, DescribeBillTrendByMonthGateway, DescribeBspDownloadRecordListGateway, DescribeResourceBillDetailGateway

name required NULL allowed type description
TagKey yes no String Tag key.
Example: tag1
TagValue yes no Array of String Tag value
Example: Cloud Virtual Machine

ProductCodeList

Product information mapping

Referenced by the following interfaces: DescribeProductInfoGateway

name required NULL allowed type description
ProductCode no no String The product code.
Example: p_cvm
ProductName no no String Product name.
Example: Virtual Host
ProductEngName no no String English name of the product.
Example: CVM
SubProduct no no Array of SubProduct Sub-product information
Example:View

ExtraParam

Additional Parameters

Referenced by the following interfaces: DescribeProductInfoGateway

name required NULL allowed type description
Source no no String Whether it is measurement or billing. bsp: measurement; billing: billing.
Example: bsp
StartTime no no Datetime Start time.
Example: 2018-10-24 10:00:00
EndTime no no Datetime End time.
Example: 2018-10-24 10:00:00

Product

The product definition.

Referenced by the following interfaces: DescribeProductsGateway

name required NULL allowed type description
ProductCode yes no String The product code.
Example: p_cvm
ChnName yes no String Name of the product.
Example: Cloud Virtual Machine
EngName no no String English name of the product.
Example: CVM
Status no no Int64 Status. 0: invalid; 1: valid.
Example: 1

DetailConditionValue

The filter conditions.

Referenced by the following interfaces: DescribeResourceBillDetailGateway

name required NULL allowed type description
Product yes no Array of ConditionBusiness The products.
Example:View
SubProduct yes no Array of ConditionProduct The sub-products.
Example:View
BillingItem yes no Array of ConditionComponent The billable items.
Example:View
Region yes no Array of ConditionRegion The regions.
Example:View
PayMode yes no Array of ConditionPayMode The billing methods.
Example:View
ActionType yes no Array of ConditionActionType Transaction type. Valid values: postpay_deduct, prepay_deduct.
Example:View
Tags no yes Array of DescribeResourceBillDetailGatewayTags Tag List
Example:View

ConditionFileStatus

The conditions for filtering file statuses.

Referenced by the following interfaces: DescribeBillDownloadRecordListGateway, DescribeBspDownloadRecordListGateway

name required NULL allowed type description
Status yes no Uint64 Status. 0: generating; 1: generated.
Example: 0
StatusName yes no String The status name.
Example: Generating

ProductPropertyList

The attributes.

Referenced by the following interfaces: DescribeProperties

name required NULL allowed type description
KeyNameCn yes no String Name of the key.
Example: Region
KeyNameEn yes no String The name of the key.
Example: region
KeyCode yes no String The key code. It is the identifier of the attribute key specified by the backend.
Example: region
Fields yes no Array of ProductPropertyFields The attribute fields.
Example:View
Values yes no String Attribute value list, in the format of JSON string. There is an array after json decode, and the keys of array elements are not fixed.
Example: [              {                "RegionId": "80000052",                "RegionCode": "ap-a-region-jcctest-ops",                "ChnName": "Dual-AZ integrated test environment A",                "EngName": "ap-a-region-jcctest-ops",                "RegionType": "domestic",                "RegionTypeName": "domestic",                "Desc": "domestic",                "Status": "1"              }            ]
Modifiable yes no Int64 Indicates whether it can be modified. 0: It cannot be modified. 1: It can be modified.
Example: [{"RegionId":"80000052","RegionCode":"ap-a-region-jcctest-ops","ChnName":"Dual-AZ integrated test environment A","EngName":"ap-a-region-jcctest-ops","RegionType":"domestic","RegionTypeName":"domestic","Desc":"domestic","Status":"1"}]

TagList

Queries the return parameter of the tag list.

Referenced by the following interfaces: GetTagListGateway

name required NULL allowed type description
TagKey yes no String Tag key.
Example: Cloud Virtual Machine
Status yes no Uint64 The status of the tag key. 0: not set; 1: set.
Example: 1
UpdateTime no yes String Update time.
Example: 2025-07-25 20:11:12

ProductPropertyFields

The information about sales attribute fields.

Referenced by the following interfaces: DescribeProperties

name required NULL allowed type description
FieldName yes no String Field name.
Example: Region ID
FieldCode yes no String The field code.
Example: RegionId
FieldFlag yes no String The field flag. Valid values: 0: general field. 1: master field.
Example: 0

DealListData

The information about the orders.

Referenced by the following interfaces: DescribeDealListGateway

name required NULL allowed type description
DealName yes no String The child order ID.
Example: 20240912110368
ProductCode yes no String The product code.
Example: p_cvm
SubProductCode yes no String The sub-product code.
Example: sp_cvm_s1
ProductCodeName yes no String The product name.
Example: p_cvm
SubProductCodeName yes no String The sub-product name.
Example: sp_cvm_s3
DealAction yes no String Order type. tc_open: purchase; tc_change: configuration adjustment; tc_destroy: termination.
Example: tc_destroy
CreateTime yes no Datetime Creation time.
Example: 2018-10-24 10:00:00
UpdateTime yes no Datetime Update time.
Example: 2018-10-24 10:00:00
Payer yes yes String The user who submitted the order.
Example: 100004603015
Status yes no Uint64 The status. 1: pending payment. 2: paid. 3: shipping. 4: shipped. 5: shipping failed. 6: refunded. 7: canceled. 100: deleted.
Example: 1
BigDealId yes no Uint64 The parent order ID.
Example: 20240912110368
GoodsDetail yes yes String The order details. The value is a JSON string.
Example: {"cpu":"48","deviceClass":"VSELF_UDRHZ2","fpga":0,"goodsSubType":"cvm_hour","gpu":0,"isUnderwrite":0,"isWinOs":0,"ladder":2,"mem":"174","pid":260506065,"platform":1,"productCode":"p_cvm","storageBlock":6,"subProductCode":"sp_cvm_udrhz2","sv_cvm_cpu_udrhz2":48,"sv_cvm_dsb_hdd11176g_udrhz2":6,"sv_cvm_mem_udrhz2":174,"timeSpan":"3600","timeUnit":"s"}
PayMode yes no Uint64 Payment mode. 0: pay-as-you-go; 1: prepaid.
Example: 0
GoodsNum yes no String The number of orders.
Example: 100
TaskDetail yes yes String Details of the resource ID returned by the business, which is a JSON string.
Example: {"sub_roc_oid":0,"flow_id":0,"pay_amt":0,"auto_renew_flag":0,"resource_id":["disk-m81l6moa"],"resource_detail":[{"resource_id":"disk-m81l6moa","start_time":"","end_time":"","isolate_time":""}]}
ActionName yes no String Name
Example: Isolation
StatusName yes no String The status name.
Example: Pending payment
Uin yes no String The UIN of the user.
Example: 100004603015
Formula yes no String The formula for calculating values for upgrade.
Example: null
RegionId yes no String The region ID.
Example: 50010
ZoneId yes yes String The availability zone ID.
Example: 40010
Discount yes no Float The discount range. Value range: 0 - 1.
Example: 0.9
DiscountCost yes no Uint64 The amount deducted from the price.
Example: 100
GoodsPrice yes yes String The pricing details of the order, including discount information. The value is a JSON string.
{
    "policyDetail":{
        "total":60,  //total discounts. If the value is 100 , it means no discount.
        "user":60,  //user’s personal discount.
        "common":100 //basic discount of the official website.
    },
    "voucherList":[
        {
            "id":"xxxx",
            "voucherAmount":600
        }
    ]
}
Example: {"totalCost":0,"realTotalCost":0,"price":0,"discount":1,"voucherAmount":0,"policyDetail":null}
VoucherId yes yes String The voucher ID.
Example: 1341057229_202411010011000000010909452710bat672366379274a_001
Price yes no Uint64 The unit price.
Example: 0.001
TotalCost yes no Uint64 The amount payable.
Example: 4000000
ProviderOwnerUin yes yes String The payer.
Example: 100004603015
Creater yes no String The creator.
Example: 100004603015
VoucherDecline yes yes Uint64 The voucher amount.
Example: 10000
VoucherTradeId yes no String The voucher usage transaction ID.
Example: 1341057229_202411010011000000010909452710bat672366379274a_001
RealTotalCost yes no Uint64 The total expense amount.
Example: 4000000

DebtBillListData

The postpaid bill details.

Referenced by the following interfaces: DescribeUserDebtBill

name required NULL allowed type description
DebtBillNo yes no String The bill number.
Example: OPENG100001-20241031-K5x39MRoefkf
DebtBillStatus yes no String The status of the bill. 1: paid off. 2: unpaid off.
Example: 1
BillDate yes no String The billing month. The value is in the yyyymm format.
Example: 202110
BillDateEnd yes no String The end date of each billing cycle. The value is in the yyyymmdd format. This parameter takes effect if the flexible billing cycle mode is used.
Example: 20211010
DueDate yes no String The payment due date. The value is a UNIX timestamp.
Example: 1730702488
DebtInterest yes no String The overdue interest amount.
Example: 80000
TotalDebt yes no String The total debt amount.
Example: 80000
CurrentDebt yes no String The remaining debt amount.
Example: 80000
TotalRefund yes no String The amount paid.
Example: 80000
RefundRecord yes no String The payment records in the following format: time1,refundbillno1,amt1;time2,refundbillno2,amt2;…. The value of the time parameter is a UNIX timestamp.
Example: 1730702488
DuedelayType yes no String The unit of the payment delay period.1: months. 2: days.
Example: 1
DueDelay yes no String The payment delay period. If the value of the DueDelayType parameter is 1, the value of this parameter indicates the corresponding number of months. If the DueDelayType parameter is 2, the value of this parameter indicates the corresponding number of days.
Example: Month
CreateTime yes no String The point in time when the bill was generated. The value is a UNIX timestamp.
Example: 1730702488
LastChgTimes yes no String The point in time when the bill was last updated. The value is a UNIX timestamp.
Example: 1730702488
Remark yes no String The remarks.
Example: Outstanding for 10 months.
Reserve2 no yes String Reserved field 2.
Example: Reserve2

TrendByMonthStat

TrendByMonthStat

Referenced by the following interfaces: DescribeBillTrendByMonthGateway

name required NULL allowed type description
Average yes no TrendByMonthStatItem The average expense.
Example:View

ConditionFileType

The conditions for filtering file types.

Referenced by the following interfaces: DescribeBillDownloadRecordListGateway, DescribeBspDownloadRecordListGateway

name required NULL allowed type description
FileType yes no String File type. Valid values: QuotasList, CustomizedBillResourceSummary, CustomizedBillDetail, BillCommonSummary, DealList, VouchersDetail, QuotasChangeList, MonthlyBills.
Example: QuotasList
FileTypeName yes no String File type name. Valid values: Resource Bill Summary, Instance Resource Summary.
Example: Quota Management
MonthSelected no yes Uint64 Whether it is required to select month. 0: no; 1: yes.
Example: 0

GetDownloadListConditionValue

The conditions for filtering file download records.

Referenced by the following interfaces: DescribeBillDownloadRecordListGateway, DescribeBspDownloadRecordListGateway

name required NULL allowed type description
FileType yes no Array of ConditionFileType File type. Valid values: QuotasList, CustomizedBillResourceSummary, CustomizedBillDetail, BillCommonSummary, DealList, VouchersDetail, QuotasChangeList, MonthlyBills.
Example:View
Status yes no Array of ConditionFileStatus The conditions for filtering file statuses.
Example:View

ProductDefineList

API for querying product definitions.

Referenced by the following interfaces: DescribeProductRelationsGateway

name required NULL allowed type description
ProductCode yes no String The product code.
Example: p_cvm
ProductChnName yes no String Product name.
Example: Cloud Virtual Machine
ProductEngName yes no String English name of the product.
Example: CVM
SubProductCode yes no String The sub-product code.
Example: sp_cvm_s1
SubProductChnName yes no String Name of the sub-product.
Example: CVM (S1 model).
SubProductEngName yes no String The sub-product name.
Example: CVM-S1
BillingItemCode yes no String The code of the billable item.
Example: v_cvm_cpu
BillingItemChnName yes no String Name of the billable item.
Example: CPU
BillingItemEngName yes no String The billable item name.
Example: CPU
SubBillingItemCode yes no String The code of the billable sub-item.
Example: sv_cvm_cpu_s3
SubBillingItemChnName yes no String Name of the billable sub-item.
Example: CPU-S1
SubBillingItemEngName yes no String The billable sub-item name.
Example: CPU-S1
SubBillingItemsGoodNumUnit yes no String The unit of the billable sub-item.
Example: Cores
SubBillingItemsGoodNumUnitEn yes no String The unit of the billable sub-item (English).
Example: Core
Status yes no Int64 Status of four-level definitions. 0: invalid; 1: valid.
Example: 0
Alias yes no String Alias
Example: sv_cvm_cpu_s3
Operator no yes String The last operator.
Example: 100004603015
SourceType no yes String Source type. local; third.
Example: local
Source no yes String Source type, bsp or billing.
Example: billing
ProductGoodNumUnit no yes String Product unit
Example: Pieces
ProductGoodNumUnitEng no yes String Product English unit
Example: instances
SubProductGoodNumUnit no yes String Subproduct unit.
Example: Pieces
SubProductGoodNumUnitEng no yes String Subproduct unit in English.
Example: inctances
BillingItemsGoodNumUnit no yes String Product item unit.
Example: GB
BillingItemsGoodNumUnitEn no yes String Product item unit in English.
Example: GB

ProjectSet

Project and directory list

Referenced by the following interfaces: DescribeBillDownloadByResourceGateway, DescribeBillDownloadRecordListGateway, DescribeBillDownloadResourceDetailGateway, DescribeBillSummaryByResourceGateway, DescribeBillTrendByMonthGateway, DescribeBspDownloadRecordListGateway, DescribeResourceBillDetailGateway, DescribeResourceBillDownloadGateway, ListResourceSummaryDownloadGateway, ListResourceSummaryGateway

name required NULL allowed type description
OrgId no no String Project directory ID
Example: org-7414a2f4
OrgName no no String Project directory name
Example: Bank.
ProjectId no no String Project ID.
Example: pr-f1d8de1a
ProjectName no no String Project Name
Example: Branch construction.
CreatorUin no no String Creator UIN
Example: 100004603015
Creator no no String Creator
Example: 100004603015
CreateTime no no String Creation time.
Example: 2018-10-24 10:00:00

MonthCostDetailItem

The expense information sorted by month.

Referenced by the following interfaces: DescribeBillTrendByMonthGateway

name required NULL allowed type description
Name yes no String The month. Example: December 2018.
Example: December, 2018.
RealTotalCost yes no String The total expense amount.
Example: 4000000
PayableAmount yes no String The amount payable.
Example: 4000000
Month yes no String The month. Example: 2018-12.
Example: 2018-12
VoucherPayAmount yes no String The voucher amount.
Example: 4000000
TaxAmount no yes String Paid tax.
Example: 0.00
PayAmountIncludedTax no yes String Paid amount including tax.
Example: 0.00

DescribeResourceBillDetailGatewayTags

Tag

Referenced by the following interfaces: DescribeResourceBillDetailGateway

name required NULL allowed type description
TagKey no yes String Tag key
Example: QtaCostTagA
TagValue no yes Array of String Tag value
Example: [""]

ConditionRegion

The conditions for filtering regions.

Referenced by the following interfaces: DescribeBillSummaryByResourceGateway, DescribeResourceBillDetailGateway

name required NULL allowed type description
RegionId yes no String The region ID.
Example: 50010
RegionName yes no String The region name.
Example: Region A

Tag

Tag

Referenced by the following interfaces: DescribeBillSummaryByResourceGateway

name required NULL allowed type description
TagKey no yes String Tag key.
Example: aaaaaaa
TagValue no yes Array of String Tag value
Example: ["aa","bb"]

ConditionComponent

The conditions for filtering billable items.

Referenced by the following interfaces: DescribeResourceBillDetailGateway

name required NULL allowed type description
BillingItemCode yes no String The billable item code.
Example: v_cvm_cpu
BillingItemCodeName yes no String Component name.
Example: Cores

SummaryTrend

The expense trend.

Referenced by the following interfaces: DescribeBillFeeByPayModeGateway, DescribeBillFeeByProductGateway, DescribeBillFeeByRegionGateway, DescribeBillFeeByTagGateway

name required NULL allowed type description
Type yes no String Valid values: upward, downward, and none.
Example: upward
Value yes yes String The change rate. The value is accurate to two decimal places.
Example: 100100
PreMonthRealTotalCost yes no String The payment amount of the previous month.
Example: 100100
ValueIncludedTax no yes String Trend percentage (tax included).
Example: 100100
PreMonthPayAmountIncludedTax no yes String Last month's expenses (including tax).
Example: 0.00

SubBillingItem

Sub-product item

Referenced by the following interfaces: DescribeProductInfoGateway

name required NULL allowed type description
SubBillingItemCode no yes String Sub-product item code
Example: sv_cvm_cpu_s3
SubBillingItemName no yes String Sub-product item name
Example: CPU-S1
SubBillingItemEngName no yes String English name of the sub-product item
Example: CPU-S1

SummaryByResourceConditionValue

The conditions for filtering resources.

Referenced by the following interfaces: DescribeBillSummaryByResourceGateway

name required NULL allowed type description
Product yes no Array of ConditionBusiness The products.
Example:View
SubProduct yes no Array of ConditionProduct The sub-products.
Example:View
Region yes no Array of ConditionRegion The regions.
Example:View
PayMode yes no Array of ConditionPayMode The billing methods.
Example:View
ActionType yes no Array of ConditionActionType Transaction type. Valid values: postpay_deduct, prepay_deduct.
Example:View
Tags no yes Array of Tag Tag List
Example:View

CouponInfo

Information about the vouchers.

Referenced by the following interfaces: CouponInfo

name required NULL allowed type description
UserNum yes no String The holder.
Example: 100004603015
Name yes no String The voucher name.
Example: CVM voucher.
CodeId yes no String The voucher ID.
Example: card241031191255600
BatchId yes no String The batch ID.
Example: bat672366379274a
Value yes no Uint64 The face-value.
Example: 200
Balance yes no Uint64 The remaining value.
Example: 100
Status yes no Int64 Status. 1: usable; 3: voided; 9: exhausted; 15: expired.
Example: 1
BeginTime yes no String Start time.
Example: 2018-10-24 10:00:00
EndTime yes no String The point in time when it expires.
Example: 2018-10-24 10:00:00
PayMode yes no String The billing method. 0: postpaid; 1: prepaid.
Example: 0
CreateTime yes no String The point in time when it was issued.
Example: 2018-10-24 10:00:00
ProductInfo yes no String The products supporting the voucher.
Example: [{"name": "\u89c4\u683c\u7c7b\u578b", "value": "\u6807\u51c6\u7248"}, {"name": "\u4ea7\u54c1\u578b\u53f7", "value": "\u5165\u95e8\u578b"}, {"name": "\u5cf0\u503c\u5e26\u5bbd", "value": "1MB/s"}, {"name": "\u78c1\u76d8\u5bb9\u91cf", "value": "10GB"}, {"name": "\u7f51\u7edc", "value": "vpc-ofn1s40f"}, {"name": "\u5b50\u7f51", "value": "subnet-cgh97d9w"}, {"name": "\u96c6\u7fa4", "value": "yf1 cluster"}, {"name": "\u5b9e\u4f8b\u540d", "value": "drms-4df61cdc"}, {"name": "\u6d88\u606f\u4fdd\u7559\u65f6\u957f", "value": "1440\u5206"}]
SpId yes no String The voucher ID.
Example: 1341057229_202411010011000000010909452710bat672366379274a_001
BatchCreateTime yes no Datetime Batch creation time.
Example: 2018-10-24 10:00:00
CreateUin yes no String The issuer.
Example: 100004603015
Type no yes String card: coupon; balance: balance voucher.
Example: balance
DrmActionId no yes String DrmActionId
Example: 100004603015

RegionDetail

List of region information.

Referenced by the following interfaces: DescribeRegion

name required NULL allowed type description
TotalNum yes no String Total number.
Example: 100
RegionList yes no Array of String The regions.
Example: ["Region A"]

DetailTotal

The payment summary details.

Referenced by the following interfaces: DescribeResourceBillDetailGateway

name required NULL allowed type description
RealTotalCost yes no String The total expense amount.
Example: 4000000
PayableAmount yes no String The amount payable.
Example: 4000000
VoucherPayAmount yes no String The voucher amount.
Example: 4000000
TaxAmount yes no String Tax amount.
Example: 0.00000000
PayAmountIncludedTax no yes String Paid amount including tax.
Example: 0.00

GetDownloadListRecordItem

The download details.

Referenced by the following interfaces: DescribeBillDownloadRecordListGateway, DescribeBspDownloadRecordListGateway

name required NULL allowed type description
FileId yes no String The file ID.
Example: 9ecdb930-06e8-9f92-558b-ff548d359626
FileType yes no String File type. Valid values: QuotasList, CustomizedBillResourceSummary, CustomizedBillDetail, BillCommonSummary, DealList, VouchersDetail, QuotasChangeList, MonthlyBills.
Example: QuotasList
FileTypeName yes no String The file type name.
Example: Quota Management
FileName yes no String The file name.
Example: 100004603270-2024-11-06-Quotas-Lists-1730875608.zip_billing6a24e5f4-746d-d0d7-ff15-e2ba07ce11be
Status yes no Uint64 Status. 0: generating; 1: generated.
Example: 0
TaskId no yes String The task ID.
Example: 14133
GenerateTime no yes String The point in time when the file generated.
Example: 2018-10-24 10:00:00
DownloadTime no yes String The download time.
Example: 2018-10-24 10:00:00
DownloadUrl no yes String The download URL.
Example: http://example.com

RegionSummaryDetailItem

The payment summary details sorted by region.

Referenced by the following interfaces: DescribeBillFeeByRegionGateway

name required NULL allowed type description
Product yes no Array of BusinessSummaryDetailItem The payment summary of the products in the project.
Example:View
RegionId yes no Uint64 The region ID.
Example: 50010
RegionName yes no String The region name.
Example: Region A
RealTotalCost yes no String The total expense amount.
Example: 4000000
PayableAmount yes no String The amount payable.
Example: 4000000
VoucherPayAmount yes no String The voucher amount.
Example: 4000000
Trend yes no SummaryTrend The comparison to the previous month.
Example:View
PayAmountIncludedTax no yes String Payment amount including tax.
Example: 0.00
TaxAmount no yes String Tax-deducted amount.
Example: 0.00

WaterListData

The transaction record information.

Referenced by the following interfaces: DescribeAccountWater

name required NULL allowed type description
WaterType yes no String Record type. 1: user transaction record; 2: system transaction record; 3: management transaction record.
Example: 1
IoFlag yes no String 1: expenditure. 2: income.
Example: 1
ExternTranType yes no String The transaction types for external users.  2: pay. 10: transfer. 19: repay. 20: write off 21: pre-authorize. 22: cancel pre-authorization (restore quota). 23: confirm pre-authorization (expense). 24: refund. 25: generate bill. 26: modify bill. 27: add temporary credit. 28: cancel repayment. 29: confirm to return pre-authorization. 30: modify pre-authorization. 31: return pre-authorization.
Example: 2
BaseTranType yes no String The transaction types for internal servers. 2: pay. 10: open account. 14: deduct money for transferring. 16: deduct money for topping up. 17: cancel transfer. 42: close account. 52: increase credit for postpaid resources. 53: reduce credit for postpaid resources. 54: modify account information (except adjusting quota) for postpaid resources. 55: repay. 56: write off. 57: prepay. 58: deduct bills. 59: pre-authorize. 60: cancel pre-authorization (restore quota). 61: cancel pre-authorization configuration (restore quota). 62: confirm pre-authorization (expense). 63: pre-authorize for an order. 64: cancel pre-authorization for an order. 65: refund (to top up the balance). 66: restore credit. 67: supplementary deduction. 68: add amount to a bill (billing tool). 69: reduce amount from a bill (billing tool). 70: restore cash amount (billing tool). 71: modify a bill resulting in balance increasing (billing tool). 72: modify a bill resulting in balance reduction (billing tool). 73: add temporary credit. 74: cancel repayment. 75: cancel write-off. 76: cancel prepayment. 82: modify pre-authorization to increase the pre-authorized amount and reduce account count. 83: modify pre-authorization to reduce the pre-authorized amount and increase account count. 84: modify pre-authorization to increase the pre-authorized amount and add more pre-authorization orders. 85: modify pre-authorization to increase the pre-authorized amount and reduce more pre-authorization orders. 86: Return pre-authorization. 87: supplementary deduction for pre-authorization.
Example: 2
BillNo yes no String The child order ID.
Example: 20240912110368
TranAmt yes no String The amount.
Example: 800000
Balance yes no String The balance. The account attribute of a postpay account determines whether the balance of the account is the value of the pbalance or the result of dpbalance + cash.
Example: 800000
CreateTime yes no String The point in time when the transaction was performed.
Example: 2018-10-24 10:00:00
Source yes no String The source.
Example: Taobao.
Device yes no String The device type. 0: PC. 1: mobile phone.
Example: 1
UserIp yes no String The user ID.
Example: 127.0.0.1
TranInfo yes no String The description of the transaction.
Example: Purchase CVM.
Remark yes no String The remarks of the transaction.
Example: Purchase CVM.
Reserve1 yes no String Reserved field 1
Example: null
Reserve2 yes no String Reserved field 2
Example: null
Extreserve1 yes no String Extended reserved field 1 from external sources.
Example: null
Extreserve2 yes no String Extended reserved field 2 from external sources.
Example: null
RelationId yes no String The associated ID, such as the write-off transaction ID.
Example: 10010
Dplimit yes no String The total credit amount.
Example: 9000000
Dpbalance yes no String The remaining credit amount for postpaid resources. The account attribute determines whether the cash amount is included in the credit amount.
Example: 9000000
Cash yes no String The cash balance.
Example: 100100
MerchantType yes no String The merchant type. 1: agent. 2: sub-customer 3: direct customer
Example: 1
RelatedMerchant yes no String The related merchant. If the value of the MerchantType parameter is 1 or 3, the value of this parameter is empty. If the value of the MerchantType parameter is 2, the value of this parameter is the information about the agent.
Example: John Doe
Reserve3 yes no String Reserved field 3 (storing the timestamp when the transaction record was inserted to the database)
Example: 2018-10-24 10:00:00
Reserve4 yes no String Reserved field 4 (1. The flag for account modification. 2. The write-off transaction ID in repayment records. 3. The AllOffSet flag for writing off all amount of a bill.)
Example: 1
Reserve5 yes no String Reserved field 5 ( The transaction time. Unit: us.)
Example: 1730702488000
Reserve6 yes no String Reserved field 6 ( write-off records: TotalRefund,1000;CurDebt,1110;DebtBillDate,201706; PayChannel,bank;)
Example: CurDebt
Reserve7 yes no String Reserved field 7 (The credit amount restored after write-off.  Type: repayment type. Recover: restored credit amount. ChgTimeUs: the transaction pending period. Unit: us. TranSeq: The transaction sequence number.
Example: Recover
Reserve8 yes no String Reserved field 8.
Example: null

PayModeSummaryDetailItem

The payment summary details sorted by billing method.

Referenced by the following interfaces: DescribeBillFeeByPayModeGateway

name required NULL allowed type description
PayMode yes no String Billing mode. 0: postPay; 1: prePay.
Example: prePay
PayModeName yes no String The billing method name.
Example: prePay
RealTotalCost yes no String The total expense amount.
Example: 4000000
PayableAmount yes no String The amount payable.
Example: 4000000
VoucherPayAmount yes no String The voucher amount.
Example: 4000000
Trend yes no SummaryTrend The comparison to the previous month.
Example:View
Product yes no Array of BusinessSummaryDetailItem The product code (layer-1).
Example:View
PayAmountIncludedTax no yes String Payment amount including tax.
Example: 0.00
TaxAmount no yes String Tax-deducted amount.
Example: 0.00

DescribeDownloadQuotasListGatewayData

DescribeDownloadQuotasListGatewayData

Referenced by the following interfaces: DescribeDownloadQuotasListGateway

name required NULL allowed type description
TaskId no yes Uint64 The task ID.
Example: 35176

BusinessSummaryOverviewItem

The product details sorted by product.

Referenced by the following interfaces: DescribeBillSummaryByTagGateway

name required NULL allowed type description
ProductCode no yes String The product code.
Example: p_cvm
ProductCodeName no yes String Product name.
Example: p_cvm
RealTotalCost yes no String The total expense amount.
Example: 47699.20
RealTotalCostRatio yes no String The total expense amount ratio. The value is accurate to two decimal places.
Example: 100.00
PayAmountIncludedTax yes no String Payment amount including tax.
Example: 47689.20
PayAmountIncludedTaxRatio yes no String Tax rate, with 2 decimal places
Example: 1.0
TagValue yes yes String Tag value
Example: Cloud Virtual Machine

DetailDetailItem

The bill details.

Referenced by the following interfaces: DescribeResourceBillDetailGateway

name required NULL allowed type description
OwnerUin yes no String The UIN of the resource holder.
Example: 100004603015
PayerUin yes no String The UIN of the payer.
Example: 100004603015
OperateUin yes no String The UIN of the operator.
Example: 100004603015
PayMode yes no String The billing method.
Example: 0
PayModeName yes no String The billing method name.
Example: prePay
ResourceId yes no String Resource ID.
Example: ins-08cxpupy
ProjectId no no String Project ID.
Example: pr-f1d8de1a
ResourceName yes no String Resource name.
Example: CVM for personal use.
ProductCode yes no String The product code.
Example: p_cvm
ProductCodeName yes no String Product name.
Example: p_cvm
SubProductCode yes no String The sub-product code.
Example: sp_cvm_s1
SubProductCodeName yes no String The name of the sub-product.
Example: sp_cvm_s3
BillingItemCode yes no String Component type.
Example: v_cvm_cpu
BillingItemCodeName yes no String The billable item type.
Example: Cores
SubBillingItemCode yes no String The billable item code.
Example: sv_cvm_cpu_s3
SubBillingItemCodeName yes no String Component name.
Example: Cores
ActionType yes no String Transaction type. Valid values: postpay_deduct, prepay_deduct.
Example: postpay_deduct
ActionTypeName yes no String The transaction type name.
Example: Pay-as-you-go deduction.
RegionId yes no String The region ID.
Example: 50010
RegionName yes no String The region name.
Example: Region A
RegionType yes no String Region type. Valid values: domestic, intl.
Example: domestic
RegionTypeName yes no String Region type name. Valid values: domestic, international.
Example: domestic
ZoneId yes no String The availability zone ID.
Example: 40010
ZoneName yes no String AZ name.
Example: AZ-1
PayTime yes no String The point in time when the order was paid.
Example: 2018-10-24 10:00:00
FeeBeginTime yes no String The beginning of the validity period.
Example: 2018-10-24 10:00:00
FeeEndTime yes no String The end of the validity period.
Example: 2018-10-24 10:00:00
TimeSpan yes no String The length of the validity period.
Example: 3600
TimeUnit yes no String Time unit name. Valid values: year, month, day, hour, minute, second.
Example: second
TimeUnitName yes no String Time unit name. Valid values: year, month, day, hour, minute, second.
Example: Year
OrderId yes no String The child order ID.
Example: 20240912110368
BillId yes no String The transaction ID.
Example: OPENG100001-20241101-2AX39MR4fkf1
SinglePrice yes no String The unit price of the billable item.
Example: 0.001
SinglePriceUnit yes no String The unit of the billable item price.
Example: USD/GB/second.
UsedAmount yes no String The used amount.
Example: 4000000
UsedAmountUnit yes no String The unit of the billable usage.
Example: Cores
Discount yes no String The discount.
Example: 1.0
PayableAmount yes no String The amount payable.
Example: 4000000
VoucherPayAmount yes no String The amount deducted by using vouchers.
Example: 4000000
TotalDiscount yes no String Discount.
Example: 1.0
AccountName yes no String The account name.
Example: John Doe
RealTotalCost yes no String The total discount price.
Example: 4000000
TotalCost yes no String The total original price.
Example: 4000000
AppId yes no String The account ID.
Example: 1255000011
TaxAmount no yes String Paid tax.
Example: 0.00
PayAmountIncludedTax no yes String Payment amount including tax.
Example: 447.48
TaxRate yes no String Tax rate
Example: 1

Conditions

The conditions for filtering bills.

Referenced by the following interfaces: DescribeBillDownloadByResourceGateway, DescribeBillDownloadRecordListGateway, DescribeBillDownloadResourceDetailGateway, DescribeBillSummaryByResourceGateway, DescribeBillTrendByMonthGateway, DescribeBspDownloadRecordListGateway, DescribeResourceBillDetailGateway

name required NULL allowed type description
TimeRange no no Uint64 Valid values: 6 and 12.
Example: 6
RegionId no no Int64 The region ID.
Example: 50010
PayMode no no String The billing method. Valid values: prePay and postPay.
Example: prePay
ResourceKeyword no no String The resource keyword.
Example: cvm
ProjectId no no String ID of the project to which resources belong
Example: pr-f1d8de1a
OrgIds no no Array of String Project directory ID list
Example: ["org-7414a2f4"]
ProjectSet no no Array of ProjectSet Project and directory list
Example:View
ProductCodes no no Array of String The product code.
Example: ["p_cvm"]
SubProductCodes no no Array of String The sub-product code.
Example: ["sp_cvm_s3"]
RegionIds no no Array of Int64 The region ID.
Example: ["50010"]
PayModes no no Array of String The billing method. Valid values: prePay and postPay.
Example: ["prePay"]
ActionTypes no no Array of String Transaction type. Valid values: postpay_deduct, prepay_deduct.
Example: ["postpay_deduct"]
HideFreeCost no no Int64 Indicates whether to hide the records without payments.
Example: 1
OrderByCost no no String The sorting method. Valid values: desc and asc.
Example: desc
BillIds no no Array of String The transaction ID.
Example: ["OPENG100001-20241031-K6039MRoefl0"]
BillingItemCodes no no Array of String The billable item ID.
Example: ["v_cvm_cpu"]
FileIds no no Array of String The file ID.
Example: ["6a8ce209-cd15-e30d-6d12-deb37044afd5"]
FileTypes no no Array of String File type. Valid values: MonthlyBills, CustomizedBillResourceSummary, CustomizedBillDetail.
Example: ["MonthlyBills"]
Status no no Array of Uint64 Status. 0: generating; 1: generated.
Example: 1
SubBillingItemCodes no no String The billable sub-item code.
Example: ["sv_cvm_cpu_s3"]
ExportFields no no Array of String The fields exported.
Example: ["productCode,"subProductCode""]
ProductCode no no String The product code.
Example: p_cvm
Tags no no Array of Tags List of tags.
Example:View
ExportTags no no Array of String The tags exported.
Example: ["tag1"]
TagKey no no String Tag key.
Example: tag1
TagValue no no String Tag value
Example: Bank.

RemitRecordData

The remittance information.

Referenced by the following interfaces: DescribeRemitRecordGateway

name required NULL allowed type description
Uin yes no Uint64 The UIN of the user.
Example: 100004603015
Bank yes no String The bank name.
Example: Bank.
AccountNum yes no String The bank account number of the beneficiary.
Example: 4392268888888888
AccountName yes no String The account name of the beneficiary.
Example: John Doe
CreateTime yes no Datetime The point in time when the remittance was performed.
Example: 2018-10-24 10:00:00
Tel yes no String The phone number of the contact.
Example: 177111111
Status yes no Uint64 The status. 0: processing. 1: successful. 2: failed.
Example: 0
UpdateTime yes no Datetime Modification time.
Example: 2018-10-24 10:00:00
Desc yes no String Description.
Example: Transfer
Id yes no Uint64 ID
Example: 100
Creator yes no String The remittor.
Example: 100004603015
Reason yes yes String Reason.
Example: No reason.
Amount yes no Uint64 The amount.
Example: 4000000
RemitDate yes no String The point in time when the remittance was performed.
Example: 2018-10-24 10:00:00

TagData

Tag list.

Referenced by the following interfaces: GetTagListGateway

name required NULL allowed type description
TagList yes yes Array of TagList Tag list.
Example:View
RecordNum yes no Uint64 Number of tags.
Example: 100

ConditionPayMode

The conditions for filtering billing methods.

Referenced by the following interfaces: DescribeBillSummaryByResourceGateway, DescribeResourceBillDetailGateway

name required NULL allowed type description
PayMode yes no String The billing method.
Example: 0
PayModeName yes no String Payment mode name. Valid values: prePay, postPay.
Example: prePay

TrendByMonthStatItem

TrendByMonthStatItem

Referenced by the following interfaces: DescribeBillTrendByMonthGateway

name required NULL allowed type description
BeginMonth yes no String The start month. Example: 2018-05.
Example: 2018-05
EndMonth yes no String The end month. Example: 2018-11.
Example: 2018-05
PayableAmount yes no String The amount payable.
Example: 4000000
VoucherPayAmount yes no String The voucher amount.
Example: 4000000
RealTotalCost yes no String The total expense amount.
Example: 4000000
TaxAmount no yes String Paid tax.
Example: 0.00
PayAmountIncludedTax no yes String Payment amount including tax.
Example: 0.00

GetDownloadListSort

The method for sorting the downloaded records.

Referenced by the following interfaces: DescribeBillDownloadRecordListGateway, DescribeBspDownloadRecordListGateway

name required NULL allowed type description
DownloadTime no no String Valid values: desc and asc.
Example: 2018-10-24 10:00:00
GenerateTime no no String Valid values: desc and asc.
Example: 2018-10-24 10:00:00

BigDealListData

The information about parent orders.

Referenced by the following interfaces: DescribeDealListGateway

name required NULL allowed type description
BigDealId yes no Uint64 The parent order ID.
Example: 20240912110368
Uin yes no String The unique identifier of the user.
Example: 100004603015
ProductCode yes no String The product code.
Example: p_cvm
SubProductCode yes no String The sub-product code.
Example: sp_cvm_s1
ProductCodeName yes no String Product name.
Example: p_cvm
SubProductCodeName yes no String The name of the sub-product.
Example: sp_cvm_s3
DealAction yes no String Order type. tc_open: purchase; tc_change: configuration adjustment; tc_destroy: termination.
Example: tc_destroy
ActionName yes no String Action name.
Example: Isolation
CreateTime yes no String Creation time.
Example: 2018-10-24 10:00:00
UpdateTime yes no String Update time.
Example: 2018-10-24 10:00:00
OverdueTime yes no Datetime The point in time when the order expires.
Example: 2018-10-24 10:00:00
PayEndTime yes no Datetime The payment time.
Example: 2018-10-24 10:00:00
Payer yes yes String The creator.
Example: 100004603015
Status yes no Uint64 The status. 1: pending payment. 2: paid. 3: shipping. 4: shipped. 5: shipping failed. 6: refunded. 7: canceled. 100: deleted.
Example: 1
TotalCost yes no Uint64 The amount payable.
Example: 4000000
VoucherDecline yes no Uint64 The voucher amount.
Example: 20000
RealTotalCost yes no Uint64 The amount actually paid.
Example: 4000000
ProviderOwnerUin yes yes String The payer.
Example: 100004603015
StatusName yes no String Status name. Valid values: to be paid, paid, in shipment, shipment successful, shipment failed, refunded, canceled, deleted.
Example: Paid
DealList yes no Array of DealListData The child order list.
Example:View
DiscountCost yes no Uint64 The amount deducted from the total price.
Example: 5000
Creater yes no String The creator.
Example: 100004603015

ListResourceDetailGatewayList

ListResourceDetailGatewayList

Referenced by the following interfaces: ListResourceDetailGateway

name required NULL allowed type description
ProductCode yes no String The product code.
Example: p_cvm
SubProductCode yes no String The sub-product code.
Example: sp_cvm_s1
Num yes no Uint64 The resource quantity.
Example: 10
ModifyTime no yes String The point in time when the resource was last modified, including the point in time when the resource was released.
Example: 2018-10-24 10:00:00
BillingItemCode yes no String The billable item code.
Example: v_cvm_cpu
SubBillingItemCode yes no String The billable sub-item code.
Example: sv_cvm_cpu_s3
ProductName yes no String Product name.
Example: Virtual Host
ProductGroupName no yes String Product category name.
Example: Compute
SubProductName yes no String The name of the sub-product.
Example: Virtual host (S1 model).
BillingItemName yes no String The billable item name.
Example: CPU
SubBillingItemName yes no String The billable sub-item name.
Example: CPU-S1
UnitName yes no String The unit.
Example: Cores
Status no yes Int64 Status. 0: terminated; 1: normal.
Example: 0
ProductDisplayCode no yes String Product display code.
Example: p_cvm
ProductDisplayName no yes String The display name of the product.
Example: CVM
SubProductDisplayCode no yes String Product display code.
Example: sp_cvm_sh1
SubProductDisplayName no yes String Sub-product display name.
Example: sh1 model
BillingItemDisplayCode no yes String Product item display code.
Example: v_cvm_mem
BillingItemDisplayName no yes String Product item display name.
Example: Memory
SubBillingItemDisplayCode no yes String Product details display code.
Example: sv_cvm_mem_sh1
SubBillingItemDisplayName no yes String Product details display name.
Example: Memory of sh1 model

PageTenantQuotaResponse

Paging query quota data.

Referenced by the following interfaces: PageTenantQuotaGateway

name required NULL allowed type description
Uin no yes String User UIN
Example: 110000000674
ProductCode no yes String Product code.
Example: p_cfs
QuotaKey no yes String Quota key.
Example: p_cfs###
QuotaValue no yes String Quota
Example: 100
UpdateTime no yes String Update time.
Example: 2025-06-18 10:42:17
Source no yes String Source. bsp: metering; billing: billing.
Example: bsp
WarningThreshold no yes Uint64 Threshold warning
Example: 10
SubProductCode no yes String Sub-product code.
Example: sp_cbs_ssd
BillingItemCode no yes String Product item Code.
Example: v_cvm_cpu
SubBillingItemCode no yes String Product details code.
Example: sv_cvm_cpu_u
ProductName no yes String Product name.
Example: CVM
ProductEngName no yes String English name of the product.
Example: CVM
ProductGroupName no yes String Product grouping name
Example: Compute
ProductGroupEngName no yes String Product grouping name in English.
Example: Compute
UnitName no yes String The unit.
Example: Cores
SubProductName no yes String The name of the sub-product.
Example: Cloud File Storage-Extreme
SubProductEngName no yes String The sub-product name.
Example: Cloud File Storage-Extreme
BillingItemName no yes String The billable item name.
Example: CPU
BillingItemEngName no yes String The billable item name.
Example: CPU
SubBillingItemName no yes String Product item name
Example: CPU-Big Data
SubBillingItemEngName no yes String The billable sub-item name.
Example: CPU_Big Data
UsedQuota no yes Uint64 Used quota.
Example: 0
Quota no yes Uint64 Tenant used quota.
Example: 0
AllQuota no yes Uint64 Quota used by the root account
Example: 0

DescribeBillFeeByTagSummaryProductTrend

DescribeBillFeeByTagSummaryProductTrend

Referenced by the following interfaces: DescribeBillFeeByPayModeGateway, DescribeBillFeeByProductGateway, DescribeBillFeeByRegionGateway, DescribeBillFeeByTagGateway

name required NULL allowed type description
Type yes no String Valid values: upward, downward, and none.
Example: upward
Value yes yes String The change rate. The value is accurate to two decimal places.
Example: 100100
PreMonthRealTotalCost yes no String The payment amount of the previous month.
Example: 100100
ValueIncludedTax no yes String Trend percentage (tax included).
Example: 100100
PreMonthPayAmountIncludedTax no yes String Last month's expenses (including tax).
Example: 0.00

SubProduct

Subproduct

Referenced by the following interfaces: DescribeProductInfoGateway

name required NULL allowed type description
SubProductCode no no String The sub-product code.
Example: sp_cvm_s1
SubProductName no no String The name of the sub-product.
Example: Virtual host (S1 model).
SubProductEngName no no String The sub-product name.
Example: CVM-S1
BillingItem no no Array of BillingItem Product details
Example:View

ConditionActionType

The conditions for filtering transaction types.

Referenced by the following interfaces: DescribeBillSummaryByResourceGateway, DescribeResourceBillDetailGateway

name required NULL allowed type description
ActionType yes no String Transaction type. Valid values: postpay_deduct, prepay_deduct.
Example: postpay_deduct
ActionTypeName yes no String The transaction type name.
Example: Pay-as-you-go deduction.

ConditionBusiness

The conditions for filtering products.

Referenced by the following interfaces: DescribeBillSummaryByResourceGateway, DescribeResourceBillDetailGateway

name required NULL allowed type description
ProductCode yes no String The product code.
Example: p_cvm
ProductCodeName yes no String Product name.
Example: p_cvm

BusinessSummaryTotal

The expenses sorted by product.

Referenced by the following interfaces: DescribeBillSummaryByTagGateway

name required NULL allowed type description
RealTotalCost yes no String The total expense amount.
Example: 4000000
PayAmountIncludedTax no yes String Paid amount including tax.
Example: 4000000

SummaryByResourceTotal

The payment summary sorted by resource.

Referenced by the following interfaces: DescribeBillSummaryByResourceGateway

name required NULL allowed type description
PayableAmount yes no String The amount payable.
Example: 4000000
VoucherPayAmount yes no String The amount deducted by using vouchers.
Example: 4000000
RealTotalCost yes no String The actual amount.
Example: 4000000
PayAmountIncludedTax no yes String Paid amount including tax.
Example: 0.00
TaxAmount no no String Tax-deducted amount.
Example: 100101

TrendByMonthDetail

TrendByMonthDetail

Referenced by the following interfaces: DescribeBillTrendByMonthGateway

name required NULL allowed type description
Current yes no Array of MonthCostDetailItem The statistics of the current month.
Example:View
Previous yes no Array of MonthCostDetailItem The statistics of the previous months.
Example:View
Next yes no Array of MonthCostDetailItem The statistics of the future months.
Example:View

BusinessSummaryDetailItem

The bill details sorted by product.

Referenced by the following interfaces: DescribeBillFeeByPayModeGateway, DescribeBillFeeByProductGateway, DescribeBillFeeByRegionGateway, DescribeBillFeeByTagGateway

name required NULL allowed type description
ProductCode no yes String The product code.
Example: p_cvm
ProductCodeName no yes String Product name.
Example: p_cvm
RealTotalCost yes no String The total expense amount.
Example: 4000000
PayableAmount yes no String The amount payable.
Example: 4000000
VoucherPayAmount yes no String The voucher amount.
Example: 4000000
Trend yes no SummaryTrend The comparison to the previous month.
Example:View
TagKey no yes String Tag key.
Example: key
TagValue no yes String Tag value
Example: value
TaxAmount no yes String Tax-deducted amount.
Example: 0.00
PayAmountIncludedTax no yes String Payment amount including tax.
Example: 447.48
Product no no Array of DescribeBillFeeByTagSummaryProduct Product Information
Example:View

SummaryByResourceDataItem

The payment summary details sorted by resource.

Referenced by the following interfaces: DescribeBillSummaryByResourceGateway

name required NULL allowed type description
Id yes no String The record ID.
Example: 100
PayerUin yes no String The UIN of the payer.
Example: 100004603015
ProductCode yes no String The product code.
Example: p_cvm
ProductCodeName yes no String Product name.
Example: p_cvm
SubProductCode yes no String The sub-product code.
Example: sp_cvm_s1
SubProductCodeName yes no String The name of the sub-product.
Example: sp_cvm_s3
ResourceId yes no String Resource ID.
Example: ins-08cxpupy
ProjectId no no String Project ID.
Example: pr-f1d8de1a
ResourceName yes no String Resource name.
Example: CVM for personal use.
RealTotalCost yes no String The total price.
Example: 4000000
PayableAmount yes no String The amount payable.
Example: 4000000
VoucherPayAmount yes no String The amount deducted by using vouchers.
Example: 4000000
RegionName yes no String The region name.
Example: Region A
PayModeName yes no String Payment mode name. Valid values: prepaid, pay-as-you-go.
Example: prePay
PayMode yes no String Payment mode. 0: pay-as-you-go; 1: prepaid.
Example: 0
RegionId yes no String The region ID.
Example: 50010
BillId yes no String The bill ID.
Example: OPENG100001-20241101-2AX39MR4fkf1
OwnerUin yes no String The UIN of the resource holder.
Example: 100004603015
OperateUin yes no String The UIN of the operator.
Example: 100004603015
ActionTypeName yes no String The transaction type name.
Example: Pay-as-you-go deduction.
ZoneName yes no String AZ name.
Example: AZ-1
PayTime yes no String The point in time when the order was paid.
Example: 2018-10-24 10:00:00
FeeBeginTime yes no String The beginning of the validity period.
Example: 2018-10-24 10:00:00
FeeEndTime yes no String The end of the validity period.
Example: 2018-10-24 10:00:00
ComponentConfig yes no String The billable item configuration.
Example: SSD cloud disk (storage space: 1400 GB)
AccountName yes yes String The account name.
Example: John Doe
TotalCost yes no String The original price.
Example: 4000000
OrderId yes yes String The order ID
Example: 20240912110368
TotalDiscount yes no String The discount rate.
Example: 100
TaxAmount no yes String Tax-deducted amount.
Example: 0.00
PayAmountIncludedTax no yes String Payment amount including tax.
Example: 447.48

BillingItem

Product details

Referenced by the following interfaces: DescribeProductInfoGateway

name required NULL allowed type description
BillingItemCode no no String Product item code
Example: v_cvm_cpu
BillingItemName no no String Product item name
Example: CPU
BillingItemEngName no no String The billable sub-item name.
Example: CPU
SubBillingItem no no Array of SubBillingItem Sub-product item
Example:View

DescribeBillFeeByTagSummaryProduct

DescribeBillFeeByTagSummaryProduct

Referenced by the following interfaces: DescribeBillFeeByPayModeGateway, DescribeBillFeeByProductGateway, DescribeBillFeeByRegionGateway, DescribeBillFeeByTagGateway

name required NULL allowed type description
ProductCode no yes String The product code.
Example: p_cvm
ProductCodeName no yes String Product name.
Example: p_cvm
RealTotalCost yes no String The total expense amount.
Example: 47699.20
PayableAmount yes no String The amount payable.
Example: 4000000
VoucherPayAmount yes no String The voucher amount.
Example: 4000000
TaxAmount no yes String Paid tax.
Example: 0.00
PayAmountIncludedTax no yes String Paid amount including tax.
Example: 0.00
Trend no no DescribeBillFeeByTagSummaryProductTrend Trend
Example:View

ListResourceModifyLogGatewayList

ListResourceModifyLogGatewayList

Referenced by the following interfaces: ListResourceModifyLogGateway

name required NULL allowed type description
ProductCode yes no String The product code.
Example: p_cvm
SubProductCode yes no String The sub-product code.
Example: sp_cvm_s1
BillingItemCode yes no String The billable item code.
Example: v_cvm_cpu
SubBillingItemCode yes no String The billable sub-item code.
Example: sv_cvm_cpu_s3
Num yes no Uint64 The resource quantity.
Example: 10
ModifyTime no yes String The point in time when the resource was last modified, including the point in time when the resource was released.
Example: 2018-10-24 10:00:00
ProductName yes no String Product name.
Example: Virtual Host
ProductGroupName no yes String Product category name.
Example: Compute
SubProductName yes no String The name of the sub-product.
Example: Virtual host (S1 model).
BillingItemName yes no String The billable item name.
Example: CPU
SubBillingItemName yes no String The billable sub-item name.
Example: CPU-S1
UnitName yes no String The unit.
Example: Cores
ProductDisplayCode no yes String Product display code.
Example: p_cvm
ProductDisplayName no yes String The display name of the product.
Example: CVM
SubProductDisplayCode no yes String Product display code.
Example: sp_cvm_sh1
SubProductDisplayName no yes String Sub-product display name.
Example: sh1 model
BillingItemDisplayCode no yes String Product item display code.
Example: v_cvm_mem
BillingItemDisplayName no yes String Product item display name.
Example: Memory
SubBillingItemDisplayCode no yes String Product details display code.
Example: sv_cvm_mem_sh1
SubBillingItemDisplayName no yes String Product details display name.
Example: Memory of sh1 model

ConditionProduct

The conditions for filtering sub-products.

Referenced by the following interfaces: DescribeBillSummaryByResourceGateway, DescribeResourceBillDetailGateway

name required NULL allowed type description
SubProductCode yes no String The product code.
Example: sp_cvm_s1
SubProductCodeName yes no String Product name.
Example: sp_cvm_s3