资讯 社区 文档
技术能力
语音技术
文字识别
人脸与人体
图像技术
语言与知识
视频技术

查询算力单元实例列表

接口描述

本接口用于查询当前服务已使用的全部或特定算力单元实例列表。

权限说明

调用本文API,需符合以下权限要求,权限介绍及分配,请查看角色与权限控制列表账号创建与权限分配。需具有以下任一权限:

  • 完全控制千帆大模型平台的权限:QianfanFullControlAccessPolicy
  • 运维操作千帆大模型平台预测服务的权限:QianfanServiceOperateAccessPolicy
  • 只读访问千帆大模型平台预测服务的权限:QianfanServiceReadAccessPolicy

注意事项

本文API文档,请求地址和Query参数值变更,推荐参考本文内容,更新成最新url、Query参数Action值。如果之前已接入,目前可正常调用,后续可能会下线以下url的服务:

  • 请求地址:https://qianfan.baidubce.com/v2/charge
  • Query参数Action值:DescribeServiceResources

鉴权说明

调用本文API,使用“基于安全认证AK/SK”进行签名计算鉴权,即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权,具体鉴权认证机制参考HTTP调用鉴权说明

请求结构

POST /v2/serviceresources?Action=DescribeComputeUnits HTTP/1.1
Host: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json

{
    "serviceId":"svco-48exxxa594",
    "paymentTiming":"Prepaid"
}

请求头域

除公共头域外,无其它特殊头域。

请求参数

  • Query参数
名称 类型 必填 描述
Action string 方法名称,固定值DescribeComputeUnits
  • Body参数
名称 类型 必填 描述
serviceId string 服务ID
paymentTiming string 付费类型,说明:
(1)不填写该参数,默认查询当前服务所有正在使用的算力单元实例
(2)填写该字段,表示查询当前服务正在使用的特定付费类型的算力单元实例,可选值:
· Prepaid:预付费
· Postpaid:表示后付费

响应头域

除公共头域外,无其它特殊头域。

响应参数

名称 类型 描述
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/serviceresources?Action=DescribeComputeUnits' \
--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"
            }
        ]
    }
}

错误码

若请求错误,服务器将返回的JSON文本包含以下参数:

名称 描述
requestId 请求ID
code 错误码
message 错误描述信息,帮助理解和解决发生的错误

例如错误返回:

{
    "requestId":"1bef3f87-xxx-50f9884f10d4",
    "code":"AccessDenied",
    "message":"Access denied."
}

更多其他错误码,也可以查看错误码说明

上一篇
购买算力单元实例
下一篇
查询算力单元实例信息