1. 接口描述
接口请求域名: tcb.tencentcloudapi.com 。
查询平台版资源信息列表,返回信息包括
1.平台版基础信息如资源id,所属地域等;
2.计费相关信息如:购买/过期时间,资源规格,计费状态等;
3.底层资源信息如:存储,日志,静态托管等资源信息等;
入参支持platformIds,可查询指定平台版套餐信息
影响范围:查询接口,返回当前用户账号下平台版资源信息
使用场景:控制台展示平台版套餐信息/查平台版资源详情/资源状态
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribePlatforms。 |
| Version | 是 | String | 公共参数,本接口取值:2018-06-08。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| PlatformIds.N | 否 | Array of String | 平台版套餐id列表 默认值:若不指定,则分页返回当前账号下所有平台版资源 示例值:["pf-2v4plhx1ph2bq"] |
| Limit | 否 | Integer | 分页限制 取值范围:[10, 100] 默认值:10 示例值:10 |
| Offset | 否 | Integer | 分页偏移量 默认值:0 示例值:5 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| PlatformList | Array of PlatformInfo | 平台版资源列表 |
| Total | Integer | 总数 示例值:13 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询指定平台版资源信息
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePlatforms
<公共请求参数>
{
"PlatformIds": [
"pf-2v4plhx1ph2bq"
]
}
输出示例
{
"Response": {
"PlatformList": [
{
"Alias": "",
"BillStatus": "normal",
"BillTime": "2026-09-08 21:26:03",
"ExpireTime": "2026-10-08 23:59:59",
"IsAutoRenew": 0,
"PackageId": "default",
"PlatformId": "pf-2v4plhx1ph2bq",
"Region": "ap-shanghai",
"Resources": [
{
"Detail": "{\"Bucket\":\"b5c5-static-pf-2v4plhx1ph2bq-1258467748\",\"PolicyId\":285688480,\"Region\":\"ap-shanghai\"}",
"Id": 84,
"PlatformId": 30,
"ResName": "b5c5-static-pf-2v4plhx1ph2bq-1258467748",
"ResType": "hosting",
"Status": 0
}
],
"Spec": "{\"credits\":6000,\"envNum\":60}",
"Status": 0
}
],
"Total": 1,
"RequestId": "db08ab1f-fa4b-4c52-bc4d-09149ac24d40"
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。