查询TPM配额信息详情
更新时间:2024-09-10
功能介绍
本接口用于查询预置服务TPM配额信息。
注意事项
- TPM配额预付费相关介绍,请参考TPM配额预付费。
- 调用本文API,需符合以下权限要求:需具有QianfanServiceReadAccessPolicy 权限;权限介绍及分配,请查看角色与权限控制列表、账号创建与权限分配。
SDK调用
使用说明
本文API支持通过千帆Python SDK、Go SDK、Java SDK 和 Node.js SDK调用,调用流程请参考SDK安装及使用流程。
调用示例
import os
from qianfan.resources.console.charge import Charge
# 使用安全认证AK/SK鉴权,通过环境变量方式初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"
resp = Charge.info("ernie-4.0-8k")
print(resp)
package main
import (
"context"
"fmt"
"os"
"github.com/baidubce/bce-qianfan-sdk/go/qianfan"
)
func main() {
// 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
os.Setenv("QIANFAN_ACCESS_KEY", "your_iam_ak")
os.Setenv("QIANFAN_SECRET_KEY", "your_iam_sk")
ca := qianfan.NewConsoleAction()
res, err := ca.Call(context.TODO(), "/v2/charge", "DescribeTPMResource", map[string]interface{}{
"model":"ernie-4.0-8k",
"paymentTiming":"Postpaid",
"instanceId":"tpm-VlxxxxF",
})
if err != nil {
panic(err)
}
fmt.Println(string(res.Body))
}
import com.baidubce.qianfan.Qianfan;
import com.baidubce.qianfan.model.console.ConsoleResponse;
import com.baidubce.qianfan.util.CollUtils;
import com.baidubce.qianfan.util.Json;
import java.util.Map;
public class Dome {
public static void main(String args[]){
// 使用安全认证AK/SK鉴权,替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
Qianfan qianfan = new Qianfan("your_iam_ak", "your_iam_sk");
ConsoleResponse<Map<String, Object>> response = qianfan.console()
// 调用本文API,该参数值为固定值,无需修改;对应本文HTTP调用-请求说明-请求地址的后缀
.route("/v2/charge")
// 调用本文API,该参数值为固定值,无需修改;对应本文HTTP调用-请求说明-请求参数-Query参数的Action
.action("DescribeTPMResource")
// 需要传入参数的场景,可以自行封装请求类,或者使用Map.of()来构建请求Body
// Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
// 对应本文HTTP调用-请求说明-请求参数-Body参数,具体使用请查看Body参数说明,根据实际使用选择参数
.body(CollUtils.mapOf(
"model","ernie-4.0-8k",
"paymentTiming","Postpaid",
"instanceId","a0085162fxxxx0a49d19e58e"
))
.execute();
System.out.println(Json.serialize(response));
}
}
import {consoleAction, setEnvVariable} from "@baiducloud/qianfan";
// 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
setEnvVariable('QIANFAN_ACCESS_KEY','your_iam_ak');
setEnvVariable('QIANFAN_SECRET_KEY','your_iam_sk');
async function main() {
const res = await consoleAction({base_api_route: 'v2/charge', action: 'DescribeTPMResource', data: {
"model":"ernie-4.0-8k",
"paymentTiming":"Postpaid",
"instanceId":"a0085162fxxxx0a49d19e58e"
}
});
console.log(res);
}
main();
返回示例
QfResponse(
code = 200,
headers = {...},
body = {
"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":"-"
}
]
}
},
)
{
"requestId": "be175a06-a9c8-4cef-8f58-8c55cf7a7fdf",
"result": {
"instances": [{
"expiredTime": "-",
"instanceId": "tpm-VlCixk3F",
"paymentTiming": "Postpaid",
"rpm": 330,
"startTime": "2024-08-16T06:05:24Z",
"status": "Running",
"tpm": 100000
}]
}
}
{
"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":"-"
}
]
}
}
{
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:'-'
}
]
}
}
请求参数
注意:以下为Python SDK参数说明,Go SDK、Java SDK、Node.js SDK参数说明请参考本文HTTP调用-请求说明。
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
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-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-speed-8k:模型版本为ERNIE-Speed-8K · ernie-speed-128k:模型版本为ERNIE-Speed-128K · ernie-char-8k:模型版本为ERNIE-Character-8K · ernie-novel-8k:模型版本为ERNIE-Novel-8K · ernie-speed-appbuilder-8k:模型版本为ERNIE-Speed-AppBuilder-8K · ernie-lite-8k:模型版本为ERNIE-Lite-8K |
payment_type | string | 否 | 付费类型,说明: · 如果不填写该参数,查询全部付费类型的配额 · 如果填写该参数,查询特定付费类型的配额;目前为固定值Postpaid,表示查询后付费类型配额 |
status | string | 否 | 付费类型,说明: (1)如果不填写该参数,查询全部资源状态的实例 (2)如果填写该参数,查询特定状态的实例,可选值如下: · Creating:创建中 · Running:使用中 · Stopped:已过期 |
instance_id | string | 否 | 已购TPM配额对应的实例ID,该字段值通过调用购买TPM配额接口,返回的instanceId字段获取 |
返回参数
请参考本文HTTP调用-响应说明。
HTTP调用
鉴权说明
调用本文API,使用“基于安全认证AK/SK”进行签名计算鉴权,即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权,具体鉴权认证机制参考HTTP调用鉴权说明。
请求说明
- 基本信息
请求地址: https://qianfan.baidubce.com/v2/charge
请求方式: POST
- Header参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Content-Type | string | 是 | 固定值application/json |
x-bce-date | string | 否 | 当前时间,遵循ISO8601规范,格式如2016-04-06T08:23:49Z |
Authorization | string | 是 | 用于验证请求合法性的认证信息,更多内容请参考鉴权认证机制,签名工具可参考IAM签名工具 |
- 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-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-speed-8k:模型版本为ERNIE-Speed-8K · ernie-speed-128k:模型版本为ERNIE-Speed-128K · ernie-char-8k:模型版本为ERNIE-Character-8K · ernie-novel-8k:模型版本为ERNIE-Novel-8K · ernie-speed-appbuilder-8k:模型版本为ERNIE-Speed-AppBuilder-8K · ernie-lite-8k:模型版本为ERNIE-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."
}
更多千帆大模型平台其他错误码,也可以查看错误码说明。