查询节省计划使用率明细-API 中心-腾讯云

1. 接口描述

接口请求域名： svp.tencentcloudapi.com 。

查用当前用户明细节省计划查询时段内的使用情况

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeSavingPlanUsage。
Version	是	String	公共参数，本接口取值：2024-01-25。
Region	是	String	公共参数，详见产品支持的地域列表。
StartDate	是	String	开始时间，格式yyyy-MM-dd 注：查询范围请勿超过6个月示例值：2023-06-01
EndDate	是	String	结束时间，格式yyyy-MM-dd 示例值：2023-06-30
Offset	是	Integer	分页偏移量示例值：0
Limit	是	Integer	每页数量，最大值为200 示例值：200
TimeInterval	是	String	查询结果数据的时间间隔示例值：daily:日 month：月

3. 输出参数

参数名称	类型	描述
Total	Integer	查询命中的节省计划总览明细数据总条数示例值：10
Usages	Array of SavingPlanUsageDetail	节省计划使用率数据注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询节省计划使用率明细示例

输入示例

POST / HTTP/1.1
Host: svp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSavingPlanUsage
<公共请求参数>

{
    "StartDate": "2024-03-01",
    "EndDate": "2024-05-01",
    "Offset": 0,
    "Limit": 1,
    "TimeInterval": "month"
}

输出示例

{
    "Response": {
        "RequestId": "626b5af9-5c9e-4ffb-ab6c-ec370b75a355",
        "Total": 1,
        "Usages": [
            {
                "CostAmount": "600",
                "DeductAmount": "600",
                "DosageAmount": "0",
                "LossAmount": "0",
                "NetSavings": "-600",
                "PromiseAmount": "600",
                "Region": [
                    "*"
                ],
                "SpType": "svp_common",
                "Status": 1,
                "UtilizationRate": 100
            }
        ]
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
UnauthorizedOperation.CamNoAuth	账号没有cam授权。