查询算力单元实例信息

更新时间：2025-01-13

功能介绍

用于查询当前服务已使用的全部或特定算力单元实例信息，且只能获取配置相关信息。

使用说明

本文API支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用，调用流程请参考SDK安装及使用流程。

权限说明

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

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

SDK调用

使用说明

本文API支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用，调用流程请参考SDK安装及使用流程。

调用示例

import os
from qianfan  import resources

# 通过环境变量初始化认证信息
# 使用安全认证AK/SK调用，替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk，如何获取请查看https://cloud.baidu.com/doc/Reference/s/9jwvz2egb
os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"

resp = resources.console.utils.call_action(
    # 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求结构-请求地址的后缀
    "/v2/serviceresources", 
    # 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求参数-Query参数的Action 
    "DescribeComputeUnit", 
    # 请查看本文请求参数说明，根据实际使用选择参数；对应API调用文档-请求参数-Body参数
    {
        "serviceId":"svco-48esssdpa594",
        "instanceId":"a0085162f7e8xxxx49d19e58e"
    }
)

print(resp.body)

package main

import (
    "context"
    "fmt"
    "os"

    "github.com/baidubce/bce-qianfan-sdk/go/qianfan"
)

func main() {
     // 使用安全认证AK/SK鉴权，通过环境变量初始化；替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
    os.Setenv("QIANFAN_ACCESS_KEY", "your_iam_ak")
    os.Setenv("QIANFAN_SECRET_KEY", "your_iam_sk")
    
    ca := qianfan.NewConsoleAction()
    
    res, err := ca.Call(context.TODO(),
    // 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求结构-请求地址的后缀
    "/v2/serviceresources",
    // 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求参数-Query参数的Action 
    "DescribeComputeUnit",
    // 请查看本文请求参数说明，根据实际使用选择参数；对应API调用文档-请求参数-Body参数
    map[string]interface{}{
         "serviceId":"svco-48esssdpa594",
         "instanceId":"a0085162f7e8xxxx49d19e58e",
    })
    if err != nil {
        panic(err)
    }
    fmt.Println(string(res.Body))
    
}

import com.baidubce.qianfan.Qianfan;
import com.baidubce.qianfan.model.console.ConsoleResponse;
import com.baidubce.qianfan.util.CollUtils;
import com.baidubce.qianfan.util.Json;
import java.util.Map;

public class Dome {
    public static void main(String args[]){
        // 使用安全认证AK/SK鉴权，替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
        Qianfan qianfan = new Qianfan("your_iam_ak", "your_iam_sk");
        
        ConsoleResponse<Map<String, Object>> response = qianfan.console()
                // 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求结构-请求地址的后缀
                .route("/v2/serviceresources")
                // 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求参数-Query参数的Action 
                .action("DescribeComputeUnit")
                // 需要传入参数的场景，可以自行封装请求类，或者使用Map.of()来构建请求Body
                // Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
                // 请查看本文请求参数说明，根据实际使用选择参数；对应API调用文档-请求参数-Body参数
                .body(CollUtils.mapOf(
                     "serviceId","svco-48esssdpa594",
                     "instanceId","a0085162f7e8xxxx49d19e58e"
                ))
                .execute();

        System.out.println(Json.serialize(response));
    }
}

import {consoleAction, setEnvVariable} from "@baiducloud/qianfan";
// 使用安全认证AK/SK鉴权，通过环境变量初始化；替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
setEnvVariable('QIANFAN_ACCESS_KEY','your_iam_ak');
setEnvVariable('QIANFAN_SECRET_KEY','your_iam_sk');
async function main() {
  //base_api_route:调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求结构-请求地址的后缀
  //action:调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求参数-Query参数的Action 
  //data:请查看本文请求参数说明，根据实际使用选择参数；对应API调用文档-请求参数-Body参数
  const res = await consoleAction({base_api_route: '/v2/serviceresources', action: 'DescribeComputeUnit', data: {
        "serviceId":"svco-48esssdpa594",
        "instanceId":"a0085162f7e8xxxx49d19e58e"
    }
  });    
    
  console.log(res);
}
main();

返回示例

{
    "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"
        }
    }
}

{
    "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"
        }
    }
}

{
    "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"
        }
    }
}

{
    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'
            }
        ]
    }
}

请求参数

名称	类型	必填	描述
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，该字段返回算力单元实例的到期时间

查询算力单元实例列表

终止算力单元后付费实例