1. 接口描述
接口请求域名: billing.tencentcloudapi.com 。
查询当前用户节省计划覆盖率明细数据,如无特别说明,金额单位均为元(国内站)或者美元(国际站)。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeSavingPlanCoverage。 |
Version | 是 | String | 公共参数,本接口取值:2018-07-09。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
StartDate | 是 | String | 费用起始日期,格式yyyy-MM-dd 示例值:2023-06-01 |
EndDate | 是 | String | 费用结束日期,格式yyyy-MM-dd 示例值:2023-06-30 |
Offset | 是 | Integer | 分页偏移量,Offset=0表示第一页,如果Limit=100,则Offset=100表示第二页,Offset=200表示第三页,以此类推 示例值:0 |
Limit | 是 | Integer | 数量,最大值为200 示例值:200 |
PeriodType | 否 | Integer | 取值包括1(缺省值)和2,1表示按天统计覆盖率,2表示按月统计覆盖率,此参数仅影响返回的RateSet聚合粒度,不影响返回的DetailSet 示例值:1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DetailSet | Array of SavingPlanCoverageDetail | 节省计划覆盖率明细数据 |
RateSet | Array of SavingPlanCoverageRate | 节省计划覆盖率聚合数据 |
TotalCount | Integer | 查询命中的节省计划覆盖率明细数据总条数 示例值:1000 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询节省计划覆盖率数据
查询节省计划覆盖率数据
输入示例
POST / HTTP/1.1
Host: billing.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSavingPlanCoverage
<公共请求参数>
{
"PeriodType": 1,
"StartDate": "2023-06-01",
"EndDate": "2023-07-01",
"Offset": 0,
"Limit": 2
}
输出示例
{
"Response": {
"DetailSet": [
{
"EndDate": "2023-06-13",
"ExpectedAmount": 99.01,
"ProductCode": "p_trade_t_s",
"RegionId": 1,
"ResourceId": "0140051917592",
"SpCoverage": 0,
"SpCoveredAmount": 0,
"SpUncoveredAmount": 99.01,
"StartDate": "2023-06-13",
"SubProductCode": "sp_trade_t_s",
"TotalRealAmount": 99.01
},
{
"EndDate": "2023-06-13",
"ExpectedAmount": 99.01,
"ProductCode": "p_trade_t_s",
"RegionId": 1,
"ResourceId": "0140053056082",
"SpCoverage": 0,
"SpCoveredAmount": 0,
"SpUncoveredAmount": 99.01,
"StartDate": "2023-06-13",
"SubProductCode": "sp_trade_t_s",
"TotalRealAmount": 99.01
}
],
"RateSet": [
{
"DatePoint": "2023-06-07",
"Rate": 0
},
{
"DatePoint": "2023-06-13",
"Rate": 0
},
{
"DatePoint": "2023-06-14",
"Rate": 0
}
],
"RequestId": "a0041c91-65c3-4552-8802-f073cfed0202",
"TotalCount": 6
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError.UnknownError | 未定义异常。 |
UnauthorizedOperation.CamNoAuth | 账号没有cam授权。 |