tencent cloud

文档反馈

Data Types

最后更新时间:2022-08-25 10:25:27

ActionSummaryOverviewItem

Detailed summary of costs by transaction type

Used by actions: DescribeBillSummaryByPayMode.

Name Type Description
ActionType String Transaction type
ActionTypeName String Transaction type name
RealTotalCost String Actual cost
RealTotalCostRatio String Cost ratio, to two decimal points
CashPayAmount String Cash amount
IncentivePayAmount String Trial credit amount
VoucherPayAmount String Voucher amount
BillMonth String Billing month, e.g. 2019-08
TotalCost String The original cost in USD. This parameter has become valid since v3.0 bills took effect in May 2021, and before that - was returned for this parameter. If a customer uses a contract price different from the published price, - will also be returned for this parameter.

ApplicableProducts

The products that are applicable.

Used by actions: DescribeVoucherInfo.

Name Type Description
GoodsName String Valid values: all products or names of the applicable products (string). Multiple names are separated by commas.
PayMode String Valid values: postPay: pay-as-you-go; prePay: prepaid; riPay: reserved instance; empty or *: all. If GoodsName contains multiple product names and PayMode is *, it indicates that the voucher can be used in all billing modes for each of the products.

BillDetail

Bill details

Used by actions: DescribeBillDetail.

Name Type Description
BusinessCodeName String Product name: major categories of Tencent Cloud services, e.g. CVM and TencentDB for MySQL
ProductCodeName String Sub-product name: sub-categories of Tencent Cloud services, such as CVM-Standard S1
PayModeName String Billing mode
ProjectName String Project: project of a resource
RegionName String Region: region of a resource, e.g. South China (Guangzhou)
ZoneName String Availability zone: availability zone of a resource, e.g. Guangzhou Zone 3
ResourceId String Instance ID
ResourceName String Instance name
ActionTypeName String Transaction type
OrderId String Order ID
BillId String Transaction ID
PayTime Timestamp Payment time
FeeBeginTime Timestamp Service start time
FeeEndTime Timestamp Service end time
ComponentSet Array of BillDetailComponent Component list
PayerUin String Payer's UIN
OwnerUin String User's UIN
OperateUin String Operator's UIN
Tags Array of BillTagInfo Tag information
Note: This field may return null, indicating that no valid values can be obtained.
BusinessCode String Product code
Note: This field may return null, indicating that no valid value can be found.
ProductCode String Subproduct code
Note: This field may return null, indicating that no valid value can be found.
ActionType String Transaction type
Note: This field may return null, indicating that no valid value can be found.
RegionId String
ProjectId Integer Project ID: ID of the project to which the resource belongs

BillDetailComponent

Information about components charged in the bill

Used by actions: DescribeBillDetail.

Name Type Description
ComponentCodeName String Component type: type of a resource component, e.g. memory, disk, etc.
ItemCodeName String Component name: name of a resource component, e.g. TencentDB for MySQL-memory
SinglePrice String Component published price: original price of a resource component with the original granularity
SpecifiedPrice String Specified price of the component
PriceUnit String Price unit
UsedAmount String Component usage
UsedAmountUnit String Component usage unit
TimeSpan String Usage period
TimeUnitName String Time unit
Cost String Original price of the component
Discount String Discount rate
ReduceType String Offer type
RealCost String Total discounted price
VoucherPayAmount String Amount paid in voucher
CashPayAmount String Amount paid in cash
IncentivePayAmount String Amount paid in trial credit
ItemCode String Component type code
Note: this field may return null, indicating that no valid values can be obtained.
ComponentCode String Component code
Note: this field may return null, indicating that no valid values can be obtained.
ContractPrice String Contract price
InstanceType String The special instance (resource pack, reserved instance, savings plan, or spot instance) that is applied to deduction. Valid values:
Note: This field may return null, indicating that no valid value can be obtained.
RiTimeSpan String The usage duration deducted by a reserved instance. The unit of measurement for deduction is the same as that for usage duration.
Note: This field may return null, indicating that no valid value can be obtained.
OriginalCostWithRI String The amount deducted by a reserved instance based on the original component cost.
Note: This field may return null, indicating that no valid value can be obtained.
SPDeductionRate String The discount multiplier that applies to the component based on the remaining commitment of the savings plan.
Note: This field may return null, indicating that no valid value can be obtained.
SPDeduction String The savings plan deduction amount.
Note: This field may return null, indicating that no valid value can be obtained.
OriginalCostWithSP String The amount deducted by a savings plan based on the original component cost.
Note: This field may return null, indicating that no valid value can be obtained.
BlendedDiscount String The blended discount multiplier that combines the official website discount, reserved instance discount, and savings plan discount. If no reserved instance and savings plan discounts are available, the blended discount multiplier equals the discount multiplier.
Note: This field may return null, indicating that no valid value can be obtained.

BillResourceSummary

Information about resources charged in the bill

