{ "name": "billing", "display_name": "费用中心", "description": "## 概述 计费相关API是支撑业务计费全流程的核心接口集合，旨在为用户提供标准化、高可用的计费能力接入方案。通过调用对应API，用户可快速实现账户查询、支付订单、账单明细查询、账单消耗详情等核心计费场景功能。 本章节介绍的计费相关 API 接口均为API 3.0接口。 您可以调用 API 对计费相关接口进行操作，例如获取账户余额、支付订单、获取账单明细数据等。 计费相\ufffd\ufffd...", "domain": "monitor", "api_version": "2018-07-09", "endpoint": "billing.tencentcloudapi.com", "actions": [ { "name": "CreateAllocationRule", "description": "创建公摊规则", "status": "online", "parameters": [ { "name": "RuleList", "type": "object", "required": true, "description": "公摊规则列表", "example": "无", "children": [ { "name": "Name", "type": "string", "required": true, "description": "新增公摊规则名称", "example": "公摊规则" }, { "name": "Type", "type": "integer", "required": true, "description": "公摊策略类型，枚举值如下： 1 - 自定义分摊占比 2 - 等比分摊 3 - 按占比分摊", "example": "1" }, { "name": "RuleDetail", "type": "object", "required": true, "description": "公摊规则表达式", "example": "无", "children": [ { "name": "RuleKey", "type": "string", "required": false, "description": "RuleKey：分账维度 枚举值： ownerUin - 使用者UIN, operateUin - 操作者UIN, businessCode - 产品一层编码, productCode - 产品二层编码, itemCode - 产品四层编码, projectId - 项目ID, regionId - 地域ID, resourceId - 资源ID, tag - 标签键值对, payMode - 计费模式, instanceType - 实例类型, actionType - 交易类型", "example": "businessCode" }, { "name": "Operator", "type": "string", "required": false, "description": "分账维度规则 枚举值： in - 是 not in - 不是", "example": "=" }, { "name": "RuleValue", "type": "array", "required": false, "description": "分账维度值，例如当RuleKey为businessCode时，[\"p_cbs\",\"p_sqlserver\"]表示产品一层是\"p_cbs\",\"p_sqlserver\"的费用", "example": "[\"p_cbs\",\"p_sqlserver\"]", "item_type": "string" }, { "name": "Connectors", "type": "string", "required": false, "description": "分账逻辑连接词，枚举值如下： and - 且 or - 或", "example": "and" }, { "name": "Children", "type": "array", "required": false, "description": "嵌套规则", "example": "无", "item_type": "object", "children": [ { "name": "RuleKey", "type": "string", "required": false, "description": "RuleKey：分账维度 枚举值： ownerUin - 使用者UIN, operateUin - 操作者UIN, businessCode - 产品一层编码, productCode - 产品二层编码, itemCode - 产品四层编码, projectId - 项目ID, regionId - 地域ID, resourceId - 资源ID, tag - 标签键值对, payMode - 计费模式, instanceType - 实例类型, actionType - 交易类型", "example": "businessCode" }, { "name": "Operator", "type": "string", "required": false, "description": "分账维度规则 枚举值： in - 是 not in - 不是", "example": "=" }, { "name": "RuleValue", "type": "array", "required": false, "description": "分账维度值，例如当RuleKey为businessCode时，[\"p_cbs\",\"p_sqlserver\"]表示产品一层是\"p_cbs\",\"p_sqlserver\"的费用", "example": "[\"p_cbs\",\"p_sqlserver\"]", "item_type": "string" }, { "name": "Connectors", "type": "string", "required": false, "description": "分账逻辑连接词，枚举值如下： and - 且 or - 或", "example": "and" }, { "name": "Children", "type": "array", "required": false, "description": "嵌套规则", "example": "无", "item_type": "string" } ] } ] }, { "name": "RatioDetail", "type": "array", "required": false, "description": "公摊比例表达式，按占比分摊不传", "example": "无", "item_type": "object", "children": [ { "name": "NodeId", "type": "integer", "required": true, "description": "公摊规则所属分账单元ID", "example": "11" }, { "name": "Ratio", "type": "float", "required": true, "description": "分账单元所占公摊比例，按占比分摊传0", "example": "40.51" } ] } ] }, { "name": "Month", "type": "string", "required": false, "description": "月份，不传默认当前月", "example": "2022-10-01 00:00:00" } ], "required": [ "RuleList" ] }, { "name": "CreateAllocationTag", "description": "批量设置分账标签", "status": "online", "parameters": [ { "name": "TagKey", "type": "array", "required": true, "description": "用户分账标签键", "example": "testTag", "item_type": "string" } ], "required": [ "TagKey" ] }, { "name": "CreateAllocationUnit", "description": "创建分账单元", "status": "online", "parameters": [ { "name": "ParentId", "type": "integer", "required": true, "description": "新增分账单元父节点ID", "example": "1" }, { "name": "Name", "type": "string", "required": false, "description": "新增分账单元名称", "example": "财务部" }, { "name": "Month", "type": "string", "required": false, "description": "月份，不传默认当前月", "example": "2022-10-01 00:00:00" } ], "required": [ "ParentId" ] }, { "name": "CreateBudget", "description": "创建预算信息", "status": "online", "parameters": [ { "name": "BudgetName", "type": "string", "required": true, "description": "预算名称", "example": "API创建预算计划" }, { "name": "CycleType", "type": "string", "required": true, "description": "DAY 天，MONTH 月度，QUARTER 季度 ，YEAR 年度", "example": "DAY" }, { "name": "PeriodBegin", "type": "string", "required": true, "description": "有效期起始时间 2025-01-01(周期: 天) / 2025-01（周期: 月）", "example": "2025-01-01" }, { "name": "PeriodEnd", "type": "string", "required": true, "description": "有效期结束时间 2025-12-01(周期：天) / 2025-12（周期：月）", "example": "2025-12-01" }, { "name": "PlanType", "type": "string", "required": true, "description": "FIX 固定预算，CYCLE 计划预算", "example": "FIX" }, { "name": "BudgetQuota", "type": "string", "required": true, "description": "预算值额度 预算计划类型为FIX(固定预算)时传定值； 预算计划类型为CYCLE(计划预算)时传[{\"dateDesc\":\"2025-07\",\"quota\":\"1000\"},{\"dateDesc\":\"2025-08\",\"quota\":\"2000\"}]；", "example": "1000" }, { "name": "BillType", "type": "string", "required": true, "description": "BILL 系统账单，CONSUMPTION 消耗账单", "example": "BILL" }, { "name": "FeeType", "type": "string", "required": true, "description": "COST 原价，REAL_COST 实际费用，CASH 现金，INCENTIVE 赠送金，VOUCHER 代金券，TRANSFER 分成金，TAX 税，AMOUNT_BEFORE_TAX 现金支付(税前)", "example": "COST" }, { "name": "WarnJson", "type": "array", "required": true, "description": "阈值提醒", "example": "无", "item_type": "object", "children": [ { "name": "WarnType", "type": "string", "required": true, "description": "ACTUAL 实际金额， FORECAST 预测金额", "example": "ACTUAL" }, { "name": "CalType", "type": "string", "required": true, "description": "PERCENTAGE 预算金额的百分比，ABS 固定值", "example": "PERCENTAGE" }, { "name": "ThresholdValue", "type": "string", "required": true, "description": "阈值（大于等于0）", "example": "100" } ] }, { "name": "BudgetNote", "type": "string", "required": false, "description": "预算备注", "example": "使用api创建预算信息" }, { "name": "DimensionsRange", "type": "object", "required": false, "description": "预算维度范围条件", "example": "无", "children": [ { "name": "Business", "type": "array", "required": false, "description": "产品 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"p_cvm\"]", "item_type": "string" }, { "name": "PayMode", "type": "array", "required": false, "description": "计费模式 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"postPay\"]", "item_type": "string" }, { "name": "ProductCodes", "type": "array", "required": false, "description": "子产品 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"sp_cvm\"]", "item_type": "string" }, { "name": "ComponentCodes", "type": "array", "required": false, "description": "组件编码 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"v_cpu\"]", "item_type": "string" }, { "name": "ZoneIds", "type": "array", "required": false, "description": "地域 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"10001\"]", "item_type": "string" }, { "name": "RegionIds", "type": "array", "required": false, "description": "可用区 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"47\"]", "item_type": "string" }, { "name": "ProjectIds", "type": "array", "required": false, "description": "项目 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"0\"]", "item_type": "string" }, { "name": "ActionTypes", "type": "array", "required": false, "description": "交易类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"postpay_deduct_d\"]", "item_type": "string" }, { "name": "ConsumptionTypes", "type": "array", "required": false, "description": "消耗类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"prepay_purchase\"]", "item_type": "string" }, { "name": "Tags", "type": "array", "required": false, "description": "标签 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "key 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TagValue", "type": "array", "required": false, "description": "value 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "PayerUins", "type": "array", "required": false, "description": "末级分账单元 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"1197623846\"]", "item_type": "string" }, { "name": "OwnerUins", "type": "array", "required": false, "description": "主用户Uin 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"1197623846\"]", "item_type": "string" }, { "name": "TreeNodeUniqKeys", "type": "array", "required": false, "description": "末级分账单元唯一键 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"1197623846\"]", "item_type": "string" } ] }, { "name": "WaveThresholdJson", "type": "array", "required": false, "description": "波动提醒", "example": "无", "item_type": "object", "children": [ { "name": "WarnType", "type": "string", "required": false, "description": "ACTUAL 实际金额，FORECAST 预测金额 注意：此字段可能返回 null，表示取不到有效值。", "example": "ACTUAL" }, { "name": "Threshold", "type": "string", "required": false, "description": "波动阈值（大于等于0） 注意：此字段可能返回 null，表示取不到有效值。", "example": "100" }, { "name": "MetaType", "type": "string", "required": false, "description": "告警类型：chain 环比，yoy 同比，fix 固定值 （支持类型：日环比 chain day，日同比周维度 chain weekday，日同比月维度 yoy day，日固定值 fix day，月环比 chain month，月固定值 fix month） 注意：此字段可能返回 null，表示取不到有效值。", "example": "chain" }, { "name": "PeriodType", "type": "string", "required": false, "description": "告警维度：day 日，month 月，weekday 周 （支持类型：日环比 chain day，日同比周维度 chain weekday，日同比月维度 yoy day，日固定值 fix day，月环比 chain month，月固定值 fix month） 注意：此字段可能返回 null，表示取不到有效值。", "example": "day" } ] } ], "required": [ "BudgetName", "CycleType", "PeriodBegin", "PeriodEnd", "PlanType", "BudgetQuota", "BillType", "FeeType", "WarnJson" ] }, { "name": "CreateGatherRule", "description": "创建归集规则", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "规则所属分账单元ID", "example": "12" }, { "name": "RuleList", "type": "object", "required": true, "description": "归集规则详情", "example": "无", "children": [ { "name": "RuleDetail", "type": "object", "required": true, "description": "分账规则表达式", "example": "无", "children": [ { "name": "RuleKey", "type": "string", "required": false, "description": "RuleKey：分账维度 枚举值： ownerUin - 使用者UIN, operateUin - 操作者UIN, businessCode - 产品一层编码, productCode - 产品二层编码, itemCode - 产品四层编码, projectId - 项目ID, regionId - 地域ID, resourceId - 资源ID, tag - 标签键值对, payMode - 计费模式, instanceType - 实例类型, actionType - 交易类型", "example": "businessCode" }, { "name": "Operator", "type": "string", "required": false, "description": "分账维度规则 枚举值： in - 是 not in - 不是", "example": "=" }, { "name": "RuleValue", "type": "array", "required": false, "description": "分账维度值，例如当RuleKey为businessCode时，[\"p_cbs\",\"p_sqlserver\"]表示产品一层是\"p_cbs\",\"p_sqlserver\"的费用", "example": "[\"p_cbs\",\"p_sqlserver\"]", "item_type": "string" }, { "name": "Connectors", "type": "string", "required": false, "description": "分账逻辑连接词，枚举值如下： and - 且 or - 或", "example": "and" }, { "name": "Children", "type": "array", "required": false, "description": "嵌套规则", "example": "无", "item_type": "object", "children": [ { "name": "RuleKey", "type": "string", "required": false, "description": "RuleKey：分账维度 枚举值： ownerUin - 使用者UIN, operateUin - 操作者UIN, businessCode - 产品一层编码, productCode - 产品二层编码, itemCode - 产品四层编码, projectId - 项目ID, regionId - 地域ID, resourceId - 资源ID, tag - 标签键值对, payMode - 计费模式, instanceType - 实例类型, actionType - 交易类型", "example": "businessCode" }, { "name": "Operator", "type": "string", "required": false, "description": "分账维度规则 枚举值： in - 是 not in - 不是", "example": "=" }, { "name": "RuleValue", "type": "array", "required": false, "description": "分账维度值，例如当RuleKey为businessCode时，[\"p_cbs\",\"p_sqlserver\"]表示产品一层是\"p_cbs\",\"p_sqlserver\"的费用", "example": "[\"p_cbs\",\"p_sqlserver\"]", "item_type": "string" }, { "name": "Connectors", "type": "string", "required": false, "description": "分账逻辑连接词，枚举值如下： and - 且 or - 或", "example": "and" }, { "name": "Children", "type": "array", "required": false, "description": "嵌套规则", "example": "无", "item_type": "string" } ] } ] } ] }, { "name": "Month", "type": "string", "required": false, "description": "月份，不传默认当前月", "example": "2022-10-01 00:00:00" } ], "required": [ "Id", "RuleList" ] }, { "name": "CreateInstance", "description": "创建一个实例资源，会创建一个新购实例资源的订单，并通过腾讯云账户余额自动支付。调用该接口的账号需要授予finace:trade的权限，否则无法支付成功。目前已接入并支持购买的产品包括：T-Sec-Web应用防火墙、云防火墙、主机安全、主机容器、云安全中心、T-Sec-密钥管理系统。", "status": "online", "parameters": [ { "name": "ClientToken", "type": "string", "required": true, "description": "ClientToken是一个由客户端生成的唯一的、区分大小写、不超过64个ASCII字符的字符串。例如，ClientToken=123e4567-e89b-12d3-a456-42665544****。", "example": "c015c8ce-3698-4cd2-865b-7959fe15a705" }, { "name": "ProductCode", "type": "string", "required": true, "description": "产品一层code", "example": "p_yunjing" }, { "name": "SubProductCode", "type": "string", "required": true, "description": "产品二层code", "example": "sp_yunjing_vas" }, { "name": "RegionCode", "type": "string", "required": true, "description": "地域code", "example": "ap-guangzhou" }, { "name": "ZoneCode", "type": "string", "required": true, "description": "可用区code", "example": "ap-guangzhou-1" }, { "name": "PayMode", "type": "string", "required": true, "description": "付费类型，取值： PrePay：预付费", "example": "PrePay" }, { "name": "Parameter", "type": "string", "required": true, "description": "商品详情信息", "example": "{\"pid\":1005305,\"productCode\":\"p_yunjing\",\"subProductCode\":\"sp_yunjing_vas\",\"sv_yunjing_vas_la\":\"50\",\"timeSpan\":1,\"timeUnit\":\"m\"}" }, { "name": "Quantity", "type": "integer", "required": false, "description": "商品数量，默认取值1", "example": "1" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目id，默认取0", "example": "1" }, { "name": "Period", "type": "integer", "required": false, "description": "新购时长，取值上限：36，默认取值1", "example": "1" }, { "name": "PeriodUnit", "type": "string", "required": false, "description": "新购时长单位，取值：m：按月购买，y：按年购买，默认取值m", "example": "m" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识，取值：NOTIFY_AND_MANUAL_RENEW：手动续费，NOTIFY_AND_AUTO_RENEW：自动续费，DISABLE_NOTIFY_AND_MANUAL_RENEW：到期不续，默认取值NOTIFY_AND_MANUAL_RENEW", "example": "NOTIFY_AND_MANUAL_RENEW" } ], "required": [ "ClientToken", "ProductCode", "SubProductCode", "RegionCode", "ZoneCode", "PayMode", "Parameter" ] }, { "name": "DeleteAllocationRule", "description": "公摊规则删除接口", "status": "online", "parameters": [ { "name": "RuleId", "type": "integer", "required": true, "description": "所删除公摊规则ID", "example": "12" }, { "name": "Month", "type": "string", "required": false, "description": "月份，不传默认当前月", "example": "月份，默认当前月" } ], "required": [ "RuleId" ] }, { "name": "DeleteAllocationTag", "description": "批量取消设置分账标签", "status": "online", "parameters": [ { "name": "TagKey", "type": "array", "required": true, "description": "用户分账标签键", "example": "运营部门", "item_type": "string" } ], "required": [ "TagKey" ] }, { "name": "DeleteAllocationUnit", "description": "删除分账单元", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "所删除分账单元ID", "example": "1" }, { "name": "Month", "type": "string", "required": false, "description": "月份，不传默认当前月", "example": "2022-10-01 00:00:00" } ], "required": [ "Id" ] }, { "name": "DeleteBudget", "description": "依据预算ID删除对应预算项目", "status": "online", "parameters": [ { "name": "BudgetIds", "type": "array", "required": true, "description": "预算项目id", "example": "[\"1\"]", "item_type": "string" } ], "required": [ "BudgetIds" ] }, { "name": "DeleteGatherRule", "description": "删除归集规则", "status": "online", "parameters": [ { "name": "RuleId", "type": "integer", "required": true, "description": "所删除归集规则ID", "example": "13" }, { "name": "Month", "type": "string", "required": false, "description": "月份，不传默认当前月", "example": "2022-10-01 00:00:00" } ], "required": [ "RuleId" ] }, { "name": "DescribeAccountBalance", "description": "获取云账户余额信息。", "status": "online", "parameters": [ { "name": "TempCredit", "type": "boolean", "required": false, "description": "是否查询临时额度", "example": "true" } ], "required": [] }, { "name": "DescribeAllocateConditions", "description": "查询资源目录筛选条件", "status": "online", "parameters": [ { "name": "Month", "type": "string", "required": false, "description": "账单月份，格式为2024-02，不传默认当前月", "example": "2024-02" } ], "required": [] }, { "name": "DescribeAllocationBillConditions", "description": "查询分账账单筛选条件", "status": "online", "parameters": [ { "name": "Month", "type": "string", "required": false, "description": "账单月份，格式为2024-02，不传默认当前月", "example": "2024-02" }, { "name": "TreeNodeUniqKeys", "type": "array", "required": false, "description": "分账单元唯一标识，用作筛选", "example": "909619400-hdngsfxtoqlh", "item_type": "string" }, { "name": "BillDates", "type": "array", "required": false, "description": "日期", "example": "[\"2022-10-01\"]", "item_type": "string" }, { "name": "BusinessCodes", "type": "array", "required": false, "description": "产品编码", "example": "[\"p_cvm\"]", "item_type": "string" }, { "name": "OwnerUins", "type": "array", "required": false, "description": "使用者UIN", "example": "[\"909619400\"]", "item_type": "string" }, { "name": "OperateUins", "type": "array", "required": false, "description": "操作者UIN", "example": "[\"909619400\"]", "item_type": "string" }, { "name": "PayModes", "type": "array", "required": false, "description": "计费模式编码", "example": "[\"postPay\"]", "item_type": "string" }, { "name": "ActionTypes", "type": "array", "required": false, "description": "交易类型编码", "example": "[\"prepay_renew\"]", "item_type": "string" }, { "name": "ProductCodes", "type": "array", "required": false, "description": "子产品编码", "example": "[\"sp_cvm_c4\"]", "item_type": "string" }, { "name": "RegionIds", "type": "array", "required": false, "description": "地域ID", "example": "[0,1]", "item_type": "string" }, { "name": "ZoneIds", "type": "array", "required": false, "description": "可用区ID", "example": "[100002,100003]", "item_type": "string" }, { "name": "InstanceTypes", "type": "array", "required": false, "description": "实例类型编码", "example": "[\"ri\"]", "item_type": "string" }, { "name": "Tag", "type": "array", "required": false, "description": "标签", "example": "[\"tagKey:tagValue\"]", "item_type": "string" }, { "name": "ComponentCodes", "type": "array", "required": false, "description": "组件类型编码", "example": "[\"virtual_v_cvm_compute\"]", "item_type": "string" }, { "name": "ItemCodes", "type": "array", "required": false, "description": "组件名称编码", "example": "[\"virtual_v_cvm_compute_c4\"]", "item_type": "string" }, { "name": "SearchKey", "type": "string", "required": false, "description": "模糊搜索条件", "example": "ins-yhtdg16" }, { "name": "ProjectIds", "type": "array", "required": false, "description": "项目id", "example": "[0]", "item_type": "integer" }, { "name": "AllocationType", "type": "array", "required": false, "description": "费用归集类型", "example": "[0,1]", "item_type": "integer" } ], "required": [] }, { "name": "DescribeAllocationBillDetail", "description": "查询分账账单明细", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "数量，最大值为1000", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页偏移量，Offset=0表示第一页，如果Limit=100，则Offset=100表示第二页，Offset=200表示第三页，以此类推", "example": "0" }, { "name": "Month", "type": "string", "required": false, "description": "账单月份，格式为2024-02，不传默认当前月", "example": "2024-02" }, { "name": "TreeNodeUniqKeys", "type": "array", "required": false, "description": "分账单元唯一标识，用作筛选", "example": "1000***-***", "item_type": "string" }, { "name": "Sort", "type": "string", "required": false, "description": "排序字段，枚举值如下： RiTimeSpan - 预留实例抵扣时长 ExtendPayAmount1 - 预留实例抵扣组件原价 RealCost - 折后总价 CashPayAmount - 现金金额 VoucherPayAmount - 代金券金额 IncentivePayAmount - 赠送金金额 TransferPayAmount -分成金金额 Cost - 组件原价", "example": "realCost" }, { "name": "SortType", "type": "string", "required": false, "description": "排序类型，枚举值如下： asc - 升序 desc - 降序", "example": "asc" }, { "name": "BusinessCodes", "type": "array", "required": false, "description": "产品编码，用作筛选", "example": "p_cvm", "item_type": "string" }, { "name": "OwnerUins", "type": "array", "required": false, "description": "使用者UIN，用作筛选", "example": "909619400", "item_type": "string" }, { "name": "OperateUins", "type": "array", "required": false, "description": "操作者UIN，用作筛选", "example": "909619400", "item_type": "string" }, { "name": "PayModes", "type": "array", "required": false, "description": "计费模式编码，用作筛选", "example": "postPay", "item_type": "string" }, { "name": "ActionTypes", "type": "array", "required": false, "description": "交易类型编码，用作筛选", "example": "prepay_renew", "item_type": "string" }, { "name": "ProductCodes", "type": "array", "required": false, "description": "子产品编码，用作筛选", "example": "sp_cvm_c4", "item_type": "string" }, { "name": "RegionIds", "type": "array", "required": false, "description": "地域ID，用作筛选", "example": "0", "item_type": "string" }, { "name": "ZoneIds", "type": "array", "required": false, "description": "可用区ID，用作筛选", "example": "0", "item_type": "string" }, { "name": "InstanceTypes", "type": "array", "required": false, "description": "实例类型编码，用作筛选", "example": "ri", "item_type": "string" }, { "name": "Tag", "type": "array", "required": false, "description": "标签，用作筛选", "example": "tagKey:tagValue", "item_type": "string" }, { "name": "ComponentCodes", "type": "array", "required": false, "description": "组件类型编码，用作筛选", "example": "virtual_v_cvm_compute", "item_type": "string" }, { "name": "ItemCodes", "type": "array", "required": false, "description": "组件名称编码，用作筛选", "example": "sv_cvm", "item_type": "string" }, { "name": "SearchKey", "type": "string", "required": false, "description": "模糊搜索：支持标签、资源id、资源别名", "example": "CVM" }, { "name": "ProjectIds", "type": "array", "required": false, "description": "项目ID，用作筛选", "example": "0", "item_type": "integer" } ], "required": [ "Limit", "Offset" ] }, { "name": "DescribeAllocationMonthOverview", "description": "查询分账账单月概览", "status": "online", "parameters": [ { "name": "Month", "type": "string", "required": false, "description": "账单月份，格式为2024-02，不传默认当前月", "example": "2024-02" } ], "required": [] }, { "name": "DescribeAllocationOverview", "description": "查询分账账单日概览", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "数量，最大值为1000", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页偏移量，Offset=0表示第一页，如果Limit=100，则Offset=100表示第二页，Offset=200表示第三页，以此类推", "example": "0" }, { "name": "Month", "type": "string", "required": false, "description": "账单月份，格式为2024-02，不传默认当前月", "example": "2024-02" }, { "name": "PeriodType", "type": "string", "required": false, "description": "统计周期，枚举值如下 month - 月 day - 日", "example": "month" }, { "name": "TreeNodeUniqKeys", "type": "array", "required": false, "description": "分账单元唯一标识，用作筛选", "example": "1909619400-674414f2a3dad", "item_type": "string" }, { "name": "Sort", "type": "string", "required": false, "description": "排序字段，枚举值如下： GatherCashPayAmount - 归集费用(现金) GatherVoucherPayAmount- 归集费用(优惠券) GatherIncentivePayAmount - 归集费用(赠送金) GatherTransferPayAmount - 归集费用(分成金) AllocateCashPayAmount - 分摊费用(现金) AllocateVoucherPayAmount - 分摊费用(优惠券) AllocateIncentivePayAmount - 分摊费用(赠送金) AllocateTransferPayAmount - 分摊费用(分成金) TotalCashPayAmount - 合计费用(现金) TotalVoucherPayAmount - 合计\ufffd...", "example": "realCost" }, { "name": "SortType", "type": "string", "required": false, "description": "排序类型，枚举值如下： asc - 升序 desc - 降序", "example": "asc" }, { "name": "BillDates", "type": "array", "required": false, "description": "日期，用作筛选", "example": "2022-10", "item_type": "string" } ], "required": [ "Limit", "Offset" ] }, { "name": "DescribeAllocationRuleDetail", "description": "查询公摊规则详情", "status": "online", "parameters": [ { "name": "RuleId", "type": "integer", "required": true, "description": "所查询公摊规则ID", "example": "12" }, { "name": "Month", "type": "string", "required": false, "description": "月份，不传默认当前月", "example": "2022-10-01 00:00:00" } ], "required": [ "RuleId" ] }, { "name": "DescribeAllocationRuleSummary", "description": "查询所有公摊规则概览", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "每次获取数据量，最大值1000", "example": "5" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页偏移量", "example": "2" }, { "name": "Month", "type": "string", "required": false, "description": "月份，不传默认当前月", "example": "2022-10-01 00:00:00" }, { "name": "Type", "type": "integer", "required": false, "description": "公摊策略类型，用于筛选。 枚举值如下： 1 - 自定义分摊占比 2 - 等比分摊 3 - 按占比分摊", "example": "1" }, { "name": "Name", "type": "string", "required": false, "description": "公摊规则名称或分账单元名称，用于模糊筛选。", "example": "产品部" } ], "required": [ "Limit", "Offset" ] }, { "name": "DescribeAllocationSummaryByBusiness", "description": "查询分账账单按产品汇总", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "数量，最大值为1000", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页偏移量，Offset=0表示第一页，如果Limit=100，则Offset=100表示第二页，Offset=200表示第三页，以此类推", "example": "0" }, { "name": "Month", "type": "string", "required": false, "description": "账单月份，格式为2024-02，不传默认当前月", "example": "2024-02" }, { "name": "PeriodType", "type": "string", "required": false, "description": "统计周期，枚举值如下 month - 月 day - 日", "example": "month" }, { "name": "TreeNodeUniqKeys", "type": "array", "required": false, "description": "分账单元唯一标识，用作筛选", "example": "909619400-670615a8c8b23", "item_type": "string" }, { "name": "SortType", "type": "string", "required": false, "description": "排序类型，枚举值如下： asc - 升序 desc - 降序", "example": "asc" }, { "name": "Sort", "type": "string", "required": false, "description": "排序字段，枚举值如下： GatherCashPayAmount - 归集费用(现金) GatherVoucherPayAmount- 归集费用(优惠券) GatherIncentivePayAmount - 归集费用(赠送金) GatherTransferPayAmount - 归集费用(分成金) AllocateCashPayAmount - 分摊费用(现金) AllocateVoucherPayAmount - 分摊费用(优惠券) AllocateIncentivePayAmount - 分摊费用(赠送金) AllocateTransferPayAmount - 分摊费用(分成金) TotalCashPayAmount - 合计费用(现金) TotalVoucherPayAmount - 合计\ufffd...", "example": "realCost" }, { "name": "BillDates", "type": "array", "required": false, "description": "日期，用作筛选，PeriodType=day时可传", "example": "2022-10", "item_type": "string" }, { "name": "BusinessCodes", "type": "array", "required": false, "description": "产品编码，用作筛选", "example": "p_cvm", "item_type": "string" } ], "required": [ "Limit", "Offset" ] }, { "name": "DescribeAllocationSummaryByItem", "description": "查询分账账单按组件汇总", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "数量，最大值为1000", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页偏移量，Offset=0表示第一页，如果Limit=100，则Offset=100表示第二页，Offset=200表示第三页，以此类推", "example": "0" }, { "name": "Month", "type": "string", "required": false, "description": "账单月份，格式为2024-02，不传默认当前月", "example": "2024-02" }, { "name": "PeriodType", "type": "string", "required": false, "description": "统计周期，枚举值如下 month - 月 day - 日", "example": "month" }, { "name": "TreeNodeUniqKeys", "type": "array", "required": false, "description": "分账单元唯一标识，用作筛选", "example": "909619400-65b9a02cd832f", "item_type": "string" }, { "name": "Sort", "type": "string", "required": false, "description": "排序字段，枚举值如下： RiTimeSpan - 预留实例抵扣时长 ExtendPayAmount1 - 预留实例抵扣组件原价 RealCost - 折后总价 CashPayAmount - 现金金额 VoucherPayAmount - 代金券金额 IncentivePayAmount - 赠送金金额 TransferPayAmount -分成金金额 Cost - 组件原价", "example": "realCost" }, { "name": "SortType", "type": "string", "required": false, "description": "排序类型，枚举值如下： asc - 升序 desc - 降序", "example": "asc" }, { "name": "BillDates", "type": "array", "required": false, "description": "日期，用作筛选", "example": " [\"2024-11-25\", \"2024-11-24\"]", "item_type": "string" }, { "name": "BusinessCodes", "type": "array", "required": false, "description": "产品编码，用作筛选", "example": "[\"p_cos\"]", "item_type": "string" }, { "name": "OwnerUins", "type": "array", "required": false, "description": "使用者UIN，用作筛选", "example": " [\"909619400\", \"100001053999\"]", "item_type": "string" }, { "name": "OperateUins", "type": "array", "required": false, "description": "操作者UIN，用作筛选", "example": " [\"909619400\", \"100001053999\"]", "item_type": "string" }, { "name": "PayModes", "type": "array", "required": false, "description": "计费模式编码，用作筛选", "example": " [\"prePay\", \"postPay\"]", "item_type": "string" }, { "name": "ActionTypes", "type": "array", "required": false, "description": "交易类型编码，用作筛选", "example": "[\"postpay_deduct_d\"]", "item_type": "string" }, { "name": "ProductCodes", "type": "array", "required": false, "description": "子产品编码，用作筛选", "example": " [\"sp_cos_std\"]", "item_type": "string" }, { "name": "RegionIds", "type": "array", "required": false, "description": "地域ID，用作筛选", "example": " [1, 4]", "item_type": "string" }, { "name": "ZoneIds", "type": "array", "required": false, "description": "可用区ID，用作筛选", "example": "[200001, 100003]", "item_type": "string" }, { "name": "InstanceTypes", "type": "array", "required": false, "description": "实例类型编码，用作筛选", "example": "[\"ri\", \"svp\"]", "item_type": "string" }, { "name": "Tag", "type": "array", "required": false, "description": "标签，用作筛选", "example": "tagKey:tagValue", "item_type": "string" }, { "name": "ComponentCodes", "type": "array", "required": false, "description": "组件类型编码，用作筛选", "example": "[\"virtual_v_cvm_compute\"]", "item_type": "string" }, { "name": "ItemCodes", "type": "array", "required": false, "description": "组件名称编码，用作筛选", "example": "[\"virtual_v_cvm_compute_c4\"]", "item_type": "string" }, { "name": "SearchKey", "type": "string", "required": false, "description": "模糊搜索：支持标签、资源id、资源别名", "example": "4cdntest-10006792" }, { "name": "ProjectIds", "type": "array", "required": false, "description": "项目ID，用作筛选", "example": "[0,1]", "item_type": "integer" }, { "name": "AllocationType", "type": "array", "required": false, "description": "费用归集类型，枚举值如下： 0 - 分摊 1 - 归集 -1 - 未分配", "example": "[0,1]", "item_type": "integer" } ], "required": [ "Limit", "Offset" ] }, { "name": "DescribeAllocationSummaryByResource", "description": "查询分账账单按资源汇总", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "数量，最大值为1000", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页偏移量，Offset=0表示第一页，如果Limit=100，则Offset=100表示第二页，Offset=200表示第三页，以此类推", "example": "0" }, { "name": "Month", "type": "string", "required": false, "description": "账单月份，格式为2024-02，不传默认当前月", "example": "2024-02" }, { "name": "PeriodType", "type": "string", "required": false, "description": "统计周期，枚举值如下 month - 月 day - 日", "example": "month" }, { "name": "TreeNodeUniqKeys", "type": "array", "required": false, "description": "分账单元唯一标识，用作筛选", "example": "909619400-65b9a02cd832f", "item_type": "string" }, { "name": "Sort", "type": "string", "required": false, "description": "排序字段，枚举值如下： RiTimeSpan - 预留实例抵扣时长 ExtendPayAmount1 - 预留实例抵扣组件原价 RealCost - 折后总价 CashPayAmount - 现金金额 VoucherPayAmount - 代金券金额 IncentivePayAmount - 赠送金金额 TransferPayAmount -分成金金额 Cost - 组件原价", "example": "realCost" }, { "name": "SortType", "type": "string", "required": false, "description": "排序类型，枚举值如下： asc - 升序 desc - 降序", "example": "asc" }, { "name": "BillDates", "type": "array", "required": false, "description": "日期，用作筛选", "example": "[\"2024-11-01\",\"2024-11-02\"]", "item_type": "string" }, { "name": "BusinessCodes", "type": "array", "required": false, "description": "产品编码，用作筛选", "example": "[\"p_cvm\"]", "item_type": "string" }, { "name": "OwnerUins", "type": "array", "required": false, "description": "使用者UIN，用作筛选", "example": "[\"sp_cos_std\"]", "item_type": "string" }, { "name": "OperateUins", "type": "array", "required": false, "description": "操作者UIN，用作筛选", "example": "[\"909619400\"]", "item_type": "string" }, { "name": "PayModes", "type": "array", "required": false, "description": "计费模式编码，用作筛选", "example": "[\"postPay\"]", "item_type": "string" }, { "name": "ActionTypes", "type": "array", "required": false, "description": "交易类型编码，用作筛选", "example": "[\"prepay_purchase\"]", "item_type": "string" }, { "name": "ProductCodes", "type": "array", "required": false, "description": "子产品编码，用作筛选", "example": "[\"sp_cdn_ov\"]", "item_type": "string" }, { "name": "RegionIds", "type": "array", "required": false, "description": "地域ID，用作筛选", "example": "[0,1]", "item_type": "string" }, { "name": "ZoneIds", "type": "array", "required": false, "description": "可用区ID，用作筛选", "example": "[10001,10002]", "item_type": "string" }, { "name": "InstanceTypes", "type": "array", "required": false, "description": "实例类型编码，用作筛选", "example": "[\"ri\"]", "item_type": "string" }, { "name": "Tag", "type": "array", "required": false, "description": "标签，用作筛选", "example": "tagKey:tagValue", "item_type": "string" }, { "name": "SearchKey", "type": "string", "required": false, "description": "模糊搜索：支持标签、资源id、资源别名", "example": "nugcbucket-1000027" }, { "name": "ProjectIds", "type": "array", "required": false, "description": "项目ID，用作筛选", "example": "[0,100002]", "item_type": "integer" }, { "name": "AllocationType", "type": "array", "required": false, "description": "费用归集类型，枚举值如下： 0 - 分摊 1 - 归集 -1 - 未分配", "example": "[0,1]", "item_type": "integer" } ], "required": [ "Limit", "Offset" ] }, { "name": "DescribeAllocationTree", "description": "查询分账目录树", "status": "online", "parameters": [ { "name": "Month", "type": "string", "required": false, "description": "月份，不传默认当前月", "example": "2022-10-01 00:00:00" } ], "required": [] }, { "name": "DescribeAllocationTrendByMonth", "description": "查询分账账单费用趋势", "status": "online", "parameters": [ { "name": "Month", "type": "string", "required": true, "description": "账单月份，格式为2024-02，不传默认当前月", "example": "2024-02" }, { "name": "TreeNodeUniqKey", "type": "string", "required": true, "description": "分账单元唯一标识", "example": "909619400-66eb96bf16618" }, { "name": "BusinessCode", "type": "string", "required": false, "description": "产品编码，用作筛选", "example": "p_cvm" } ], "required": [ "Month", "TreeNodeUniqKey" ] }, { "name": "DescribeAllocationUnitDetail", "description": "查询分账单元详情", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "所查询分账单元Id", "example": "1" }, { "name": "Month", "type": "string", "required": false, "description": "月份，不传默认当前月", "example": "2022-10-01 00:00:00" } ], "required": [ "Id" ] }, { "name": "DescribeBillAdjustInfo", "description": "可以通过API获取当前UIN是否有调账，客户可以更快地主动地获取调账情况。", "status": "online", "parameters": [ { "name": "Month", "type": "string", "required": false, "description": "格式：yyyy-MM账单月份，month和timeFrom\u0026amp;timeTo必传一个，如果有传timeFrom\u0026amp;timeTo则month字段无效", "example": "2024-10" }, { "name": "TimeFrom", "type": "string", "required": false, "description": "格式：yyyy-MM-dd开始时间，month和timeFrom\u0026amp;timeTo必传一个，如果有该字段则month字段无效。timeFrom和timeTo必须一起传，且为相同月份，不支持跨月查询，查询结果是整月数据", "example": "2024-10-01" }, { "name": "TimeTo", "type": "string", "required": false, "description": "格式：yyyy-MM-dd截止时间，month和timeFrom\u0026amp;timeTo必传一个，如果有该字段则month字段无效。timeFrom和timeTo必须一起传，且为相同月份，不支持跨月查询，查询结果是整月数据", "example": "2024-10-02" }, { "name": "PayerUin", "type": "string", "required": false, "description": "支付者的账号 ID（账号 ID 是用户在腾讯云的唯一账号标识），默认查询本账号账单，如集团管理账号需查询成员账号自付的账单，该字段需入参成员账号UIN", "example": "909619400" } ], "required": [] }, { "name": "DescribeBillDetail", "description": "获取账单明细数据。 注意事项： 1.在请求接口时，由于网络不稳定或其它异常，可能会导致请求失败。如果您遇到这种情况，我们建议您在接口请求失败时，手动发起重试操作，这样可以更好地确保您的接口请求能够成功执行。 2.对于账单明细数据量级很大（例如每月账单明细量级超过20w）的客户，通过 API 调用账单数据效率较低，建议您开通账单数据存储功能，通过存储桶\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "分页偏移量，Offset=0表示第一页，如果Limit=100，则Offset=100表示第二页，Offset=200表示第三页，依次类推", "example": "1" }, { "name": "Limit", "type": "integer", "required": true, "description": "数量，最大值为300", "example": "1" }, { "name": "Month", "type": "string", "required": false, "description": "月份，格式为yyyy-mm，Month和BeginTime\u0026EndTime必传一个，如果有传BeginTime\u0026EndTime则Month字段无效。最多可拉取近18个月内的数据。", "example": "2018-07" }, { "name": "BeginTime", "type": "string", "required": false, "description": "周期开始时间，格式为yyyy-mm-dd hh:ii:ss，Month和BeginTime\u0026EndTime必传一个，如果有该字段则Month字段无效。BeginTime和EndTime必须一起传，且为相同月份，不支持跨月查询，查询结果是整月数据。最多可拉取18个月内的数据。", "example": "2018-11-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "周期结束时间，格式为yyyy-mm-dd hh:ii:ss，Month和BeginTime\u0026EndTime必传一个，如果有该字段则Month字段无效。BeginTime和EndTime必须一起传，且为相同月份，不支持跨月查询，查询结果是整月数据。最多可拉取近18个月内的数据。", "example": "2018-11-01 23:59:59" }, { "name": "NeedRecordNum", "type": "integer", "required": false, "description": "是否需要访问列表的总记录数，用于前端分页 1-表示需要， 0-表示不需要", "example": "1" }, { "name": "PayMode", "type": "string", "required": false, "description": "付费模式 prePay(表示包年包月)/postPay(表示按时按量)", "example": "prePay" }, { "name": "ResourceId", "type": "string", "required": false, "description": "查询指定资源信息", "example": "ins-49zhx6z1" }, { "name": "ActionType", "type": "string", "required": false, "description": "查询交易类型（请使用交易类型名称入参），入参示例枚举如下： 包年包月新购 包年包月续费 包年包月配置变更 包年包月退款 按量计费扣费 线下项目扣费 线下产品扣费 调账扣费 调账补偿 按量计费小时结 按量计费日结 按量计费月结 竞价实例小时结 线下项目调账补偿 线下产品调账补偿 优惠扣费 优惠补偿 按量计费迁入资源 按量计费迁出资源 包年包月迁入资源 包年包月\ufffd\ufffd...", "example": "按量计费日结" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目ID:资源所属项目ID", "example": "0" }, { "name": "BusinessCode", "type": "string", "required": false, "description": "产品名称代码 备注：如需获取当月使用过的BusinessCode，请调用API：获取产品汇总费用分布", "example": "p_cvm" }, { "name": "Context", "type": "string", "required": false, "description": "上一次请求返回的上下文信息，翻页查询Month\u003e=2023-05的月份的数据可加快查询速度，数据量10万级别以上的用户建议使用，查询速度可提升2~10倍", "example": "UEEJBfSsteS7dZgAaEEziWS40d4sn4urG7" }, { "name": "PayerUin", "type": "string", "required": false, "description": "支付者的账号 ID（账号 ID 是用户在腾讯云的唯一账号标识），默认查询本账号账单，如集团管理账号需查询成员账号自付的账单，该字段需入参成员账号UIN", "example": "909619400" } ], "required": [ "Offset", "Limit" ] }, { "name": "DescribeBillDetailForOrganization", "description": "成员账号获取管理账号代付账单（费用明细）。 注意事项：在请求接口时，由于网络不稳定或其它异常，可能会导致请求失败。如果您遇到这种情况，我们建议您在接口请求失败时，手动发起重试操作，这样可以更好地确保您的接口请求能够成功执行。", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "分页偏移量，Offset=0表示第一页，如果Limit=100，则Offset=100表示第二页，Offset=200表示第三页，依次类推", "example": "1" }, { "name": "Limit", "type": "integer", "required": true, "description": "数量，最大值为100", "example": "1" }, { "name": "Month", "type": "string", "required": false, "description": "月份，格式为yyyy-mm，Month和BeginTime\u0026EndTime必传一个，如果有传BeginTime\u0026EndTime则Month字段无效。最多可拉取近18个月内的数据。", "example": "2018-07" }, { "name": "BeginTime", "type": "string", "required": false, "description": "周期开始时间，格式为yyyy-mm-dd hh:ii:ss，Month和BeginTime\u0026EndTime必传一个，如果有该字段则Month字段无效。BeginTime和EndTime必须一起传，且为相同月份，不支持跨月查询，查询结果是整月数据。最多可拉取18个月内的数据。", "example": "2018-11-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "周期结束时间，格式为yyyy-mm-dd hh:ii:ss，Month和BeginTime\u0026EndTime必传一个，如果有该字段则Month字段无效。BeginTime和EndTime必须一起传，且为相同月份，不支持跨月查询，查询结果是整月数据。最多可拉取近18个月内的数据。", "example": "2018-11-01 23:59:59" }, { "name": "NeedRecordNum", "type": "integer", "required": false, "description": "是否需要访问列表的总记录数，用于前端分页 1-表示需要， 0-表示不需要", "example": "1" }, { "name": "PayMode", "type": "string", "required": false, "description": "付费模式 prePay(表示包年包月)/postPay(表示按时按量)", "example": "prePay" }, { "name": "ResourceId", "type": "string", "required": false, "description": "查询指定资源信息", "example": "ins-49zhx6z1" }, { "name": "ActionType", "type": "string", "required": false, "description": "查询交易类型（请使用交易类型名称入参），入参示例枚举如下： 包年包月新购 包年包月续费 包年包月配置变更 包年包月退款 按量计费扣费 线下项目扣费 线下产品扣费 调账扣费 调账补偿 按量计费小时结 按量计费日结 按量计费月结 竞价实例小时结 线下项目调账补偿 线下产品调账补偿 优惠扣费 优惠补偿 按量计费迁入资源 按量计费迁出资源 包年包月迁入资源 包年包月\ufffd\ufffd...", "example": "按量计费日结" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目ID:资源所属项目ID", "example": "0" }, { "name": "BusinessCode", "type": "string", "required": false, "description": "产品名称代码 备注：如需获取当月使用过的BusinessCode，请调用API：获取产品汇总费用分布", "example": "p_cvm" }, { "name": "Context", "type": "string", "required": false, "description": "上一次请求返回的上下文信息，翻页查询Month\u003e=2023-05的月份的数据可加快查询速度，数据量10万级别以上的用户建议使用，查询速度可提升2~10倍", "example": "UEEJBfSsteS7dZgAaEEziWS40d4sn4urG7" } ], "required": [ "Offset", "Limit" ] }, { "name": "DescribeBillDownloadUrl", "description": "该接口支持通过传参，获取L0-PDF、L1-汇总、L2-资源、L3-明细、账单包、五类账单文件下载链接", "status": "online", "parameters": [ { "name": "FileType", "type": "string", "required": true, "description": "账单类型，枚举值 billOverview=L0-PDF账单 billSummary=L1-汇总账单 billResource=L2-资源账单 billDetail=L3-明细账单 billPack=账单包", "example": "billOverview" }, { "name": "Month", "type": "string", "required": true, "description": "账单月份 支持的最早开始月份为2021-01 L0-PDF\u0026账单包不支持当月下载，当月账单请在次月1号19:00出账后下载", "example": "2023-08" }, { "name": "ChildUin", "type": "array", "required": false, "description": "下载的账号 ID列表，默认查询本账号账单，如集团管理账号需下载成员账号自付的账单，该字段需入参成员账号UIN", "example": "909619400", "item_type": "string" } ], "required": [ "FileType", "Month" ] }, { "name": "DescribeBillList", "description": "获取收支明细列表，支持翻页和参数过滤", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "查询范围的起始时间（包含）时间格式 yyyy-MM-dd HH:mm:ss 开始时间和结束时间差值小于等于六个月", "example": "2020-01-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "查询范围的结束时间（包含）时间格式 yyyy-MM-dd HH:mm:ss ，开始时间和结束时间差值小于等于六个月", "example": "2020-01-02 00:00:00" }, { "name": "Offset", "type": "integer", "required": true, "description": "翻页偏移量，初始值为0", "example": "1" }, { "name": "Limit", "type": "integer", "required": true, "description": "每页的限制数量", "example": "1" }, { "name": "PayType", "type": "array", "required": false, "description": "交易类型： all所有交易类型，recharge充值，return退款，unblock解冻，agentin资金转入，advanced垫付，cash提现，deduct扣费，block冻结，agentout资金转出，repay垫付回款，repayment还款(仅国际信用账户)，adj_refund调增(仅国际信用账户)，adj_deduct调减(仅国际信用账户)", "example": "[\"recharge\"]", "item_type": "string" }, { "name": "SubPayType", "type": "array", "required": false, "description": "扣费模式， 当所选的交易类型为扣费deduct时： all所有扣费类型;trade预付费支付;hour_h按量小时结;hour_d按量日结;hour_m按量月结;decompensate调账扣费;other第三方扣费;panshi 线下项目扣费;offline 线下产品扣费; 当所选的交易类型为扣费recharge时： online 在线充值;bank-enterprice 银企直联;offline 线下充值;transfer 分成充值 当所选的交易类型为扣费cash时： online 线上提现;offline 线下提现;panshi 赠...", "example": "[\"trade\"]", "item_type": "string" }, { "name": "WithZeroAmount", "type": "integer", "required": false, "description": "是否返回0元交易金额的交易项，取值：0-不返回，1-返回。不传该参数则不返回", "example": "1" } ], "required": [ "StartTime", "EndTime", "Offset", "Limit" ] }, { "name": "DescribeBillResourceSummary", "description": "获取账单资源汇总数据", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "分页偏移量，Offset=0表示第一页，如果Limit=100，则Offset=100表示第二页，Offset=200表示第三页，依次类推", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "数量，最大值为1000", "example": "1" }, { "name": "Month", "type": "string", "required": true, "description": "月份，格式为yyyy-mm。不能早于开通账单2.0的月份", "example": "2018-08" }, { "name": "NeedRecordNum", "type": "integer", "required": false, "description": "是否需要访问列表的总记录数，用于前端分页 1-表示需要， 0-表示不需要", "example": "1" }, { "name": "ActionType", "type": "string", "required": false, "description": "查询交易类型（请使用交易类型名称入参），入参示例枚举如下： 包年包月新购 包年包月续费 包年包月配置变更 包年包月退款 按量计费扣费 线下项目扣费 线下产品扣费 调账扣费 调账补偿 按量计费小时结 按量计费日结 按量计费月结 竞价实例小时结 线下项目调账补偿 线下产品调账补偿 优惠扣费 优惠补偿 按量计费迁入资源 按量计费迁出资源 包年包月迁入资源 包年包月\ufffd\ufffd...", "example": "按量计费扣费" }, { "name": "ResourceId", "type": "string", "required": false, "description": "查询指定资源信息", "example": "ins-1op7g2iz" }, { "name": "PayMode", "type": "string", "required": false, "description": "付费模式 prePay/postPay", "example": "prePay" }, { "name": "BusinessCode", "type": "string", "required": false, "description": "产品名称代码 备注：如需获取当月使用过的BusinessCode，请调用API：获取产品汇总费用分布", "example": "p_cvm" }, { "name": "PayerUin", "type": "string", "required": false, "description": "支付者的账号 ID（账号 ID 是用户在腾讯云的唯一账号标识），默认查询本账号账单，如集团管理账号需查询成员账号自付的账单，该字段需入参成员账号UIN", "example": "909619400" }, { "name": "TagKey", "type": "string", "required": false, "description": "分账标签键，用户自定义（支持2021-01以后账单查询）", "example": "province" }, { "name": "TagValue", "type": "string", "required": false, "description": "分账标签值，该参数为空表示该标签键下未设置标签值的记录 （支持2021-01以后账单查询）", "example": "0" } ], "required": [ "Offset", "Limit", "Month" ] }, { "name": "DescribeBillResourceSummaryForOrganization", "description": "成员账号获取管理账号代付账单（按资源汇总）", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "分页偏移量，Offset=0表示第一页，如果Limit=100，则Offset=100表示第二页，Offset=200表示第三页，依次类推", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "数量，最大值为1000", "example": "1" }, { "name": "Month", "type": "string", "required": true, "description": "月份，格式为yyyy-mm。不能早于开通账单2.0的月份", "example": "2018-08" }, { "name": "NeedRecordNum", "type": "integer", "required": false, "description": "是否需要访问列表的总记录数，用于前端分页 1-表示需要， 0-表示不需要", "example": "1" }, { "name": "ActionType", "type": "string", "required": false, "description": "查询交易类型（请使用交易类型名称入参），入参示例枚举如下： 包年包月新购 包年包月续费 包年包月配置变更 包年包月退款 按量计费扣费 线下项目扣费 线下产品扣费 调账扣费 调账补偿 按量计费小时结 按量计费日结 按量计费月结 竞价实例小时结 线下项目调账补偿 线下产品调账补偿 优惠扣费 优惠补偿 按量计费迁入资源 按量计费迁出资源 包年包月迁入资源 包年包月\ufffd\ufffd...", "example": "按量计费扣费" }, { "name": "ResourceId", "type": "string", "required": false, "description": "查询指定资源信息", "example": "ins-1op7g2iz" }, { "name": "PayMode", "type": "string", "required": false, "description": "付费模式 prePay/postPay", "example": "prePay" }, { "name": "BusinessCode", "type": "string", "required": false, "description": "产品名称代码 备注：如需获取当月使用过的BusinessCode，请调用API：获取产品汇总费用分布", "example": "p_cvm" }, { "name": "TagKey", "type": "string", "required": false, "description": "分账标签键，用户自定义（支持2021-01以后账单查询）", "example": "province" }, { "name": "TagValue", "type": "string", "required": false, "description": "分账标签值，该参数为空表示该标签键下未设置标签值的记录 （支持2021-01以后账单查询）", "example": "0" } ], "required": [ "Offset", "Limit", "Month" ] }, { "name": "DescribeBillSummary", "description": "该接口支持通过传参，按照产品、项目、地域、计费模式和标签五个维度获取账单费用明细。", "status": "online", "parameters": [ { "name": "Month", "type": "string", "required": true, "description": "账单月份，格式为2023-04", "example": "2023-05" }, { "name": "GroupType", "type": "string", "required": true, "description": "账单维度类型，枚举值如下：business、project、region、payMode、tag", "example": "business" }, { "name": "TagKey", "type": "array", "required": false, "description": "标签键，GroupType=tag获取标签维度账单时传", "example": "[\"测试键\"]", "item_type": "string" }, { "name": "OperateUin", "type": "string", "required": false, "description": "操作者UIN：操作者账号 ID（预付费资源下单或后付费操作开通资源账号的 ID 或者角色 ID ）", "example": "909619400" }, { "name": "PayerUin", "type": "string", "required": false, "description": "支付者的账号 ID（账号 ID 是用户在腾讯云的唯一账号标识），默认查询本账号账单，如集团管理账号需查询成员账号自付的账单，该字段需入参成员账号UIN", "example": "909619400" } ], "required": [ "Month", "GroupType" ] }, { "name": "DescribeBillSummaryByPayMode", "description": "获取按计费模式汇总费用分布", "status": "online", "parameters": [ { "name": "BeginTime", "type": "string", "required": true, "description": "目前必须和EndTime相同月份，不支持跨月查询，且查询结果是整月数据，例如 BeginTime为2018-09，EndTime 为 2018-09，查询结果是 2018 年 9 月数据。", "example": "2018-11" }, { "name": "EndTime", "type": "string", "required": true, "description": "目前必须和BeginTime为相同月份，不支持跨月查询，且查询结果是整月数据，例如 BeginTime为2018-09，EndTime 为 2018-09，查询结果是 2018 年 9 月数据。", "example": "2018-11" }, { "name": "PayerUin", "type": "string", "required": false, "description": "查询账单数据的用户UIN", "example": "909619400" } ], "required": [ "BeginTime", "EndTime" ] }, { "name": "DescribeBillSummaryByProduct", "description": "获取产品汇总费用分布", "status": "online", "parameters": [ { "name": "BeginTime", "type": "string", "required": true, "description": "目前必须和EndTime相同月份，不支持跨月查询，且查询结果是整月数据，例如 BeginTime为2018-09，EndTime 为 2018-09，查询结果是 2018 年 9 月数据。", "example": "2018-11" }, { "name": "EndTime", "type": "string", "required": true, "description": "目前必须和BeginTime为相同月份，不支持跨月查询，且查询结果是整月数据，例如 BeginTime为2018-09，EndTime 为 2018-09，查询结果是 2018 年 9 月数据。", "example": "2018-11" }, { "name": "PayerUin", "type": "string", "required": false, "description": "查询账单数据的用户UIN", "example": "909619400" }, { "name": "PayType", "type": "string", "required": false, "description": "款项类别，与L0账单上的汇总类别对应。 此参数自账单3.0（即2021-05）之后开始生效。 枚举值： consume-消费 refund-退款 adjustment-调账", "example": "consume" } ], "required": [ "BeginTime", "EndTime" ] }, { "name": "DescribeBillSummaryByProject", "description": "获取按项目汇总费用分布", "status": "online", "parameters": [ { "name": "BeginTime", "type": "string", "required": true, "description": "目前必须和EndTime相同月份，不支持跨月查询，且查询结果是整月数据，例如 BeginTime为2018-09，EndTime 为 2018-09，查询结果是 2018 年 9 月数据。", "example": "2018-11" }, { "name": "EndTime", "type": "string", "required": true, "description": "目前必须和BeginTime为相同月份，不支持跨月查询，且查询结果是整月数据，例如 BeginTime为2018-09，EndTime 为 2018-09，查询结果是 2018 年 9 月数据。", "example": "2018-11" }, { "name": "PayerUin", "type": "string", "required": false, "description": "查询账单数据的用户UIN", "example": "10002011014" } ], "required": [ "BeginTime", "EndTime" ] }, { "name": "DescribeBillSummaryByRegion", "description": "获取按地域汇总费用分布", "status": "online", "parameters": [ { "name": "BeginTime", "type": "string", "required": true, "description": "目前必须和EndTime相同月份，不支持跨月查询，且查询结果是整月数据，例如 BeginTime为2018-09，EndTime 为 2018-09，查询结果是 2018 年 9 月数据。", "example": "2018-11" }, { "name": "EndTime", "type": "string", "required": true, "description": "目前必须和BeginTime为相同月份，不支持跨月查询，且查询结果是整月数据，例如 BeginTime为2018-09，EndTime 为 2018-09，查询结果是 2018 年 9 月数据。", "example": "2018-11" }, { "name": "PayerUin", "type": "string", "required": false, "description": "查询账单数据的用户UIN", "example": "10002011014" } ], "required": [ "BeginTime", "EndTime" ] }, { "name": "DescribeBillSummaryByTag", "description": "获取按标签汇总费用分布", "status": "online", "parameters": [ { "name": "BeginTime", "type": "string", "required": true, "description": "目前必须和EndTime相同月份，不支持跨月查询，且查询结果是整月数据，例如 BeginTime为2018-09，EndTime 为 2018-09，查询结果是 2018 年 9 月数据。", "example": "2019-09" }, { "name": "EndTime", "type": "string", "required": true, "description": "目前必须和BeginTime为相同月份，不支持跨月查询，且查询结果是整月数据，例如 BeginTime为2018-09，EndTime 为 2018-09，查询结果是 2018 年 9 月数据。", "example": "2019-09" }, { "name": "TagKey", "type": "string", "required": true, "description": "分账标签键，用户自定义", "example": "province" }, { "name": "PayerUin", "type": "string", "required": false, "description": "查询账单数据的用户UIN", "example": "10002011014" }, { "name": "TagValue", "type": "string", "required": false, "description": "分账标签值", "example": "0" } ], "required": [ "BeginTime", "EndTime", "TagKey" ] }, { "name": "DescribeBillSummaryForOrganization", "description": "该接口支持通过传参，按照产品、项目、地域、计费模式和标签五个维度获取账单费用明细。", "status": "online", "parameters": [ { "name": "Month", "type": "string", "required": true, "description": "账单月份，格式为2023-04", "example": "2023-05" }, { "name": "GroupType", "type": "string", "required": true, "description": "账单维度类型，枚举值如下：business、project、region、payMode、tag", "example": "business" }, { "name": "TagKey", "type": "array", "required": false, "description": "标签键，GroupType=tag获取标签维度账单时传", "example": "测试键", "item_type": "string" } ], "required": [ "Month", "GroupType" ] }, { "name": "DescribeBudget", "description": "获取预算详细信息", "status": "online", "parameters": [ { "name": "PageNo", "type": "integer", "required": true, "description": "页码，整型", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "每页数目，整型", "example": "10" }, { "name": "BudgetId", "type": "string", "required": false, "description": "预算项目id", "example": "1231" }, { "name": "BudgetName", "type": "string", "required": false, "description": "预算名称", "example": "1元-按日-固定-全产品-三个月" }, { "name": "BudgetStatus", "type": "string", "required": false, "description": "EXPIRED失效，ACTIVE生效中， ACTIVATED待生效", "example": "ACTIVE" }, { "name": "CycleTypes", "type": "array", "required": false, "description": "DAY天 MONTH月度 QUARTER季度 YEAR年度", "example": "[\"DAY\"]", "item_type": "string" } ], "required": [ "PageNo", "PageSize" ] }, { "name": "DescribeBudgetOperationLog", "description": "查询预算修改记录", "status": "online", "parameters": [ { "name": "PageNo", "type": "integer", "required": true, "description": "页码", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "每页数目", "example": "10" }, { "name": "BudgetId", "type": "string", "required": true, "description": "预算项目id", "example": "25785" } ], "required": [ "PageNo", "PageSize", "BudgetId" ] }, { "name": "DescribeBudgetRemindRecordList", "description": "返回预算提醒记录，包括预算周期、检测时间、提醒时间、提醒类型、提醒内容", "status": "online", "parameters": [ { "name": "PageNo", "type": "integer", "required": true, "description": "页码，整型", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "每页数目，整型", "example": "10" }, { "name": "BudgetId", "type": "string", "required": true, "description": "预算基础信息关联id", "example": "234322431" } ], "required": [ "PageNo", "PageSize", "BudgetId" ] }, { "name": "DescribeCostDetail", "description": "查询消耗明细 注意事项： 1. 对于消耗明细数据量级很大（例如每月消耗明细量级超过100w）的客户，通过 API 调用明细数据会有超时风险，建议您开通消耗账单数据存储功能，通过存储桶中获取账单文件进行分析。[账单存储至COS桶](https://cloud.tencent.com/document/product/555/61275)", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "数量，最大值为100", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量", "example": "0" }, { "name": "BeginTime", "type": "string", "required": false, "description": "周期开始时间，查询粒度为天级别，需传入时分秒参数，格式为yyyy-mm-dd hh:ii:ss，Month和BeginTime\u0026EndTime必传一个，如果有该字段则Month字段无效。BeginTime和EndTime必须一起传，且为同一月份，暂不支持跨月拉取。可拉取的数据是开通消耗账单后，且距今 18 个月内的数据。", "example": "2025-01-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "周期结束时间，查询粒度为天级别，需传入时分秒参数，格式为yyyy-mm-dd hh:ii:ss，Month和BeginTime\u0026EndTime必传一个，如果有该字段则Month字段无效。BeginTime和EndTime必须一起传，且为同一月份，暂不支持跨月拉取。可拉取的数据是开通消耗账单后，且距今 18 个月内的数据。", "example": "2025-01-31 23:59:59" }, { "name": "NeedRecordNum", "type": "integer", "required": false, "description": "是否需要访问列表的总记录数，用于前端分页 1-表示需要， 0-表示不需要", "example": "0" }, { "name": "Month", "type": "string", "required": false, "description": "月份，格式为yyyy-mm，Month和BeginTime\u0026EndTime必传一个，如果有传BeginTime\u0026EndTime则Month字段无效。不能早于开通消耗账单的月份，最多可拉取18个月内的数据。", "example": "2025-01" }, { "name": "ProductCode", "type": "string", "required": false, "description": "查询指定产品信息", "example": "sp_cls" }, { "name": "PayMode", "type": "string", "required": false, "description": "付费模式 prePay/postPay", "example": "postPay" }, { "name": "ResourceId", "type": "string", "required": false, "description": "查询指定资源信息", "example": "1400532488" } ], "required": [ "Limit", "Offset" ] }, { "name": "DescribeCostExplorerSummary", "description": "查看成本分析明细", "status": "online", "parameters": [ { "name": "BeginTime", "type": "string", "required": true, "description": "周期开始时间，格式为yyyy-mm-dd hh:ii:ss", "example": "2023-01-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "周期结束时间，格式为yyyy-mm-dd hh:ii:ss", "example": "2024-01-01 23:59:59" }, { "name": "BillType", "type": "string", "required": true, "description": "账单类型：1-费用账单、2-消耗账单", "example": "1" }, { "name": "PeriodType", "type": "string", "required": true, "description": "统计周期：日-day，月-month；", "example": "day" }, { "name": "Dimensions", "type": "string", "required": true, "description": "分类维度（数据汇总维度），查询分类维度（请使用分类维度code入参）入参枚举值： default=仅总计 feeType=费用类型 billType=账单类型 business=产品 product=子产品 region=地域 zone=可用区 actionType=交易类型 payMode =计费模式 tags=标签 project =项目 payerUin=支付者账号 ownerUin=使用者账号", "example": "business" }, { "name": "FeeType", "type": "string", "required": true, "description": "费用类型：cost-折后总费用，totalCost-原价费用", "example": "cost" }, { "name": "PageSize", "type": "integer", "required": true, "description": "数量，每页最大值为100", "example": "100" }, { "name": "PageNo", "type": "integer", "required": true, "description": "起始页，当PageNo=1表示第一页， PageNo=2表示第二页，依次类推。", "example": "1" }, { "name": "TagKeyStr", "type": "string", "required": false, "description": "分账标签值", "example": "project" }, { "name": "NeedConditionValue", "type": "string", "required": false, "description": "是否需要筛选框， 1-表示需要， 0-表示不需要，若不传默认不需要。", "example": "0" }, { "name": "Conditions", "type": "object", "required": false, "description": "筛选参数", "example": "无", "children": [ { "name": "BusinessCodes", "type": "string", "required": false, "description": "产品名称代码", "example": "p_cvm" }, { "name": "ProductCodes", "type": "string", "required": false, "description": "子产品名称代码", "example": "sp_cvm" }, { "name": "ComponentCode", "type": "string", "required": false, "description": "组件类型代码", "example": "v_cpu" }, { "name": "ZoneIds", "type": "string", "required": false, "description": "可用区ID：资源所属可用区ID", "example": "10001" }, { "name": "RegionIds", "type": "string", "required": false, "description": "地域ID:资源所属地域ID", "example": "47" }, { "name": "ProjectIds", "type": "string", "required": false, "description": "项目ID:资源所属项目ID", "example": "0" }, { "name": "PayModes", "type": "string", "required": false, "description": "计费模式 prePay(表示包年包月)/postPay(表示按量计费)", "example": "postPay" }, { "name": "ActionTypes", "type": "string", "required": false, "description": "交易类型，查询交易类型（请使用交易类型code入参）", "example": "postpay_deduct_d" }, { "name": "Tags", "type": "string", "required": false, "description": "分账标签键", "example": "{\"二级业务\":\"CoreDB_740044\"}" }, { "name": "FeeType", "type": "string", "required": false, "description": "费用类型，查询费用类型（请使用费用类型code入参)入参枚举如下： cashPayAmount:现金 incentivePayAmount:赠送金 voucherPayAmount:优惠券 tax:税金 costBeforeTax:税前价", "example": "cashPayAmount" }, { "name": "PayerUins", "type": "string", "required": false, "description": "查询成本分析数据的用户UIN", "example": "909619400" }, { "name": "OwnerUins", "type": "string", "required": false, "description": "使用资源的用户UIN", "example": "909614900" }, { "name": "ConsumptionTypes", "type": "string", "required": false, "description": "消耗类型，查询消耗类型（请使用消耗类型code入参）", "example": "prepay_purchase" } ] } ], "required": [ "BeginTime", "EndTime", "BillType", "PeriodType", "Dimensions", "FeeType", "PageSize", "PageNo" ] }, { "name": "DescribeCostSummaryByProduct", "description": "获取按产品汇总消耗详情", "status": "online", "parameters": [ { "name": "BeginTime", "type": "string", "required": true, "description": "目前必须和EndTime相同月份，不支持跨月查询，且查询结果是整月数据，例如 BeginTime为2018-09，EndTime 为 2018-09，查询结果是 2018 年 9 月数据。", "example": "2024-11" }, { "name": "EndTime", "type": "string", "required": true, "description": "目前必须和BeginTime为相同月份，不支持跨月查询，且查询结果是整月数据，例如 BeginTime为2018-09，EndTime 为 2018-09，查询结果是 2018 年 9 月数据。", "example": "2024-11" }, { "name": "Limit", "type": "integer", "required": true, "description": "每次获取数据量，最大值为100", "example": "1" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量,默认从0开始", "example": "0" }, { "name": "PayerUin", "type": "string", "required": false, "description": "查询账单数据的用户UIN", "example": "10002011014" }, { "name": "NeedRecordNum", "type": "integer", "required": false, "description": "是否需要返回记录数量，0不需要，1需要，默认不需要", "example": "1" } ], "required": [ "BeginTime", "EndTime", "Limit", "Offset" ] }, { "name": "DescribeCostSummaryByProject", "description": "获取按项目汇总消耗详情", "status": "online", "parameters": [ { "name": "BeginTime", "type": "string", "required": true, "description": "目前必须和EndTime相同月份，不支持跨月查询，且查询结果是整月数据，例如 BeginTime为2018-09，EndTime 为 2018-09，查询结果是 2018 年 9 月数据。", "example": "2024-11" }, { "name": "EndTime", "type": "string", "required": true, "description": "目前必须和BeginTime为相同月份，不支持跨月查询，且查询结果是整月数据，例如 BeginTime为2018-09，EndTime 为 2018-09，查询结果是 2018 年 9 月数据。", "example": "2024-11" }, { "name": "Limit", "type": "integer", "required": true, "description": "每次获取数据量，最大值为100", "example": "1" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量,默认从0开始", "example": "0" }, { "name": "PayerUin", "type": "string", "required": false, "description": "查询账单数据的用户UIN", "example": "10002011014" }, { "name": "NeedRecordNum", "type": "integer", "required": false, "description": "是否需要返回记录数量，0不需要，1需要，默认不需要", "example": "1" } ], "required": [ "BeginTime", "EndTime", "Limit", "Offset" ] }, { "name": "DescribeCostSummaryByRegion", "description": "获取按地域汇总消耗详情", "status": "online", "parameters": [ { "name": "BeginTime", "type": "string", "required": true, "description": "目前必须和EndTime相同月份，不支持跨月查询，且查询结果是整月数据，例如 BeginTime为2018-09，EndTime 为 2018-09，查询结果是 2018 年 9 月数据。", "example": "2024-11" }, { "name": "EndTime", "type": "string", "required": true, "description": "目前必须和BeginTime为相同月份，不支持跨月查询，且查询结果是整月数据，例如 BeginTime为2018-09，EndTime 为 2018-09，查询结果是 2018 年 9 月数据。", "example": "2024-11" }, { "name": "Limit", "type": "integer", "required": true, "description": "每次获取数据量，最大值为100", "example": "1" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量,默认从0开始", "example": "0" }, { "name": "PayerUin", "type": "string", "required": false, "description": "查询账单数据的用户UIN", "example": "10002011014" }, { "name": "NeedRecordNum", "type": "integer", "required": false, "description": "是否需要返回记录数量，0不需要，1需要，默认不需要", "example": "1" } ], "required": [ "BeginTime", "EndTime", "Limit", "Offset" ] }, { "name": "DescribeCostSummaryByResource", "description": "获取按资源汇总消耗详情", "status": "online", "parameters": [ { "name": "BeginTime", "type": "string", "required": true, "description": "目前必须和EndTime相同月份，不支持跨月查询，且查询结果是整月数据，例如 BeginTime为2018-09，EndTime 为 2018-09，查询结果是 2018 年 9 月数据。", "example": "2024-11" }, { "name": "EndTime", "type": "string", "required": true, "description": "目前必须和BeginTime为相同月份，不支持跨月查询，且查询结果是整月数据，例如 BeginTime为2018-09，EndTime 为 2018-09，查询结果是 2018 年 9 月数据。", "example": "2024-11" }, { "name": "Limit", "type": "integer", "required": true, "description": "每次获取数据量，最大值为100", "example": "1" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量,默认从0开始", "example": "0" }, { "name": "PayerUin", "type": "string", "required": false, "description": "查询账单数据的用户UIN", "example": "10002011014" }, { "name": "NeedRecordNum", "type": "integer", "required": false, "description": "是否需要返回记录数量，0不需要，1需要，默认不需要", "example": "0" }, { "name": "NeedConditionValue", "type": "integer", "required": false, "description": "是否需要返回过滤条件，0不需要，1需要，默认不需要", "example": "0" }, { "name": "Conditions", "type": "object", "required": false, "description": "过滤条件，只支持ResourceKeyword(资源关键字，支持资源id及资源名称模糊查询)，ProjectIds（项目id），RegionIds(地域id)，PayModes(付费模式，可选prePay和postPay)，HideFreeCost（是否隐藏0元流水，可选0和1），OrderByCost（按费用排序规则，可选desc和asc）", "example": "无", "children": [ { "name": "TimeRange", "type": "integer", "required": false, "description": "只支持6和12两个值", "example": "6" }, { "name": "BusinessCode", "type": "string", "required": false, "description": "产品名称代码", "example": "p_clb" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目ID", "example": "0" }, { "name": "RegionId", "type": "integer", "required": false, "description": "地域ID", "example": "0" }, { "name": "PayMode", "type": "string", "required": false, "description": "付费模式，可选prePay和postPay", "example": "postPay" }, { "name": "ResourceKeyword", "type": "string", "required": false, "description": "资源关键字", "example": "lb-1weg57ny" }, { "name": "BusinessCodes", "type": "array", "required": false, "description": "产品名称代码", "example": "p_clb", "item_type": "string" }, { "name": "ProductCodes", "type": "array", "required": false, "description": "子产品名称代码", "example": "sp_clb", "item_type": "string" }, { "name": "RegionIds", "type": "array", "required": false, "description": "地域ID", "example": "1", "item_type": "integer" }, { "name": "ProjectIds", "type": "array", "required": false, "description": "项目ID", "example": "0", "item_type": "integer" }, { "name": "PayModes", "type": "array", "required": false, "description": "付费模式，可选prePay和postPay", "example": "postPay", "item_type": "string" }, { "name": "ActionTypes", "type": "array", "required": false, "description": "交易类型", "example": "postpay_deduct_h", "item_type": "string" }, { "name": "HideFreeCost", "type": "integer", "required": false, "description": "是否隐藏0元流水", "example": "1" }, { "name": "OrderByCost", "type": "string", "required": false, "description": "排序规则，可选desc和asc", "example": "asc" }, { "name": "BillIds", "type": "array", "required": false, "description": "交易ID", "example": "20211101400077789101862", "item_type": "string" }, { "name": "ComponentCodes", "type": "array", "required": false, "description": "组件编码", "example": "v_clb_ins", "item_type": "string" }, { "name": "FileIds", "type": "array", "required": false, "description": "文件ID", "example": "1", "item_type": "string" }, { "name": "FileTypes", "type": "array", "required": false, "description": "文件类型", "example": "CustomizedDosage", "item_type": "string" }, { "name": "Status", "type": "array", "required": false, "description": "状态", "example": "1", "item_type": "integer" } ] } ], "required": [ "BeginTime", "EndTime", "Limit", "Offset" ] }, { "name": "DescribeCostSummaryByTag", "description": "获取按标签汇总消耗详情", "status": "online", "parameters": [ { "name": "BeginTime", "type": "string", "required": true, "description": "目前必须和EndTime相同月份，不支持跨月查询，且查询结果是整月数据，例如 BeginTime为2025-12，EndTime 为 2025-12，查询结果是 2025 年 12 月数据。", "example": "2025-03-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "目前必须和BeginTime为相同月份，不支持跨月查询，且查询结果是整月数据，例如 BeginTime为2025-12，EndTime 为 2025-12，查询结果是 2025 年 12 月数据。", "example": "2025-03-31 23:59:59" }, { "name": "TagKey", "type": "string", "required": true, "description": "分账标签键，用户自定义", "example": "olinatest" } ], "required": [ "BeginTime", "EndTime", "TagKey" ] }, { "name": "DescribeDealsByCond", "description": "查询订单", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "开始时间 2016-01-01 00:00:00", "example": "2016-01-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间 2016-02-01 00:00:00 建议跨度不超过3个月", "example": "2016-02-01 00:00:00" }, { "name": "Limit", "type": "integer", "required": true, "description": "一页多少条数据，默认是20条，最大不超过1000", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "第多少页，从0开始，默认是0", "example": "0" }, { "name": "Status", "type": "integer", "required": false, "description": "订单状态,默认为4（成功的订单） 订单的状态 1：未支付 2：已支付3：发货中 4：已发货 5：发货失败 6：已退款 7：已关单 8：订单过期 9：订单已失效 10：产品已失效 11：代付拒绝 12：支付中", "example": "4" }, { "name": "OrderId", "type": "string", "required": false, "description": "子订单号", "example": "202202021234567" }, { "name": "BigDealId", "type": "string", "required": false, "description": "大订单号", "example": "202202021234566" }, { "name": "ResourceId", "type": "string", "required": false, "description": "资源id", "example": "ins-a2bb34" }, { "name": "StatusSet", "type": "array", "required": false, "description": "订单状态", "example": "[1,2]", "item_type": "integer" } ], "required": [ "StartTime", "EndTime", "Limit" ] }, { "name": "DescribeDosageCosDetailByDate", "description": "获取COS产品用量明细", "status": "online", "parameters": [ { "name": "StartDate", "type": "string", "required": true, "description": "查询用量开始时间，格式为yyyy-mm-dd，例如：2020-09-01", "example": "2020-09-01" }, { "name": "EndDate", "type": "string", "required": true, "description": "查询用量结束时间，格式为yyyy-mm-dd，例如：2020-09-30（与开始时间同月，不支持跨月查询）", "example": "2020-09-30" }, { "name": "BucketName", "type": "string", "required": true, "description": "COS 存储桶名称，可通过Get Service 接口是用来获取请求者名下的所有存储空间列表（Bucket list）https://cloud.tencent.com/document/product/436/8291", "example": "systemcover-1000027" } ], "required": [ "StartDate", "EndDate", "BucketName" ] }, { "name": "DescribeDosageDetailByDate", "description": "按日期获取产品用量明细", "status": "online", "parameters": [ { "name": "StartDate", "type": "string", "required": true, "description": "查询账单开始日期，如 2019-01-01", "example": "2019-01-01" }, { "name": "EndDate", "type": "string", "required": true, "description": "查询账单结束日期，如 2019-01-01， 时间跨度不超过7天", "example": "2019-01-01" }, { "name": "ProductCode", "type": "string", "required": true, "description": "互动直播： 10194 互动直播-核心机房 : 10195 互动直播-边缘机房 cdn业务： 102383：CDN静态加速流量(国内) 102384：CDN静态加速带宽(国内) 102385：CDN静态加速流量(海外) 102386：CDN静态加速带宽(海外) 100967：弹性公网IP-按流量计费 101065：公网负载均衡-按流量计费 视频直播 10226 视频直播流量(国内) 10227 视频直播带宽(国内) 100763 视频直播流量(海外) 100762 视频直播宽带(海外) 仅支持以上产...", "example": "102383" }, { "name": "Domain", "type": "string", "required": true, "description": "查询域名 例如 www.qq.com 非CDN业务查询时传入空字符串，返回的值为空", "example": "www.gdxxb.com" }, { "name": "InstanceID", "type": "string", "required": false, "description": "1、如果为空，则返回EIP或CLB所有实例的明细； 2、如果传入实例名，则返回该实例明细", "example": "cos-909619400" }, { "name": "PayerUin", "type": "string", "required": false, "description": "支付者的账号 ID（账号 ID 是用户在腾讯云的唯一账号标识），默认查询本账号账单，如集团管理账号需查询成员账号自付的账单，该字段需入参成员账号UIN", "example": "909619400" } ], "required": [ "StartDate", "EndDate", "ProductCode", "Domain" ] }, { "name": "DescribeDosageDetailList", "description": "获取已接入标准用量明细模板产品的用量明细数据，目前已接入并支持查询的产品包括：云联络中心、实时音视频、实时音视频、智能媒资托管、CODING DevOps、全球IP应用加速", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "用量起始时间，如：2023-02-01", "example": "2023-02-01" }, { "name": "EndTime", "type": "string", "required": true, "description": "用量截止时间，如：2023-02-28", "example": "2023-02-28" }, { "name": "ProductCode", "type": "string", "required": true, "description": "产品编码，已支持查询的产品如下： p_ccc（云联络中心） p_rav（实时音视频） p_pstn（号码保护） p_smh（智能媒资托管） p_coding_devops（CODING DevOps） p_dsa（全球IP应用加速）", "example": "p_ccc" }, { "name": "Offset", "type": "integer", "required": true, "description": "数据偏移量（从0开始）", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "单次数据量（最大3000）", "example": "100" }, { "name": "DosageType", "type": "string", "required": false, "description": "用量统计类型：用量明细的数据统计汇总周期类型，包括minute-按5分钟汇总、hour-按小时汇总、day-按天汇总、month-按月汇总、comm-其他，默认查询所有类型明细，目前各产品已支持的统计类型如下： p_ccc（云联络中心）：comm、day p_rav（实时音视频）：minute、day p_pstn（号码保护）：comm p_smh（智能媒资托管）：day p_coding_devops（CODING DevOps）：comm、day p_dsa（全球IP应用加速）：minute", "example": "minute" } ], "required": [ "StartTime", "EndTime", "ProductCode", "Offset", "Limit" ] }, { "name": "DescribeGatherResource", "description": "查询分账账单资源归集汇总", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "数量，最大值为1000", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页偏移量，Offset=0表示第一页，如果Limit=100，则Offset=100表示第二页，Offset=200表示第三页，以此类推", "example": "0" }, { "name": "Month", "type": "string", "required": false, "description": "账单月份，格式为2024-02，不传默认当前月", "example": "2024-02" }, { "name": "TreeNodeUniqKey", "type": "string", "required": false, "description": "分账单元唯一标识，用作筛选", "example": "909619400-65b9a02cd832f" }, { "name": "GatherType", "type": "string", "required": false, "description": "资源目录类别，枚举值如下： all - 全部 none - 未归集", "example": "all" }, { "name": "Sort", "type": "string", "required": false, "description": "排序字段，枚举值如下： realCost - 折后总价 cashPayAmount - 现金金额 voucherPayAmount - 代金券金额 incentivePayAmount - 赠送金金额 transferPayAmount -分成金金额", "example": "realCost" }, { "name": "SortType", "type": "string", "required": false, "description": "排序类型，枚举值如下： asc - 升序 desc - 降序", "example": "asc" }, { "name": "BusinessCodes", "type": "array", "required": false, "description": "产品编码，用作筛选", "example": "[\"p_cvm\"]", "item_type": "string" }, { "name": "ProductCodes", "type": "array", "required": false, "description": "子产品编码，用作筛选", "example": "[\"sp_cvm_c4\"]", "item_type": "string" }, { "name": "ItemCodes", "type": "array", "required": false, "description": "组件名称编码，用作筛选", "example": "[\"virtual_v_cvm_compute_c4\"]", "item_type": "string" }, { "name": "RegionIds", "type": "array", "required": false, "description": "地域ID，用作筛选", "example": "[4]", "item_type": "integer" }, { "name": "InstanceTypes", "type": "array", "required": false, "description": "实例类型编码，用作筛选", "example": "[\"ri\"]", "item_type": "string" }, { "name": "PayModes", "type": "array", "required": false, "description": "计费模式编码，用作筛选", "example": "[\"prePay\"]", "item_type": "string" }, { "name": "OperateUins", "type": "array", "required": false, "description": "操作者UIN，用作筛选", "example": "[\"909619400\"]", "item_type": "string" }, { "name": "OwnerUins", "type": "array", "required": false, "description": "使用者UIN，用作筛选", "example": "[\"909619400\"]", "item_type": "string" }, { "name": "SearchKey", "type": "string", "required": false, "description": "模糊搜索：支持标签、资源id、资源别名", "example": "nugcbucket-1000027" }, { "name": "Tag", "type": "array", "required": false, "description": "标签，用作筛选", "example": "[\"tagkey:tagValue\"]", "item_type": "string" }, { "name": "ProjectIds", "type": "array", "required": false, "description": "项目ID，用作筛选", "example": "[\"0\",\"1\"]", "item_type": "string" }, { "name": "ActionTypes", "type": "array", "required": false, "description": "交易类型编码，用作筛选", "example": "[\"postpay_deduct_d\"]", "item_type": "string" } ], "required": [ "Limit", "Offset" ] }, { "name": "DescribeGatherRuleDetail", "description": "查询归集规则详情", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "所查询归集规则ID", "example": "12" }, { "name": "Month", "type": "string", "required": false, "description": "月份，不传默认当前月", "example": "2022-10-01 00:00:00" } ], "required": [ "Id" ] }, { "name": "DescribeRenewInstances", "description": "注意事项： 1、本接口支持查询已接入续费管理页的包年包月实例，包括运行中、已隔离（部分产品不支持） 2、子用户使用该接口时，应具备QcloudFinanceRenewManageFullAccess权限策略。", "status": "online", "parameters": [ { "name": "MaxResults", "type": "integer", "required": true, "description": "每页的最大实例条数。 取值范围：1~100。", "example": "10" }, { "name": "NextToken", "type": "string", "required": false, "description": "查询返回结果下一页的令牌。首次调用 API 不需要NextToken。", "example": "VDAwMSu3Y69lZhLwW1bRxLiwKafWBv_6TqKBnp-YH12b0uWcwTBf3DIK7Myza6EVdhDKoFGpKANnZkfmmLy5K8uH1lJYqyvuT_mSXc8VoOdX-8kcKJrB3JbyW9dM0edrKm3Q" }, { "name": "Reverse", "type": "boolean", "required": false, "description": "获取实例的排序方向。枚举值如下： false=正序（默认） true=倒序", "example": "true" }, { "name": "RenewFlagList", "type": "array", "required": false, "description": "续费标识。多个值用英文逗号分隔。枚举值如下： NOTIFY_AND_MANUAL_RENEW：手动续费 NOTIFY_AND_AUTO_RENEW：自动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW：到期不续", "example": "[\"DISABLE_NOTIFY_AND_MANUAL_RENEW\"]", "item_type": "string" }, { "name": "InstanceIdList", "type": "array", "required": false, "description": "实例ID。多个ID用英文逗号分隔，最多不超过100个。", "example": "[\"std_storage-20241106185002290002691-0\"]", "item_type": "string" }, { "name": "ExpireTimeStart", "type": "string", "required": false, "description": "到期时间段起，格式为yyyy-MM-dd HH:mm:ss。", "example": "2025-06-26 00:38:46" }, { "name": "ExpireTimeEnd", "type": "string", "required": false, "description": "到期时间段止，格式为yyyy-MM-dd HH:mm:ss。", "example": "2025-09-27 15:38:46" } ], "required": [ "MaxResults" ] }, { "name": "DescribeSavingPlanResourceInfo", "description": "查询节省计划详情", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "数量，最大值为100", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量", "example": "1" }, { "name": "CreateStartDate", "type": "string", "required": false, "description": "购买开始时间，格式yyyy-MM-dd", "example": "2023-06-01" }, { "name": "CreateEndDate", "type": "string", "required": false, "description": "购买结束时间，格式yyyy-MM-dd", "example": "2023-06-30" } ], "required": [ "Limit", "Offset" ] }, { "name": "DescribeTagList", "description": "获取分账标签", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "数量，最大值为1000", "example": "3" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页偏移量，Offset=0表示第一页，如果Limit=100，则Offset=100表示第二页，Offset=200表示第三页，依次类推", "example": "0" }, { "name": "TagKey", "type": "string", "required": false, "description": "分账标签键，用作模糊搜索", "example": "运营部门" }, { "name": "Status", "type": "integer", "required": false, "description": "标签类型，枚举值：0普通标签，1分账标签，用作筛选，不传获取全部标签键", "example": "0" }, { "name": "OrderType", "type": "string", "required": false, "description": "排序方式，枚举值：asc排升序，desc排降序", "example": "asc" } ], "required": [ "Limit", "Offset" ] }, { "name": "DescribeVoucherInfo", "description": "获取代金券相关信息", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "一页多少条数据，默认是20条，最大不超过1000", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "第多少页，默认是1", "example": "1" }, { "name": "Status", "type": "string", "required": false, "description": "券状态：待使用：unUsed，已使用： used，已发货：delivered，已作废： cancel，已过期：overdue", "example": "unUsed" }, { "name": "VoucherId", "type": "string", "required": false, "description": "代金券id", "example": "FIQJQDYJLMA221ZFOGJ81R" }, { "name": "CodeId", "type": "string", "required": false, "description": "代金券订单id", "example": "20230627799000283860282011" }, { "name": "ProductCode", "type": "string", "required": false, "description": "商品码", "example": "p_cvm" }, { "name": "ActivityId", "type": "string", "required": false, "description": "活动id", "example": "570" }, { "name": "VoucherName", "type": "string", "required": false, "description": "代金券名称", "example": "代金券二期现金券" }, { "name": "TimeFrom", "type": "string", "required": false, "description": "发放开始时间,例：2021-01-01", "example": "2021-01-01" }, { "name": "TimeTo", "type": "string", "required": false, "description": "发放结束时间，例：2021-01-01", "example": "2021-01-01" }, { "name": "SortField", "type": "string", "required": false, "description": "指定排序字段：BeginTime开始时间、EndTime到期时间、CreateTime创建时间", "example": "BeginTime" }, { "name": "SortOrder", "type": "string", "required": false, "description": "指定升序降序：desc、asc", "example": "desc" }, { "name": "PayMode", "type": "string", "required": false, "description": "付费模式，postPay后付费/prePay预付费/riPay预留实例/\"\"或者\"*\"表示全部模式，如果payMode为\"\"或\"*\"，那么productCode与subProductCode必须传空", "example": "postPay" }, { "name": "PayScene", "type": "string", "required": false, "description": "付费场景PayMode=postPay时：spotpay-竞价实例,\"settle account\"-普通后付费PayMode=prePay时：purchase-包年包月新购，renew-包年包月续费（自动续费），modify-包年包月配置变更(变配）PayMode=riPay时：oneOffFee-预留实例预付，hourlyFee-预留实例每小时扣费，*-支持全部付费场景", "example": "postPay" }, { "name": "Operator", "type": "string", "required": false, "description": "操作人，默认就是用户uin", "example": "700000866965" }, { "name": "VoucherMainType", "type": "string", "required": false, "description": "代金券主类型 has_price 为有价现金券 no_price 为无价代金券", "example": "no_price" }, { "name": "VoucherSubType", "type": "string", "required": false, "description": "代金券副类型 discount 为折扣券 deduct 为抵扣券", "example": "discount" }, { "name": "StartTimeFrom", "type": "string", "required": false, "description": "券有效时间开始时间", "example": "2021-01-01" }, { "name": "StartTimeTo", "type": "string", "required": false, "description": "券有效时间结束时间", "example": "2021-01-01" }, { "name": "EndTimeFrom", "type": "string", "required": false, "description": "券失效时间开始时间", "example": "2021-01-01" }, { "name": "EndTimeTo", "type": "string", "required": false, "description": "券失效时间结束时间", "example": "2021-01-01" }, { "name": "CreateTimeFrom", "type": "string", "required": false, "description": "发券时间开始时间", "example": "2021-01-01" }, { "name": "CreateTimeTo", "type": "string", "required": false, "description": "发券时间结束时间", "example": "2021-01-01" } ], "required": [ "Limit", "Offset" ] }, { "name": "DescribeVoucherUsageDetails", "description": "获取代金券使用记录", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "一页多少条数据，默认是20条，最大不超过1000", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "第多少页，默认是1", "example": "1" }, { "name": "VoucherId", "type": "string", "required": true, "description": "代金券id", "example": "FIQJQDYJLMA221ZFOGJ81R" }, { "name": "Operator", "type": "string", "required": false, "description": "操作人，默认就是用户uin", "example": "700000866965" } ], "required": [ "Limit", "Offset", "VoucherId" ] }, { "name": "ModifyAllocationRule", "description": "编辑公摊规则", "status": "online", "parameters": [ { "name": "RuleId", "type": "integer", "required": true, "description": "所编辑公摊规则ID", "example": "12" }, { "name": "Name", "type": "string", "required": true, "description": "编辑后公摊规则名称", "example": "规则名称" }, { "name": "Type", "type": "integer", "required": true, "description": "公摊策略类型，枚举值如下： 1 - 自定义分摊占比 2 - 等比分摊 3 - 按占比分摊", "example": "1" }, { "name": "RuleDetail", "type": "object", "required": true, "description": "编辑后公摊规则表达式", "example": "无", "children": [ { "name": "RuleKey", "type": "string", "required": false, "description": "RuleKey：分账维度 枚举值： ownerUin - 使用者UIN, operateUin - 操作者UIN, businessCode - 产品一层编码, productCode - 产品二层编码, itemCode - 产品四层编码, projectId - 项目ID, regionId - 地域ID, resourceId - 资源ID, tag - 标签键值对, payMode - 计费模式, instanceType - 实例类型, actionType - 交易类型", "example": "businessCode" }, { "name": "Operator", "type": "string", "required": false, "description": "分账维度规则 枚举值： in - 是 not in - 不是", "example": "=" }, { "name": "RuleValue", "type": "array", "required": false, "description": "分账维度值，例如当RuleKey为businessCode时，[\"p_cbs\",\"p_sqlserver\"]表示产品一层是\"p_cbs\",\"p_sqlserver\"的费用", "example": "[\"p_cbs\",\"p_sqlserver\"]", "item_type": "string" }, { "name": "Connectors", "type": "string", "required": false, "description": "分账逻辑连接词，枚举值如下： and - 且 or - 或", "example": "and" }, { "name": "Children", "type": "array", "required": false, "description": "嵌套规则", "example": "无", "item_type": "object", "children": [ { "name": "RuleKey", "type": "string", "required": false, "description": "RuleKey：分账维度 枚举值： ownerUin - 使用者UIN, operateUin - 操作者UIN, businessCode - 产品一层编码, productCode - 产品二层编码, itemCode - 产品四层编码, projectId - 项目ID, regionId - 地域ID, resourceId - 资源ID, tag - 标签键值对, payMode - 计费模式, instanceType - 实例类型, actionType - 交易类型", "example": "businessCode" }, { "name": "Operator", "type": "string", "required": false, "description": "分账维度规则 枚举值： in - 是 not in - 不是", "example": "=" }, { "name": "RuleValue", "type": "array", "required": false, "description": "分账维度值，例如当RuleKey为businessCode时，[\"p_cbs\",\"p_sqlserver\"]表示产品一层是\"p_cbs\",\"p_sqlserver\"的费用", "example": "[\"p_cbs\",\"p_sqlserver\"]", "item_type": "string" }, { "name": "Connectors", "type": "string", "required": false, "description": "分账逻辑连接词，枚举值如下： and - 且 or - 或", "example": "and" }, { "name": "Children", "type": "array", "required": false, "description": "嵌套规则", "example": "无", "item_type": "object", "children": [ { "name": "RuleKey", "type": "string", "required": false, "description": "RuleKey：分账维度 枚举值： ownerUin - 使用者UIN, operateUin - 操作者UIN, businessCode - 产品一层编码, productCode - 产品二层编码, itemCode - 产品四层编码, projectId - 项目ID, regionId - 地域ID, resourceId - 资源ID, tag - 标签键值对, payMode - 计费模式, instanceType - 实例类型, actionType - 交易类型", "example": "businessCode" }, { "name": "Operator", "type": "string", "required": false, "description": "分账维度规则 枚举值： in - 是 not in - 不是", "example": "=" }, { "name": "RuleValue", "type": "array", "required": false, "description": "分账维度值，例如当RuleKey为businessCode时，[\"p_cbs\",\"p_sqlserver\"]表示产品一层是\"p_cbs\",\"p_sqlserver\"的费用", "example": "[\"p_cbs\",\"p_sqlserver\"]", "item_type": "string" }, { "name": "Connectors", "type": "string", "required": false, "description": "分账逻辑连接词，枚举值如下： and - 且 or - 或", "example": "and" }, { "name": "Children", "type": "array", "required": false, "description": "嵌套规则", "example": "无", "item_type": "string" } ] } ] } ] }, { "name": "RatioDetail", "type": "array", "required": false, "description": "编辑后公摊比例表达式", "example": "无", "item_type": "object", "children": [ { "name": "NodeId", "type": "integer", "required": true, "description": "公摊规则所属分账单元ID", "example": "11" }, { "name": "Ratio", "type": "float", "required": true, "description": "分账单元所占公摊比例，按占比分摊传0", "example": "40.51" } ] }, { "name": "Month", "type": "string", "required": false, "description": "月份，不传默认当前月", "example": "2022-10-01 00:00:00" } ], "required": [ "RuleId", "Name", "Type", "RuleDetail" ] }, { "name": "ModifyAllocationUnit", "description": "修改分账单元信息", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "所修改分账单元ID", "example": "1" }, { "name": "Name", "type": "string", "required": false, "description": "修改后分账单元名称", "example": "财务部" }, { "name": "SourceName", "type": "string", "required": false, "description": "修改后分账单元源组织名称", "example": "财务一组" }, { "name": "SourceId", "type": "string", "required": false, "description": "修改后分账单元源组织ID", "example": "asd123" }, { "name": "Remark", "type": "string", "required": false, "description": "分账单元备注说明", "example": "分账" }, { "name": "Month", "type": "string", "required": false, "description": "月份，不传默认当前月", "example": "2022-10-01 00:00:00" } ], "required": [ "Id" ] }, { "name": "ModifyBudget", "description": "更新预算信息", "status": "online", "parameters": [ { "name": "BudgetId", "type": "string", "required": true, "description": "预算项目id", "example": "1233456" }, { "name": "BudgetName", "type": "string", "required": true, "description": "预算名称", "example": "API创建预算计划" }, { "name": "CycleType", "type": "string", "required": true, "description": "DAY 天，MONTH 月度，QUARTER 季度 ，YEAR 年度", "example": "DAY" }, { "name": "PeriodBegin", "type": "string", "required": true, "description": "有效期起始时间 2025-01-01", "example": "2025-01-01" }, { "name": "PeriodEnd", "type": "string", "required": true, "description": "有效期结束时间 2025-12-01", "example": "2025-12-01" }, { "name": "PlanType", "type": "string", "required": true, "description": "FIX 固定值，CYCLE 不同值", "example": "FIX" }, { "name": "BudgetQuota", "type": "string", "required": true, "description": "预算值额度 预算计划类型固定预算时设为定值； 预算计划类型为CYCLE(计划预算)时传[{\"dateDesc\":\"2025-07\",\"quota\":\"1000\"},{\"dateDesc\":\"2025-08\",\"quota\":\"2000\"}]；", "example": "1200" }, { "name": "BillType", "type": "string", "required": true, "description": "BILL 系统账单，CONSUMPTION 消耗账单", "example": "BILL" }, { "name": "FeeType", "type": "string", "required": true, "description": "COST 原价，REAL_COST 实际费用，CASH 现金，INCENTIVE 赠送金，VOUCHER 代金券，TRANSFER 分成金，TAX 税，AMOUNT_BEFORE_TAX 现金支付(税前)", "example": "COST" }, { "name": "WarnJson", "type": "array", "required": true, "description": "阈值提醒", "example": "无", "item_type": "object", "children": [ { "name": "WarnType", "type": "string", "required": true, "description": "ACTUAL 实际金额， FORECAST 预测金额", "example": "ACTUAL" }, { "name": "CalType", "type": "string", "required": true, "description": "PERCENTAGE 预算金额的百分比，ABS 固定值", "example": "PERCENTAGE" }, { "name": "ThresholdValue", "type": "string", "required": true, "description": "阈值（大于等于0）", "example": "100" } ] }, { "name": "BudgetNote", "type": "string", "required": false, "description": "预算备注", "example": "使用api创建预算信息" }, { "name": "DimensionsRange", "type": "object", "required": false, "description": "预算维度范围条件", "example": "无", "children": [ { "name": "Business", "type": "array", "required": false, "description": "产品 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"p_cvm\"]", "item_type": "string" }, { "name": "PayMode", "type": "array", "required": false, "description": "计费模式 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"postPay\"]", "item_type": "string" }, { "name": "ProductCodes", "type": "array", "required": false, "description": "子产品 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"sp_cvm\"]", "item_type": "string" }, { "name": "ComponentCodes", "type": "array", "required": false, "description": "组件编码 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"v_cpu\"]", "item_type": "string" }, { "name": "ZoneIds", "type": "array", "required": false, "description": "地域 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"10001\"]", "item_type": "string" }, { "name": "RegionIds", "type": "array", "required": false, "description": "可用区 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"47\"]", "item_type": "string" }, { "name": "ProjectIds", "type": "array", "required": false, "description": "项目 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"0\"]", "item_type": "string" }, { "name": "ActionTypes", "type": "array", "required": false, "description": "交易类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"postpay_deduct_d\"]", "item_type": "string" }, { "name": "ConsumptionTypes", "type": "array", "required": false, "description": "消耗类型 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"prepay_purchase\"]", "item_type": "string" }, { "name": "Tags", "type": "array", "required": false, "description": "标签 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "key 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "TagValue", "type": "array", "required": false, "description": "value 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "PayerUins", "type": "array", "required": false, "description": "末级分账单元 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"1197623846\"]", "item_type": "string" }, { "name": "OwnerUins", "type": "array", "required": false, "description": "主用户Uin 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"1197623846\"]", "item_type": "string" }, { "name": "TreeNodeUniqKeys", "type": "array", "required": false, "description": "末级分账单元唯一键 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"1197623846\"]", "item_type": "string" } ] }, { "name": "WaveThresholdJson", "type": "array", "required": false, "description": "波动提醒", "example": "无", "item_type": "object", "children": [ { "name": "WarnType", "type": "string", "required": false, "description": "ACTUAL 实际金额，FORECAST 预测金额 注意：此字段可能返回 null，表示取不到有效值。", "example": "ACTUAL" }, { "name": "Threshold", "type": "string", "required": false, "description": "波动阈值（大于等于0） 注意：此字段可能返回 null，表示取不到有效值。", "example": "100" }, { "name": "MetaType", "type": "string", "required": false, "description": "告警类型：chain 环比，yoy 同比，fix 固定值 （支持类型：日环比 chain day，日同比周维度 chain weekday，日同比月维度 yoy day，日固定值 fix day，月环比 chain month，月固定值 fix month） 注意：此字段可能返回 null，表示取不到有效值。", "example": "chain" }, { "name": "PeriodType", "type": "string", "required": false, "description": "告警维度：day 日，month 月，weekday 周 （支持类型：日环比 chain day，日同比周维度 chain weekday，日同比月维度 yoy day，日固定值 fix day，月环比 chain month，月固定值 fix month） 注意：此字段可能返回 null，表示取不到有效值。", "example": "day" } ] } ], "required": [ "BudgetId", "BudgetName", "CycleType", "PeriodBegin", "PeriodEnd", "PlanType", "BudgetQuota", "BillType", "FeeType", "WarnJson" ] }, { "name": "ModifyGatherRule", "description": "编辑归集规则", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "所编辑归集规则ID", "example": "12" }, { "name": "RuleDetail", "type": "object", "required": true, "description": "所编辑分账规则详情", "example": "无", "children": [ { "name": "RuleKey", "type": "string", "required": false, "description": "RuleKey：分账维度 枚举值： ownerUin - 使用者UIN, operateUin - 操作者UIN, businessCode - 产品一层编码, productCode - 产品二层编码, itemCode - 产品四层编码, projectId - 项目ID, regionId - 地域ID, resourceId - 资源ID, tag - 标签键值对, payMode - 计费模式, instanceType - 实例类型, actionType - 交易类型", "example": "businessCode" }, { "name": "Operator", "type": "string", "required": false, "description": "分账维度规则 枚举值： in - 是 not in - 不是", "example": "=" }, { "name": "RuleValue", "type": "array", "required": false, "description": "分账维度值，例如当RuleKey为businessCode时，[\"p_cbs\",\"p_sqlserver\"]表示产品一层是\"p_cbs\",\"p_sqlserver\"的费用", "example": "[\"p_cbs\",\"p_sqlserver\"]", "item_type": "string" }, { "name": "Connectors", "type": "string", "required": false, "description": "分账逻辑连接词，枚举值如下： and - 且 or - 或", "example": "and" }, { "name": "Children", "type": "array", "required": false, "description": "嵌套规则", "example": "无", "item_type": "object", "children": [ { "name": "RuleKey", "type": "string", "required": false, "description": "RuleKey：分账维度 枚举值： ownerUin - 使用者UIN, operateUin - 操作者UIN, businessCode - 产品一层编码, productCode - 产品二层编码, itemCode - 产品四层编码, projectId - 项目ID, regionId - 地域ID, resourceId - 资源ID, tag - 标签键值对, payMode - 计费模式, instanceType - 实例类型, actionType - 交易类型", "example": "businessCode" }, { "name": "Operator", "type": "string", "required": false, "description": "分账维度规则 枚举值： in - 是 not in - 不是", "example": "=" }, { "name": "RuleValue", "type": "array", "required": false, "description": "分账维度值，例如当RuleKey为businessCode时，[\"p_cbs\",\"p_sqlserver\"]表示产品一层是\"p_cbs\",\"p_sqlserver\"的费用", "example": "[\"p_cbs\",\"p_sqlserver\"]", "item_type": "string" }, { "name": "Connectors", "type": "string", "required": false, "description": "分账逻辑连接词，枚举值如下： and - 且 or - 或", "example": "and" }, { "name": "Children", "type": "array", "required": false, "description": "嵌套规则", "example": "无", "item_type": "object", "children": [ { "name": "RuleKey", "type": "string", "required": false, "description": "RuleKey：分账维度 枚举值： ownerUin - 使用者UIN, operateUin - 操作者UIN, businessCode - 产品一层编码, productCode - 产品二层编码, itemCode - 产品四层编码, projectId - 项目ID, regionId - 地域ID, resourceId - 资源ID, tag - 标签键值对, payMode - 计费模式, instanceType - 实例类型, actionType - 交易类型", "example": "businessCode" }, { "name": "Operator", "type": "string", "required": false, "description": "分账维度规则 枚举值： in - 是 not in - 不是", "example": "=" }, { "name": "RuleValue", "type": "array", "required": false, "description": "分账维度值，例如当RuleKey为businessCode时，[\"p_cbs\",\"p_sqlserver\"]表示产品一层是\"p_cbs\",\"p_sqlserver\"的费用", "example": "[\"p_cbs\",\"p_sqlserver\"]", "item_type": "string" }, { "name": "Connectors", "type": "string", "required": false, "description": "分账逻辑连接词，枚举值如下： and - 且 or - 或", "example": "and" }, { "name": "Children", "type": "array", "required": false, "description": "嵌套规则", "example": "无", "item_type": "string" } ] } ] } ] }, { "name": "Month", "type": "string", "required": false, "description": "月份，不传默认当前月", "example": "2022-10-01 00:00:00" } ], "required": [ "Id", "RuleDetail" ] }, { "name": "PayDeals", "description": "支付订单", "status": "online", "parameters": [ { "name": "OrderIds", "type": "array", "required": false, "description": "需要支付的一个或者多个子订单号，与BigDealIds字段两者必须且仅传一个参数", "example": "[\"20210205659001519515911\"]", "item_type": "string" }, { "name": "AutoVoucher", "type": "integer", "required": false, "description": "是否自动使用代金券,1:是,0否,默认0", "example": "0" }, { "name": "VoucherIds", "type": "array", "required": false, "description": "代金券ID列表,目前仅支持指定一张代金券", "example": "[\"MGIFGZNWEMGUS0BW0N1KTN\"]", "item_type": "string" }, { "name": "BigDealIds", "type": "array", "required": false, "description": "需要支付的一个或者多个大订单号，与OrderIds字段两者必须且仅传一个参数", "example": "[\"20210205659001519515911\"]", "item_type": "string" }, { "name": "AgentPay", "type": "integer", "required": false, "description": "0非代理，1代理商代付，3集团代理，4代理商为代客下产品级代付单，默认0", "example": "0" }, { "name": "CpsUin", "type": "string", "required": false, "description": "推荐者，用于返利", "example": "100003186505" } ], "required": [] }, { "name": "RefundInstance", "description": "退订不再需要的实例，只退还实付金额的部分，已使用的代金券不退还，退还的实付金额默认退到腾讯云账户余额中。调用该接口的账号需要授予finace:RefundInstance的权限，否则无法支付成功。目前已接入并支持退订的产品包括：T-Sec-Web应用防火墙、云防火墙、主机安全、主机容器、云安全中心、T-Sec-密钥管理系统。", "status": "online", "parameters": [ { "name": "ClientToken", "type": "string", "required": true, "description": "ClientToken是一个由客户端生成的唯一的、区分大小写、不超过64个ASCII字符的字符串。例如，ClientToken=123e4567-e89b-12d3-a456-42665544****。", "example": "c015c8ce-3698-4cd2-865b-7959fe15a705" }, { "name": "ProductCode", "type": "string", "required": true, "description": "产品一层code", "example": "p_yunjing" }, { "name": "SubProductCode", "type": "string", "required": true, "description": "产品二层code", "example": "sp_yunjing_vas" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例id", "example": "********" }, { "name": "RegionCode", "type": "string", "required": true, "description": "地域code", "example": "ap-guangzhou" } ], "required": [ "ClientToken", "ProductCode", "SubProductCode", "InstanceId", "RegionCode" ] }, { "name": "RenewInstance", "description": "续费一台实例，调用该接口续费服务器时，您需要确保您的腾讯云账户余额充足，否则会续费失败。调用该接口的账号需要授予finace:trade的权限，否则无法续费成功。目前已接入并支持续费的产品包括：T-Sec-Web应用防火墙、云防火墙、主机安全、主机容器、云安全中心、T-Sec-密钥管理系统。", "status": "online", "parameters": [ { "name": "ClientToken", "type": "string", "required": true, "description": "ClientToken是一个由客户端生成的唯一的、区分大小写、不超过64个ASCII字符的字符串。例如，ClientToken=123e4567-e89b-12d3-a456-42665544****。", "example": "c015c8ce-3698-4cd2-865b-7959fe15a705" }, { "name": "ProductCode", "type": "string", "required": true, "description": "产品一层code", "example": "p_yunjing" }, { "name": "SubProductCode", "type": "string", "required": true, "description": "产品二层code", "example": "sp_yunjing_vas" }, { "name": "RegionCode", "type": "string", "required": true, "description": "地域code", "example": "ap-guangzhou" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "********" }, { "name": "Period", "type": "integer", "required": false, "description": "手动续费时长，取值上限：36，默认取值1", "example": "1" }, { "name": "PeriodUnit", "type": "string", "required": false, "description": "手动续费时长单位，取值：m：按月续费，y：按年续费，默认取值m", "example": "m" } ], "required": [ "ClientToken", "ProductCode", "SubProductCode", "RegionCode", "InstanceId" ] }, { "name": "SetRenewal", "description": "注意事项： 1、本接口支持对包年包月实例设置自动续费模式及周期 2、可通过实例查询接口获取到产品编码、地域编码 3、子用户使用该接口时，应具备QcloudFinanceRenewManageFullAccess权限策略。", "status": "online", "parameters": [ { "name": "ProductCode", "type": "string", "required": true, "description": "产品编码。", "example": "p_cos" }, { "name": "RegionCode", "type": "string", "required": true, "description": "地域编码。", "example": "ap-others" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，仅支持指定一个。", "example": "std_storage-20240902185001827926251-1" }, { "name": "RenewFlag", "type": "string", "required": true, "description": "续费标识。枚举值如下： NOTIFY_AND_MANUAL_RENEW：手动续费 NOTIFY_AND_AUTO_RENEW：自动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW：到期不续", "example": "NOTIFY_AND_MANUAL_RENEW" }, { "name": "RenewPeriod", "type": "string", "required": false, "description": "自动续费周期长度，不填写时默认按产品侧设置的默认值 如果是月，支持：1-11 如果是年，支持：1-5 实际按产品侧支持的范围为主", "example": "3" }, { "name": "RenewPeriodUnit", "type": "string", "required": false, "description": "自动续费周期单位，不填写时默认按产品侧设置的默认值 y 年，m 月 实际按产品侧支持的范围为主", "example": "m" } ], "required": [ "ProductCode", "RegionCode", "InstanceId", "RenewFlag" ] } ] }