查询TPM配额信息详情
更新时间：2025-01-02
接口描述
本接口用于查询预置服务TPM配额信息。
注意事项
TPM配额预付费相关介绍，请参考TPM配额预付费。
权限说明
调用本文API，需符合以下权限要求，权限介绍及分配，请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限：
- 完全控制千帆大模型平台的权限：QianfanFullControlAccessPolicy
- 运维操作千帆大模型平台预测服务的权限：QianfanServiceOperateAccessPolicy
- 只读访问千帆大模型平台预测服务的权限：QianfanServiceReadAccessPolicy
鉴权说明
调用本文API，使用“基于安全认证AK/SK”进行签名计算鉴权，即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权，具体鉴权认证机制参考HTTP调用鉴权说明。
请求结构
POST /v2/charge?Action=DescribeTPMResource HTTP/1.1
Host: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json
{
"model":"ernie-4.0-8k",
"paymentTiming":"Postpaid",
"instanceId":"a0085162fxxxx0a49d19e58e"
}请求头域
除公共头域外，无其它特殊头域。
请求参数
- Query参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Action | string | 是 | 方法名称，固定值DescribeTPMResource |
- Body参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| model | string | 是 | 模型版本，可选值如下： · ernie-4.0-8k：模型版本为ERNIE-4.0-8K · ernie-4.0-8k-preview：模型版本为ERNIE-4.0-8K-Preview · ernie-4.0-turbo-8k：模型版本为ERNIE-4.0-Turbo-8K · ernie-4.0-turbo-8k-preview：模型版本为ERNIE-4.0-Turbo-8K-Preview · ernie-4.0-turbo-8k-0628：模型版本为：ERNIE-4.0-Turbo-8K-0628 · ernie-4.0-turbo-128k：模型版本为ERNIE-4.0-Turbo-128K · ernie-3.5-8k：模型版本为ERNIE-3.5-8K · ernie-3.5-8k-preview：模型版本为ERNIE-3.5-8K-Preview · ernie-3.5-128k：模型版本为ERNIE-3.5-128K · ernie-3.5-128k-preview：模型版本为ERNIE-3.5-128K-Preview · ernie-speed-8k：模型版本为ERNIE-Speed-8K · ernie-speed-128k：模型版本为ERNIE-Speed-128K · ernie-speed-pro-128k：模型版本为ERNIE-Speed-Pro-128K · ernie-lite-8k：模型版本为ERNIE-Lite-8K · ernie-lite-pro-128k：模型版本为ERNIE-Lite-Pro-128K · ernie-tiny-8k：模型版本为ERNIE-Tiny-8K · ernie-character-fiction-8k：模型版本为ERNIE-Character-Fiction-8K · ernie-char-8k：模型版本为ERNIE-Character-8K · ernie-novel-8k：模型版本为ERNIE-Novel-8K · ernie-speed-appbuilder-8k：模型版本为ERNIE-Speed-AppBuilder-8K · qianfan-agent-speed-8k：模型版本为Qianfan-Agent-Speed-8K · qianfan-agent-speed-32k：模型版本为Qianfan-Agent-Speed-32K · qianfan-agent-lite-8k：模型版本为Qianfan-Agent-Lite-8K |
| paymentTiming | string | 否 | 付费类型，说明： （1）如果不填写该参数，查询全部付费类型的配额 （2）如果填写该参数，查询特定付费类型的配额；目前为固定值Postpaid，表示查询后付费类型配额 |
| status | string | 否 | 付费类型，说明： （1）如果不填写该参数，查询全部资源状态的实例 （2）如果填写该参数，查询特定状态的实例，可选值如下： · Creating：创建中 · Running：使用中 · Stopped：已过期 |
| instanceId | string | 否 | 已购TPM配额对应的实例ID，该字段值通过调用购买TPM配额接口，返回的instanceId字段获取 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 名称 | 类型 | 描述 |
|---|---|---|
| requestId | string | 请求ID |
| result | object | 请求结果 |
result说明
| 名称 | 类型 | 描述 |
|---|---|---|
| instances | list<Object> | 实例列表 |
instances说明
| 名称 | 类型 | 描述 |
|---|---|---|
| instanceId | string | 实例ID |
| paymentTiming | string | 付费类型，说明： · Postpaid：后付费 · Prepaid：预付费 |
| rpm | int | 该实例包含的RPM |
| tpm | int | 该实例包含的TPM |
| status | string | 资源状态，说明： · Creating：创建中；从创建订单开始，实例资源处于创建中状态 · Running：使用中；从订单支付成功开始，实例资源处于使用中状态 · Stopped：已过期 |
| startTime | string | 开始时间，说明： · 当status是Creating时，该字段表示资源创建的时间 · 当status是Running或Stopped时，该字段表示资源开始使用的时间 |
| expiredTime | string | 到期时间，说明： · 如果实例资源已被终止，该字段值为到期时间 · 如果实例资源未被终止，该字段值为"-" |
请求示例
curl --location 'https://qianfan.baidubce.com/v2/charge?Action=DescribeTPMResource' \
--header 'Authorization: bce-auth-v1/f0ee7a166b934xxxx2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58xxxx6e374525543' \
--header 'x-bce-date: 2023-09-19T13:37:10Z' \
--header 'Content-Type: application/json' \
--data '{
"model":"ernie-4.0-8k",
"paymentTiming":"Postpaid",
"instanceId":"a0085162fxxxx0a49d19e58e"
}'响应示例
{
"requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
"result":{
"instances":[
{
"instanceId":"a0085162fxxxx0ad19e58e",
"paymentTiming":"Postpaid",
"rpm":33,
"tpm":10000,
"status":"Running",
"startTime":"2024-02-26T10:00:00Z",
"expiredTime":"-"
}
]
}
}错误码
若请求错误，服务器将返回的JSON文本包含以下参数：
| 名称 | 描述 |
|---|---|
| requestId | 请求ID |
| code | 错误码 |
| message | 错误描述信息，帮助理解和解决发生的错误 |
例如错误返回：
{
"requestId":"6ba7b810xxxc04fd430c8",
"code":"AccessDenied",
"message":"Access denied."
}更多其他错误码，也可以查看错误码说明。