查询TPM配额信息详情
更新时间:2025-05-16
功能介绍
本接口用于查询预置服务TPM配额信息。
注意事项
- 购买TPM配额,会切换计费方式,更多介绍请参考TPM配额预付费。
- 本文API支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用,调用流程请参考SDK安装及使用流程。
权限说明
调用本文API,需符合以下权限要求,权限介绍及分配,请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限:
- 完全控制千帆大模型平台的权限:QianfanFullControlAccessPolicy
- 运维操作千帆大模型平台预测服务的权限:QianfanServiceOperateAccessPolicy
- 只读访问千帆大模型平台预测服务的权限:QianfanServiceReadAccessPolicy
SDK调用
调用示例
1import os
2from qianfan import resources
3
4# 通过环境变量初始化认证信息
5# 使用安全认证AK/SK调用,替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk,如何获取请查看https://cloud.baidu.com/doc/Reference/s/9jwvz2egb
6os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
7os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"
8
9resp = resources.console.utils.call_action(
10 # 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
11 "/v2/charge",
12 # 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
13 "DescribeTPMResource",
14 # 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
15 {
16 "model":"ernie-4.0-8k",
17 "paymentTiming":"Postpaid",
18 "instanceId":"a0085162fxxxx0a49d19e58e"
19 }
20)
21
22print(resp.body)
1import com.baidubce.qianfan.Qianfan;
2import com.baidubce.qianfan.model.console.ConsoleResponse;
3import com.baidubce.qianfan.util.CollUtils;
4import com.baidubce.qianfan.util.Json;
5import java.util.Map;
6
7public class Dome {
8 public static void main(String args[]){
9 // 使用安全认证AK/SK鉴权,替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
10 Qianfan qianfan = new Qianfan("your_iam_ak", "your_iam_sk");
11
12 ConsoleResponse<Map<String, Object>> response = qianfan.console()
13 // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
14 .route("/v2/charge")
15 // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
16 .action("DescribeTPMResource")
17 // 需要传入参数的场景,可以自行封装请求类,或者使用Map.of()来构建请求Body
18 // Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
19 // 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
20 .body(CollUtils.mapOf(
21 "model","ernie-4.0-8k",
22 "paymentTiming","Postpaid",
23 "instanceId","a0085162fxxxx0a49d19e58e"
24 ))
25 .execute();
26
27 System.out.println(Json.serialize(response));
28 }
29}
1import {consoleAction, setEnvVariable} from "@baiducloud/qianfan";
2
3// 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
4setEnvVariable('QIANFAN_ACCESS_KEY','your_iam_ak');
5setEnvVariable('QIANFAN_SECRET_KEY','your_iam_sk');
6
7async function main() {
8 //base_api_route:调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
9 //action:调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
10 //data:请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
11 const res = await consoleAction({base_api_route: '/v2/charge', action: 'DescribeTPMResource', data: {
12 "model":"ernie-4.0-8k",
13 "paymentTiming":"Postpaid",
14 "instanceId":"a0085162fxxxx0a49d19e58e"
15 }
16 });
17
18 console.log(res);
19}
20
21main();
返回示例
1{
2 "requestId": "be175a06-a9c8-4cef-8f58-8c55cf7a7fdf",
3 "result": {
4 "instances": [{
5 "expiredTime": "-",
6 "instanceId": "tpm-VlCixk3F",
7 "paymentTiming": "Postpaid",
8 "rpm": 330,
9 "startTime": "2024-08-16T06:05:24Z",
10 "status": "Running",
11 "tpm": 100000
12 }]
13 }
14}
1{
2 "requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
3 "result":{
4 "instances":[
5 {
6 "instanceId":"a0085162fxxxx0ad19e58e",
7 "paymentTiming":"Postpaid",
8 "rpm":33,
9 "tpm":10000,
10 "status":"Running",
11 "startTime":"2024-02-26T10:00:00Z",
12 "expiredTime":"-"
13 }
14 ]
15 }
16}
1{
2 requestId:'1bef3f87-c5b2-4419-936b-50f9884f10d4',
3 result:{
4 instances:[
5 {
6 instanceId:'a0085162fxxxx0ad19e58e',
7 paymentTiming:'Postpaid',
8 rpm:33,
9 tpm:10000,
10 status:'Running',
11 startTime:'2024-02-26T10:00:00Z'
12 expiredTime:'-'
13 }
14 ]
15 }
16}
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
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 | 到期时间,说明: · 如果实例资源已被终止,该字段值为到期时间 · 如果实例资源未被终止,该字段值为"-" |