1. 接口描述
接口请求域名: bill.api3.gsesgpucloud.com。
获取按资源汇总数据
默认接口请求频率限制:20次/秒。
接口更新时间:2024-08-01 17:06:27。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 | 
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeBillSummaryByResourceGateway | 
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-10-25 | 
| Region | 是 | 否 | String | 公共参数,地域信息本接口不需要传递此参数。 | 
| PayerUin | 是 | 否 | String | 查询账单数据的用户UIN 示例值: 100004603015  | 
| BeginTime | 是 | 否 | String | 目前只支持传当月开始,且必须和EndTime为相同月份,例 2018-09-01 00:00:00 示例值: 2018-10-24 10:00:00  | 
| EndTime | 是 | 否 | String | 目前只支持传当月结束,且必须和BeginTime为相同月份,例 2018-09-30 23:59:59 示例值: 2018-10-24 10:00:00  | 
| Limit | 是 | 否 | Uint64 | 每次获取数据量 示例值: 20  | 
| Offset | 是 | 否 | Uint64 | 偏移量 示例值: 0  | 
| NeedRecordNum | 否 | 否 | Uint64 | 是否需要记录总数,0不需要,1需要 示例值: 1  | 
| NeedConditionValue | 否 | 否 | Uint64 | 是否需要过滤条件,0需要,1不需要 示例值: 1  | 
| Conditions | 否 | 否 | Conditions | 只支持BusinessCodes,ProductCodes,PayModes, ProjectIds, RegionIds, PayModes, ActionTypes, HideFreeCost, ResourceKeyword, OrderByCost 示例值:查看  | 
3. 输出参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| Ready | Uint64 | 数据是否准备好,0未准备好,1准备好 示例值: 1  | 
| Data | SummaryByResourceDataItem | 资源汇总详情 示例值:查看  | 
| Total | SummaryByResourceTotal | 资源汇总花费详情 示例值:查看  | 
| RecordNum | Uint64 | 记录数量,NeedRecordNum为0时该值为null 示例值: 1000  | 
| ConditionValue | SummaryByResourceConditionValue | 过滤条件,NeedConditionValue为0时该值为null 示例值:查看  | 
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 | 
4. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见公共错误码。