查询TPM配额信息详情
更新时间:2024-04-12
功能介绍
本接口用于查询预置服务TPM配额信息。
注意事项
- TPM配额预付费相关介绍,请参考TPM配额预付费。
- 调用本文API,使用“安全认证/Access Key ”中的Access Key ID 和 Secret Access Key等进行鉴权,无法使用获取Access Token的方式鉴权,具体鉴权认证机制参考鉴权认证机制。
请求说明
基本信息
请求地址: 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-3.5-8k:模型版本为ERNIE-3.5-8K · ernie-speed-8k:模型版本为ERNIE-Speed-8K · ernie-lite-8k-0922:模型版本为ERNIE-Lite-8K-0922 · ernie-lite-8k:注意,该字段值已废弃,请替换字段值为ernie-lite-8k-0922 |
paymentTiming | string | 否 | 付费类型,说明: · 如果不填写该参数,查询全部付费类型的配额 · 如果填写该参数,查询特定付费类型的配额;目前为固定值Postpaid,表示查询后付费类型配额 |
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文本包含以下参数:
名称 | 描述 |
---|---|
error_code | 错误码 |
error_msg | 错误描述信息,帮助理解和解决发生的错误 |
例如Access Token失效返回:
{
"error_code": 110,
"error_msg": "Access token invalid or no longer valid"
}
更多千帆大模型平台其他错误码,也可以查看错误码说明。