1. 接口描述
接口请求域名: tcb.tencentcloudapi.com 。
获取云开发环境的计费相关信息。
包括环境的 状态、当前套餐、购买时间、到期时间 等。
默认接口请求频率限制:50次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeBillingInfo。 |
| Version | 是 | String | 公共参数,本接口取值:2018-06-08。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| EnvId | 否 | String | 环境ID 示例值:env-xxyyzzaa |
| EnvIds.N | 否 | Array of String | 环境列表,当环境列表不为空时,查询的环境以该参数为准 示例值:["stress10new0060000zd-d1a82f617e3"] |
| Limit | 否 | Integer | 每页条数(用于拉取列表时分页) 示例值:1000 |
| Offset | 否 | Integer | 偏移 示例值:50 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| EnvBillingInfoList | Array of EnvBillingInfoItem | 环境计费信息列表 |
| Total | Integer | 总个数 示例值:1000 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 分批查询计费信息
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBillingInfo
<公共请求参数>
{
"Limit": 1000,
"Offset": 30
}
输出示例
{
"Response": {
"EnvBillingInfoList": [
{
"CreateTime": "2021-01-20 21:18:09",
"EnableOverrun": false,
"EnvActivated": "no",
"EnvCharged": "yes",
"EnvId": "carol-test-sms-6g7zpok6eb41cdfe",
"ExpireTime": "0000-00-00 00:00:00",
"ExtPackageType": "",
"FreeQuota": "free",
"IsAlwaysFree": false,
"IsAutoRenew": false,
"IsolatedTime": "2022-10-25 15:42:53",
"OrderInfo": {
"CreateTime": "2021-01-20 21:17:53",
"ExtensionId": "",
"Flag": "",
"PackageId": "",
"PayMode": "POSTPAID",
"ReqBody": "",
"ResourceReady": "",
"TranId": "20210120789001256921351",
"TranStatus": "4",
"TranType": "5",
"UpdateTime": "2021-01-20 21:19:40"
},
"PackageId": "",
"PayMode": "POSTPAID",
"PaymentChannel": "qcloud",
"Status": "ISOLATE",
"UpdateTime": "2022-10-25 15:42:53"
}
],
"Total": 10000,
"RequestId": "cf7490af-821b-4d33-94a2-0337a67f5910"
}
}
示例2 查询环境列表的计费信息
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBillingInfo
<公共请求参数>
{
"EnvIds": [
"stress10new0059998or-d3aa7adb44f"
]
}
输出示例
{
"Response": {
"EnvBillingInfoList": [
{
"CreateTime": "2026-05-15 15:56:43",
"EnableOverrun": false,
"EnvActivated": "no",
"EnvCharged": "yes",
"EnvId": "stress10new0059998or-d3aa7adb44f",
"ExpireTime": "2026-11-15 23:59:59",
"ExtPackageType": "baas",
"FreeQuota": "",
"IsAlwaysFree": false,
"IsAutoRenew": false,
"IsolatedTime": "0000-00-00 00:00:00",
"OrderInfo": {
"CreateTime": "",
"ExtensionId": "",
"Flag": "",
"PackageId": "",
"PayMode": "",
"ReqBody": "",
"ResourceReady": "",
"TranId": "",
"TranStatus": "",
"TranType": "",
"UpdateTime": ""
},
"PackageId": "baas_trial",
"PayMode": "PREPAYMENT",
"PaymentChannel": "miniapp",
"Status": "NORMAL",
"UpdateTime": "2026-05-15 15:56:43"
}
],
"Total": 10000,
"RequestId": "68c26a28-5c00-4730-b701-5a7bc1981eae"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| MissingParameter | 缺少参数错误。 |
| MissingParameter.Param | 缺少必要参数。 |
| ResourceUnavailable | 资源不可用。 |