购买算力单元实例
更新时间:2024-07-19
功能介绍
本接口用于购买当前服务部署所需的算力单元实例。
注意事项
当库存不足或余额不足时,可能会导致购买失败。
SDK调用
使用说明
调用本文API,需使用安全认证AK/SK鉴权,调用流程及鉴权介绍详见SDK安装及使用流程。
调用示例
import os
from qianfan import resources
# 使用安全认证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 = resources.Charge.charge_tpm_credit(
service_id='svco-48esssdpa594',
billing={
"paymentTiming":"Prepaid",
"reservation":{
"reservationTimeUnit":"Hour",
"reservationLength":10
}
},
replicas=1,
)
print(resp.body)
返回示例
{
"requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
"result":{
"instanceId":"44961088fxxxx9e9379f5daf"
}
}
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
service_id | string | 是 | 服务ID |
billing | Billing | 是 | 订单、计费相关参数 |
replicasCount | int | 是 | 购买副本数量 |
Billing说明
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
paymentTiming | string | 是 | 付费类型,可选值: · Prepaid:表示预付费 · Postpaid:表示后付费 |
reservation | dict | 否 | 保留信息,说明: (1)只有当付费类型为预付费,即paymentTiming值为Prepaid时,该字段必填 (2)付费类型为后付费,无需填写此参数 |
reservation说明
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
reservationTimeUnit | string | 是 | 时间单位,可选值: · Month:月 · Day:天;注意:预计2024年8月1日下线 · Hour: 小时;注意:预计2024年8月1日下线 |
reservationLength | int | 是 | 购买时长,说明: · 时间单位为月,取值范围 [1-12] · 时间单位为天,取值范围 [1-366] ;注意:预计2024年8月1日下线 · 时间单位为小时,取值范围 [1-23] ;注意:预计2024年8月1日下线 |
返回参数
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID |
result | dict | 请求结果 |
result说明
名称 | 类型 | 描述 |
---|---|---|
instanceId | string | 实例ID |
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 | 是 | 方法名称,固定值PurchaseServiceResource |
- Body参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
serviceId | string | 是 | 服务ID |
billing | Billing | 是 | 订单、计费相关参数 |
replicasCount | int | 是 | 购买副本数量 |
Billing说明
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
paymentTiming | string | 是 | 付费类型,可选值: · Prepaid:表示预付费 · Postpaid:表示后付费 |
reservation | Reservation | 否 | 保留信息,说明: (1)只有当付费类型为预付费,即paymentTiming值为Prepaid时,该字段必填 (2)付费类型为后付费,无需填写此参数 |
Reservation说明
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
reservationTimeUnit | string | 是 | 时间单位,可选值: · Month: 月 · Day:天;注意:预计2024年8月1日下线 · Hour: 小时;注意:预计2024年8月1日下线 |
reservationLength | int | 是 | 购买时长,说明: · 时间单位为月,取值范围 [1-12] · 时间单位为天,取值范围 [1-366] ;注意:预计2024年8月1日下线 · 时间单位为小时,取值范围 [1-23] ;注意:预计2024年8月1日下线 |
响应说明
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID |
result | object | 请求结果 |
result说明
名称 | 类型 | 描述 |
---|---|---|
instanceId | string | 实例ID |
请求示例
curl --location 'https://qianfan.baidubce.com/v2/charge?Action=PurchaseServiceResource' \
--header 'Authorization: bce-auth-v1/f0ee7a166b934xxxx2c13/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8xxxx525543' \
--header 'x-bce-date: 2023-09-19T13:37:10Z' \
--header 'Content-Type: application/json' \
--data '{
"serviceId":"svco-48esssdpa594",
"billing":{
"paymentTiming":"Prepaid",
"reservation":{
"reservationTimeUnit":"Hour",
"reservationLength":10
}
},
"replicasCount":5
}'
响应示例
{
"requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
"result":{
"instanceId":"44961088fxxxx9e9379f5daf"
}
}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
名称 | 描述 |
---|---|
code | 错误码 |
message | 错误描述信息,帮助理解和解决发生的错误 |
例如Access Token失效返回:
{
"requestId":"1bef3f87-cxxxx9884f10d4",
"code":"AccessDenied",
"message":"Access denied."
}
更多千帆大模型平台其他错误码,也可以查看错误码说明。