查询算力单元列表
更新时间:2025-05-16
功能介绍
用于筛选算力单元列表信息。
使用说明
本文API支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用,调用流程请参考SDK安装及使用流程。
权限说明
调用本文API,需符合以下权限要求,权限介绍及分配,请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限:
- 完全控制千帆大模型平台的权限:QianfanFullControlAccessPolicy
- 运维操作千帆大模型平台预测服务的权限:QianfanServiceOperateAccessPolicy
- 只读访问千帆大模型平台预测服务的权限:QianfanServiceReadAccessPolicy
SDK调用
调用示例
1package main
2
3import (
4 "context"
5 "fmt"
6 "os"
7
8 "github.com/baidubce/bce-qianfan-sdk/go/qianfan"
9)
10
11func main() {
12 // 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
13 os.Setenv("QIANFAN_ACCESS_KEY", "your_iam_ak")
14 os.Setenv("QIANFAN_SECRET_KEY", "your_iam_sk")
15
16 ca := qianfan.NewConsoleAction()
17
18 res, err := ca.Call(context.TODO(),
19 // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
20 "/v2/computeunit",
21 // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
22 "DescribeComputeUnits",
23 // 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
24 map[string]interface{}{
25 "region": "bj",
26 "paymentTiming": "Prepaid",
27 "type": "gpu-1",
28 })
29 if err != nil {
30 panic(err)
31 }
32 fmt.Println(string(res.Body))
33
34}
1import com.baidubce.qianfan.Qianfan;
2import com.baidubce.qianfan.model.console.ConsoleResponse;
3import com.baidubce.qianfan.util.CollUtils;
4import com.baidubce.qianfan.util.Json;
5import java.util.Map;
6
7public class Dome {
8 public static void main(String args[]){
9 // 使用安全认证AK/SK鉴权,替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
10 Qianfan qianfan = new Qianfan("your_iam_ak", "your_iam_sk");
11
12 ConsoleResponse<Map<String, Object>> response = qianfan.console()
13 // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
14 .route("/v2/computeunit")
15 // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
16 .action("DescribeComputeUnits")
17 // 需要传入参数的场景,可以自行封装请求类,或者使用Map.of()来构建请求Body
18 // Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
19 // 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
20 .body(CollUtils.mapOf(
21 "region", "bj",
22 "paymentTiming", "Prepaid",
23 "type", "gpu-1"
24 ))
25 .execute();
26
27 System.out.println(Json.serialize(response));
28 }
29}
1import {consoleAction, setEnvVariable} from "@baiducloud/qianfan";
2
3// 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
4setEnvVariable('QIANFAN_ACCESS_KEY','your_iam_ak');
5setEnvVariable('QIANFAN_SECRET_KEY','your_iam_sk');
6
7async function main() {
8 //base_api_route:调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
9 //action:调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
10 //data:请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
11 const res = await consoleAction({base_api_route: '/v2/computeunit', action: 'DescribeComputeUnits', data: {
12 "region": "bj",
13 "paymentTiming": "Prepaid",
14 "type": "gpu-1"
15 });
16
17 console.log(res);
18}
19
20main();
返回示例
1{
2 "requestId": "1bef3f87-c5b2-4419-936b-50f9884f10d4",
3 "result": {
4 "computeUnitInstanceList": [
5 {
6 "instanceId": "unit-xxx",
7 "region": "bj",
8 "status": "Released",
9 "type": "gpu-1",
10 "totalComputeUnits": 2,
11 "usedComputeUnits": 0,
12 "paymentTiming": "Prepaid",
13 "startTime": "2024-12-12T12:29:08Z",
14 "expiredTime": "2025-01-12T12:29:08Z",
15 "reservationLength": 1,
16 "reservationTimeUnit": "MONTH",
17 "creator": "xxx"
18 },
19 {
20 "instanceId": "unit-xxx",
21 "region": "bj",
22 "status": "Released",
23 "type": "gpu-1",
24 "totalComputeUnits": 2,
25 "usedComputeUnits": 0,
26 "paymentTiming": "Prepaid",
27 "startTime": "2024-12-11T06:21:56Z",
28 "expiredTime": "2025-01-11T06:21:56Z",
29 "reservationLength": 1,
30 "reservationTimeUnit": "MONTH",
31 "creator": "xxx"
32 }
33 ]
34}
1{
2 "requestId": "1bef3f87-c5b2-4419-936b-50f9884f10d4",
3 "result": {
4 "computeUnitInstanceList": [
5 {
6 "instanceId": "unit-xxx",
7 "region": "bj",
8 "status": "Released",
9 "type": "gpu-1",
10 "totalComputeUnits": 2,
11 "usedComputeUnits": 0,
12 "paymentTiming": "Prepaid",
13 "startTime": "2024-12-12T12:29:08Z",
14 "expiredTime": "2025-01-12T12:29:08Z",
15 "reservationLength": 1,
16 "reservationTimeUnit": "MONTH",
17 "creator": "xxx"
18 },
19 {
20 "instanceId": "unit-xxx",
21 "region": "bj",
22 "status": "Released",
23 "type": "gpu-1",
24 "totalComputeUnits": 2,
25 "usedComputeUnits": 0,
26 "paymentTiming": "Prepaid",
27 "startTime": "2024-12-11T06:21:56Z",
28 "expiredTime": "2025-01-11T06:21:56Z",
29 "reservationLength": 1,
30 "reservationTimeUnit": "MONTH",
31 "creator": "xxx"
32 }
33 ]
34}
1{
2 "requestId": "1bef3f87-c5b2-4419-936b-50f9884f10d4",
3 "result": {
4 "computeUnitInstanceList": [
5 {
6 "instanceId": "unit-xxx",
7 "region": "bj",
8 "status": "Released",
9 "type": "gpu-1",
10 "totalComputeUnits": 2,
11 "usedComputeUnits": 0,
12 "paymentTiming": "Prepaid",
13 "startTime": "2024-12-12T12:29:08Z",
14 "expiredTime": "2025-01-12T12:29:08Z",
15 "reservationLength": 1,
16 "reservationTimeUnit": "MONTH",
17 "creator": "xxx"
18 },
19 {
20 "instanceId": "unit-xxx",
21 "region": "bj",
22 "status": "Released",
23 "type": "gpu-1",
24 "totalComputeUnits": 2,
25 "usedComputeUnits": 0,
26 "paymentTiming": "Prepaid",
27 "startTime": "2024-12-11T06:21:56Z",
28 "expiredTime": "2025-01-11T06:21:56Z",
29 "reservationLength": 1,
30 "reservationTimeUnit": "MONTH",
31 "creator": "xxx"
32 }
33 ]
34}
1{
2 requestId: '1bef3f87-c5b2-4419-936b-50f9884f10d4',
3 result: {
4 computeUnitInstanceList: [
5 {
6 instanceId: 'unit-xxx',
7 region: 'bj',
8 status: 'Released',
9 type: 'gpu-1',
10 totalComputeUnits: 2,
11 usedComputeUnits: 0,
12 paymentTiming: 'Prepaid',
13 startTime: '2024-12-12T12:29:08Z',
14 expiredTime: '2025-01-12T12:29:08Z',
15 reservationLength: 1,
16 reservationTimeUnit: 'MONTH',
17 creator: 'xxx'
18 },
19 {
20 instanceId: 'unit-xxx',
21 region: 'bj',
22 status: 'Released',
23 type: 'gpu-1',
24 totalComputeUnits: 2,
25 usedComputeUnits: 0,
26 paymentTiming: 'Prepaid',
27 startTime: '2024-12-11T06:21:56Z',
28 expiredTime: '22025-01-11T06:21:56Z',
29 reservationLength: 1,
30 reservationTimeUnit: 'MONTH',
31 creator: 'xxx'
32 }
33 ]
34}
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
paymentTiming | string | 否 | 付费类型,可选值如下: · Prepaid:表示预付费 · Postpaid:表示后付费 |
region | string | 否 | 资源地域,可选值如下: · bj:北京 · bd:保定 |
type | string | 否 | 资源类型,可选值如下: · CPU:cpu · 加速卡I型:gpu-1 · 加速卡Ⅱ型:gpu-2 · 加速卡Ⅲ型:gpu-3 · 加速卡Ⅳ型:gpu-4 · 加速卡Ⅴ型:gpu-5 · 加速卡Ⅵ型:gpu-6 |
返回参数
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID |
result | object | 请求结果 |
result说明
名称 | 类型 | 描述 |
---|---|---|
computeUnitInstanceList | List<object> | 实例列表 |
computeUnitInstanceList说明
名称 | 类型 | 描述 |
---|---|---|
instanceId | string | 实例ID |
region | string | 资源地域,具体值如下: · bj:北京 · bd:保定 · sz:苏州 · gz:广州 · yq:阳泉 · global:全局 |
status | string | 资源状态,具体值如下: · Creating:创建中 · CreateFailed:创建失败 · Running:使用中 · Releasing:释放中 · Released:已释放 · Reconfiguring:变配中 · ReconfigureFailed:变配失败 · BillingChanging:计费变更中 |
type | string | 资源类型,具体值如下: · CPU:cpu · 加速卡I型:gpu-1 · 加速卡Ⅱ型:gpu-2 · 加速卡Ⅲ型:gpu-3 · 加速卡Ⅳ型:gpu-4 · 加速卡Ⅴ型:gpu-5 · 加速卡Ⅵ型:gpu-6 |
totalComputeUnits | int | 算力单元总数 |
usedComputeUnits | int | 已用算力单元数 |
paymentTiming | string | 资源付费类型,具体值如下: · Prepaid:预付费 · Postpaid:后付费 |
startTime | string | 算力单元实例的开始时间 |
expiredTime | string | 算力单元实例的到期时间 |
releaseTime | string | 自动释放时间,说明:当资源付费类型为后付费且有设置自动释放时间时,返回该字段 |
reservationLength | int | 实例时长,说明:当资源付费类型为预付费,即paymentTiming=Prepaid时,返回该字段 |
reservationTimeUnit | string | 实例时长单位,说明:当资源付费类型为预付费,即paymentTiming=Prepaid时,返回该字段 |
creator | string | 资源创建人 |
autoRenew | object | 自动续费设置信息,说明:当资源付费类型为预付费且有设置自动续费规则时,返回该字段 |
autoRenew说明
名称 | 类型 | 描述 |
---|---|---|
renewTime | int | 续费时长 |
renewTimeUnit | string | 续费时长单位,具体值如下: · MONTH:月 · YEAR:年 |