1. 接口描述
接口请求域名: billing.tencentcloudapi.com 。
注意事项:
1、本接口支持查询已接入续费管理页的包年包月实例,包括运行中、已隔离(部分产品不支持)
2、子用户使用该接口时,应具备QcloudFinanceRenewManageFullAccess权限策略。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeRenewInstances。 |
| Version | 是 | String | 公共参数,本接口取值:2018-07-09。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| MaxResults | 是 | Integer | 每页的最大实例条数。 取值范围:1~100。 示例值:10 |
| NextToken | 否 | String | 查询返回结果下一页的令牌。首次调用 API 不需要NextToken。 示例值:VDAwMSu3Y69lZhLwW1bRxLiwKafWBv_6TqKBnp-YH12b0uWcwTBf3DIK7Myza6EVdhDKoFGpKANnZkfmmLy5K8uH1lJYqyvuT_mSXc8VoOdX-8kcKJrB3JbyW9dM0edrKm3Q |
| Reverse | 否 | Boolean | 获取实例的排序方向。枚举值如下: false=正序(默认) true=倒序 示例值:true |
| RenewFlagList.N | 否 | Array of String | 续费标识。多个值用英文逗号分隔。枚举值如下: NOTIFY_AND_MANUAL_RENEW:手动续费 NOTIFY_AND_AUTO_RENEW:自动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW:到期不续 示例值:["DISABLE_NOTIFY_AND_MANUAL_RENEW"] |
| InstanceIdList.N | 否 | Array of String | 实例ID。多个ID用英文逗号分隔,最多不超过100个。 示例值:["std_storage-20241106185002290002691-0"] |
| ExpireTimeStart | 否 | String | 到期时间段起,格式为yyyy-MM-dd HH:mm:ss。 示例值:2025-06-26 00:38:46 |
| ExpireTimeEnd | 否 | String | 到期时间段止,格式为yyyy-MM-dd HH:mm:ss。 示例值:2025-09-27 15:38:46 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| InstanceList | Array of RenewInstance | 实例汇总列表。 |
| NextToken | String | 查询返回结果下一页的令牌。 注意:此字段可能返回 null,表示取不到有效值。 示例值:VDAwMSu3Y69lZhLwW1bRxLiwKafWBv_6TqKBnp-YH12b0uWcwTBf3DIK7Myza6EVdhDKoFGpKANnZkfmmLy5K8uH1lJYqyvuT_mSXc8VoOdX-8kcKJrB3JbyW9dM0edrKm3Q |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例 1
输入示例
POST / HTTP/1.1
Host: billing.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRenewInstances
<公共请求参数>
{
"MaxResults": 10,
"NextToken": "VDAwMSu3Y69lZhLwW1bRxLiwKafWBv_6TqKBnp-YH12b0uWcwTBf3DIK7Myza6EVdhDKoFGpKANnZkfmmLy5K8uH1lJYqyvuT_mSXc8VoOdX-8kcKJrB3JbyW9dM0edrKm3Q",
"Reverse": true,
"RenewFlagList": [
"DISABLE_NOTIFY_AND_MANUAL_RENEW"
],
"InstanceIdList": [
"std_storage-20241106185002290002691-0"
],
"ExpireTimeStart": "2025-06-26 00:38:46",
"ExpireTimeEnd": "2025-09-27 15:38:46"
}
输出示例
{
"Response": {
"InstanceList": [
{
"ExpireTime": "2025-07-06 23:59:59",
"InstanceId": "std_storage-20241106185002290002691-0",
"InstanceName": "",
"ProductCode": "p_cos",
"ProductName": "COS u5bf9u8c61u5b58u50a8",
"ProjectName": "u9ed8u8ba4u9879u76ee",
"RegionCode": "ap-others",
"RenewFlag": "DISABLE_NOTIFY_AND_MANUAL_RENEW",
"RenewPeriod": 1,
"RenewPeriodUnit": "m",
"Status": "NORMAL",
"SubProductCode": "sp_cos_pkg_std_new"
}
],
"NextToken": null,
"RequestId": "6e1a3451-b75c-4d7d-bbbd-e363682ab0af"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。