Used by actions: DescribeBillResourceSummary.

Name Type Description
BusinessCodeName String Product name: major categories of Tencent Cloud services, e.g. CVM and TencentDB for MySQL
ProductCodeName String Subproduct name, which is the subcategory of a Tencent Cloud product, such as CVM-Standard S1. If no subproduct name can be obtained, - is returned.
PayModeName String Billing mode
ProjectName String Project
RegionName String Region
ZoneName String Availability zone
ResourceId String Instance ID
ResourceName String Resource instance namDeduction timee
ActionTypeName String Transaction type
OrderId String Order ID
PayTime Timestamp Payment time
FeeBeginTime Timestamp Service start time
FeeEndTime Timestamp Service end time
ConfigDesc String Configuration description
ExtendField1 String Extension field 1
ExtendField2 String Extension field 2
TotalCost String Cost, in USD
Discount String Discount
If different discounts or contract prices are applied, - will be returned for this parameter.
ReduceType String Offer type
RealTotalCost String Total cost after discount, in USD
VoucherPayAmount String Amount paid in voucher, in USD
CashPayAmount String Amount paid in cash, in USD
IncentivePayAmount String Amount paid in trial credit, in USD
ExtendField3 String Extension field 3
ExtendField4 String Extension field 4
ExtendField5 String Extension field 5
Tags Array of BillTagInfo Tag information
Note: This field may return null, indicating that no valid values can be obtained.
PayerUin String Payer UIN
OwnerUin String Resource owner UIN; '-' is returned if no value is obtained
OperateUin String Operator UIN; '-' is returned if no value is obtained
BusinessCode String Product code
ProductCode String Subproduct code
RegionId Integer
InstanceType String The special instance (resource pack, reserved instance, savings plan, or spot instance) that is applied to deduction. Valid values:

ri=Standard RI

svp=Savings Plan

si=Spot Instances

rp=Resource Pack
OriginalCostWithRI String The amount deducted by a reserved instance based on the original component cost.
SPDeduction String The savings plan deduction amount.
OriginalCostWithSP String The amount deducted by a savings plan based on the original component cost.

BillTagInfo

Bill tag information.

Used by actions: DescribeBillDetail, DescribeBillResourceSummary.

Name Type Description
TagKey String Cost allocation tag key
TagValue String Tag value

BusinessSummaryOverviewItem

Summarize product details by product

Used by actions: DescribeBillSummaryByProduct.

Name Type Description
BusinessCode String Product code
Note: This field may return null, indicating that no valid value can be found.
BusinessCodeName String Product name: major categories of Tencent Cloud services, e.g. CVM and TencentDB for MySQL
RealTotalCost String Actual cost
RealTotalCostRatio String Cost ratio, to two decimal points
CashPayAmount String Cash amount
IncentivePayAmount String Trial credit amount
VoucherPayAmount String Voucher amount
BillMonth String Billing month, e.g. 2019-08
TotalCost String The original cost in USD. This parameter has become valid since v3.0 bills took effect in May 2021, and before that - was returned for this parameter. If a customer uses a contract price different from the published price, - will also be returned for this parameter.
TransferPayAmount String Payment by commission credits

BusinessSummaryTotal

Summarize total cost by product

Used by actions: DescribeBillSummaryByProduct.

Name Type Description
RealTotalCost String Total cost
VoucherPayAmount String Voucher amount
IncentivePayAmount String Trial credit amount
CashPayAmount String Cash amount
TotalCost String The original cost in USD. This parameter has become valid since v3.0 bills took effect in May 2021, and before that - was returned for this parameter. If a customer uses a contract price different from the published price, - will also be returned for this parameter.
TransferPayAmount String Payment by commission credits

ExcludedProducts

The products that are not applicable.

Used by actions: DescribeVoucherInfo.

Name Type Description
GoodsName String The names of non-applicable products.
PayMode String postPay: pay-as-you-go; prePay: prepaid; riPay: reserved instance; empty or *: all.

PayModeSummaryOverviewItem

Detailed summary of purchases by billing mode

Used by actions: DescribeBillSummaryByPayMode.

Name Type Description
PayMode String Billing mode
PayModeName String Billing mode name
RealTotalCost String Actual cost
RealTotalCostRatio String Cost ratio, to two decimal points
Detail Array of ActionSummaryOverviewItem Detailed summary of purchases by transaction type
CashPayAmount String Cash amount
IncentivePayAmount String Trial credit amount
VoucherPayAmount String Voucher amount
TotalCost String The original cost in USD. This parameter has become valid since v3.0 bills took effect in May 2021, and before that - was returned for this parameter. If a customer uses a contract price different from the published price, - will also be returned for this parameter.
TransferPayAmount String Payment by commission credits

ProjectSummaryOverviewItem

Detailed summary of purchases by project

Used by actions: DescribeBillSummaryByProject.

