查询算力单元实例列表
更新时间:2024-06-24
功能介绍
本接口用于查询当前服务已使用的全部或特定算力单元实例列表。
HTTP调用
鉴权说明
调用本文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 | 是 | 方法名称,固定值DescribeServiceResources |
- Body参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
serviceId | string | 是 | 服务ID |
paymentTiming | string | 否 | 付费类型,说明: (1)不填写该参数,默认查询当前服务所有正在使用的算力单元实例 (2)填写该字段,表示查询当前服务正在使用的特定付费类型的算力单元实例。如果填写该参数,为固定值Prepaid,表示预付费 |
响应说明
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID |
result | object | 请求结果 |
result说明
名称 | 类型 | 描述 |
---|---|---|
instances | list | 实例列表 |
instances说明
名称 | 类型 | 描述 |
---|---|---|
instanceId | string | 实例ID |
paymentTiming | string | 付费类型,说明: · Prepaid:预付费 · Postpaid:后付费 |
replicasCount | int | 副本数 |
status | string | 资源状态,说明: · 1:Creating · 2:Running · 3:Deleted,表示已过期 |
startTime | string | 开始时间,说明: (1)当status=Creating,该字段为空 (2)当status是Running或Deleted,该字段表示算力单元实例的开始时间 |
expiredTime | string | 算力单元实例的到期时间,说明: (1) 当status=Creating,该字段为空 (2)当status是Running或Deleted时,该字段表示算力单元实例的到期时间 |
请求示例
curl --location 'https://qianfan.baidubce.com/v2/charge?Action=DescribeServiceResources' \
--header 'Authorization: bce-auth-v1/f0ee7xxx79702c13/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8xxxx25543' \
--header 'x-bce-date: 2023-09-19T13:37:10Z' \
--header 'Content-Type: application/json' \
--data '{
"serviceId":"svco-48exxxa594",
"paymentTiming":"Prepaid"
}'
响应示例
{
"requestId":"1bef3f87-cxxxx50f9884f10d4",
"result":{
"instances":[
{
"instanceId":"a0085162xxx9d19e58e",
"paymentTiming":"Prepaid",
"replicasCount":5,
"status":"Running",
"startTime":"2024-04-01T10:00:00Z",
"expiredTime":"2024-05-01T10:00:00Z"
}
]
}
}
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.ger_service_resource_list(
service_id="svco-48exxxa594",
payment_timing="Prepaid",
)
print(resp.body)
返回示例
{
"requestId":"1bef3f87-cxxxx50f9884f10d4",
"result":{
"instances":[
{
"instanceId":"a0085162xxx9d19e58e",
"paymentTiming":"Prepaid",
"replicasCount":5,
"status":"Running",
"startTime":"2024-04-01T10:00:00Z",
"expiredTime":"2024-05-01T10:00:00Z"
}
]
}
}
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
service_id | string | 是 | 服务ID |
payment_timing | string | 否 | 付费类型,说明: (1)不填写该参数,默认查询当前服务所有正在使用的算力单元实例 (2)填写该字段,表示查询当前服务正在使用的特定付费类型的算力单元实例。如果填写该参数,为固定值Prepaid,表示预付费 |
返回参数
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID |
result | dict | 请求结果 |
result说明
名称 | 类型 | 描述 |
---|---|---|
instances | list | 实例列表 |
instances说明
名称 | 类型 | 描述 |
---|---|---|
instanceId | string | 实例ID |
paymentTiming | string | 付费类型,说明: · Prepaid:预付费 · Postpaid:后付费 |
replicas | int | 副本数 |
status | string | 资源状态,说明: · 1:Creating · 2:Running · 3:Deleted,表示已过期 |
startTime | string | 开始时间,说明: (1)当status=Creating,该字段为空 (2)当status是Running或Deleted,该字段表示算力单元实例的开始时间 |
expiredTime | string | 算力单元实例的到期时间,说明: (1)当status=Creating,该字段为空 (2)当status是Running或Deleted时,该字段表示算力单元实例的到期时间 |
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
名称 | 描述 |
---|---|
code | 错误码 |
message | 错误描述信息,帮助理解和解决发生的错误 |
例如失败返回:
{
"requestId":"1bef3f87-xxx-50f9884f10d4",
"code":"AccessDenied",
"message":"Access denied."
}
更多千帆大模型平台其他错误码,也可以查看错误码说明。