查询算力单元实例信息
更新时间：2024-12-23
接口描述
本接口用于查询当前服务已使用的全部或特定算力单元实例信息，且只能获取配置相关信息。
权限说明
调用本文API，需符合以下权限要求，权限介绍及分配，请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限：
- 完全控制千帆大模型平台的权限：QianfanFullControlAccessPolicy
- 运维操作千帆大模型平台预测服务的权限：QianfanServiceOperateAccessPolicy
- 只读访问千帆大模型平台预测服务的权限：QianfanServiceReadAccessPolicy
注意事项
本文API，请求地址和Query参数值变更，推荐参考本文内容，更新成最新url、Query参数Action值。如果之前已接入，目前可正常调用，后续可能会下线以下url的服务：
- 请求地址：
https://qianfan.baidubce.com/v2/charge - Query参数Action值：
DescribeServiceResource
鉴权说明
调用本文API，使用“基于安全认证AK/SK”进行签名计算鉴权，即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权，具体鉴权认证机制参考HTTP调用鉴权说明。
请求结构
POST /v2/serviceresources?Action=DescribeComputeUnit HTTP/1.1
Host: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json
{
"serviceId":"svco-48esssdpa594",
"instanceId":"a0085162f7e8xxxx49d19e58e"
}请求头域
除公共头域外，无其它特殊头域。
请求参数
- Query参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Action | string | 是 | 方法名称，固定值DescribeComputeUnit |
- Body参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| serviceId | string | 是 | 服务ID |
| instanceId | string | 是 | 已购算力单元实例ID，说明：该字段值通过调用购买算力单元实例接口，返回的instanceId获取 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 名称 | 类型 | 描述 |
|---|---|---|
| requestId | string | 请求ID |
| result | object | 请求结果 |
result说明
| 名称 | 类型 | 描述 |
|---|---|---|
| instance | object | 实例信息 |
instances说明
| 名称 | 类型 | 描述 |
|---|---|---|
| instanceId | string | 实例ID |
| paymentTiming | string | 付费类型，说明： · Prepaid：预付费 · Postpaid：表示后付费 |
| replicasCount | int | 算力单元实例包含的副本数量 |
| status | string | 资源状态，说明： · Creating：创建中 · Running：使用中 · Deleted： 已过期 |
| startTime | string | 开始时间，说明： · 当status为Creating，该字段为购买算力单元实例的订单的创建时间 · 当status为Running或Deleted，该字段返回算力单元实例的开始时间 |
| expiredTime | string | 算力单元实例的到期时间，说明： · 当status为Creating，该字段返回空 · 当status为Running或Deleted，该字段返回算力单元实例的到期时间 |
请求示例
curl --location 'https://qianfan.baidubce.com/v2/serviceresources?Action=DescribeComputeUnit' \
--header 'Authorization: bce-auth-v1/f0ee7a166b934f7xxxx79702c13/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f4xxxx0016e374525543' \
--header 'x-bce-date: 2023-09-19T13:37:10Z' \
--header 'Content-Type: application/json' \
--data '{
"serviceId":"svco-48esssdpa594",
"instanceId":"a0085162f7e8xxxx49d19e58e"
}'响应示例
{
"requestId":"1bef3f87-xxxx-936b-50f9884f10d4",
"result":{
"instance":{
"instanceId":"a0085162fxxxx0a49d19e58e",
"paymentTiming":"Prepaid",
"replicasCount":5,
"status":"Running",
"startTime":"2024-04-01T10:00:00Z",
"expiredTime":"2024-05-01T10:00:00Z"
}
}
}错误码
若请求错误，服务器将返回的JSON文本包含以下参数：
| 名称 | 描述 |
|---|---|
| requestId | 请求ID |
| code | 错误码 |
| message | 错误描述信息，帮助理解和解决发生的错误 |
例如错误返回：
{
"requestId":"1bef3f87-cxxxb-50f9884f10d4",
"code":"AccessDenied",
"message":"Access denied."
}更多其他错误码，也可以查看错误码说明。