Name Type Description
ProjectId String Project ID
ProjectName String Project name
RealTotalCost String Actual cost
RealTotalCostRatio String Cost ratio, to two decimal points
CashPayAmount String Cash amount
IncentivePayAmount String Trial credit amount
VoucherPayAmount String Voucher amount
BillMonth String Billing month, e.g. 2019-08
TotalCost String The original cost in USD. This parameter has become valid since v3.0 bills took effect in May 2021, and before that - was returned for this parameter. If a customer uses a contract price different from the published price, - will also be returned for this parameter.
TransferPayAmount String Payment by commission credits

RegionSummaryOverviewItem

Detailed summary of purchases by region

Used by actions: DescribeBillSummaryByRegion.

Name Type Description
RegionId String Region ID
Note: This field may return null, indicating that no valid value was found.
RegionName String Region name
RealTotalCost String Actual cost
RealTotalCostRatio String Cost ratio, to two decimal points
CashPayAmount String Cash amount
IncentivePayAmount String Trial credit amount
VoucherPayAmount String Voucher amount
BillMonth String Billing month, e.g. 2019-08
TotalCost String The original cost in USD. This parameter has become valid since v3.0 bills took effect in May 2021, and before that - was returned for this parameter. If a customer uses a contract price different from the published price, - will also be returned for this parameter.
TransferPayAmount String Payment by commission credits

SummaryTotal

Total cost

Used by actions: DescribeBillSummaryByTag.

Name Type Description
RealTotalCost String Total cost
Note: this field may return null, indicating that no valid values can be obtained.
TotalCost String The original cost in USD. This parameter has become valid since v3.0 bills took effect in May 2021, and before that - was returned for this parameter. If a customer uses a contract price different from the published price, - will also be returned for this parameter.
Note: this field may return null, indicating that no valid values can be obtained.

TagSummaryOverviewItem

Details about cost distribution over different tags.

Used by actions: DescribeBillSummaryByTag.

Name Type Description
TagValue String Tag value
Note: This field may return null, indicating that no valid values can be obtained.
RealTotalCost String Actual cost
Note: This field may return null, indicating that no valid values can be obtained.
RealTotalCostRatio String Cost percentage rounded to two decimal places
Note: This field may return null, indicating that no valid values can be obtained.
TotalCost String The original cost in USD. This parameter has become valid since v3.0 bills took effect in May 2021, and before that - was returned for this parameter. If a customer uses a contract price different from the published price, - will also be returned for this parameter.
Note: this field may return null, indicating that no valid values can be obtained.
CashPayAmount String Payment by cash credits
Note: This field may return null, indicating that no valid values can be obtained.
IncentivePayAmount String Payment by free credits
Note: This field may return null, indicating that no valid values can be obtained.
VoucherPayAmount String Payment by vouchers
Note: This field may return null, indicating that no valid values can be obtained.
TransferPayAmount String Payment by commission credits
Note: This field may return null, indicating that no valid values can be obtained.

UsageDetails

The product purchased.

Used by actions: DescribeVoucherUsageDetails.

Name Type Description
ProductName String The name of the product.
Note: This field may return null, indicating that no valid value was found.
SubProductName String

UsageRecords

The usage records.

Used by actions: DescribeVoucherUsageDetails.

Name Type Description
UsedAmount Integer The amount used. The value of this parameter is the amount used (USD, rounded to 8 decimal places) multiplied by 100,000,000.
UsedTime String The time when the voucher was used.
UsageDetails Array of UsageDetails The details of the product purchased.
Note: This field may return null, indicating that no valid value was found.

VoucherInfos

Voucher information.

Used by actions: DescribeVoucherInfo.

Name Type Description
OwnerUin String The owner of the voucher.
Status String The status of the voucher: unUsed, used, delivered, cancel, overdue
NominalValue Integer The value of the voucher. The value of this parameter is the voucher value (USD, rounded to 8 decimal places) multiplied by 100,000,000.
Balance Integer The balance left. The value of this parameter is the balance left (USD, rounded to 8 decimal places) multiplied by 100,000,000.
VoucherId String The voucher ID.
PayMode String postPay: pay-as-you-go; prePay: prepaid; riPay: reserved instance; empty or *: all.
PayScene String If PayMode is postPay, this parameter may be spotpay (spot instance) or settle account (regular pay-as-you-go). If PayMode is prePay, this parameter may be purchase, renew, or modify (downgrade/upgrade). If PayMode is riPay, this parameter may be oneOffFee (prepayment of reserved instance) or hourlyFee (hourly billing of reserved instance). * means to query vouchers that support all billing scenarios.
BeginTime String The start time of the validity period.
EndTime String The end time of the validity period.
ApplicableProducts ApplicableProducts The products that are applicable.
Note: This field may return null, indicating that no valid value was found.
ExcludedProducts Array of ExcludedProducts The products that are not applicable.
Note: This field may return null, indicating that no valid value was found.
联系我们

联系我们,为您的业务提供专属服务。

技术支持

如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

7x24 电话支持