获取定制服务详情

更新时间：2025-01-03

功能介绍

用于获取服务详情。

使用说明

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

权限说明

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

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

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，该参数值为固定值，无需修改；对应HTTP调用文档-请求说明-请求地址的后缀
    "/v2/service", 
    # 调用本文API，该参数值为固定值，无需修改；对应HTTP调用文档-请求说明-请求参数-Query参数的Action
    "DescribeService", 
    # 对应HTTP调用文档-请求说明-请求参数-Body参数，具体使用请查看Body参数说明，根据实际使用选择参数
    {
        "serviceId":"svco-nzxxxxx4h"
    }
)

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，该参数值为固定值，无需修改；对应HTTP调用文档-请求说明-请求地址的后缀
    "/v2/service",
    // 调用本文API，该参数值为固定值，无需修改；对应HTTP调用文档-请求说明-请求参数-Query参数的Action
    "DescribeService",
    // 对应HTTP调用文档-请求说明-请求参数-Body参数，具体使用请查看Body参数说明，根据实际使用选择参数
    map[string]interface{}{
        "serviceId":"svco-nzxxxxx4h",
    })
    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，该参数值为固定值，无需修改；对应HTTP调用文档-请求说明-请求地址的后缀
                .route("/v2/service")
                // 调用本文API，该参数值为固定值，无需修改；对应HTTP调用文档-请求说明-请求参数-Query参数的Action
                .action("DescribeService")
                // 需要传入参数的场景，可以自行封装请求类，或者使用Map.of()来构建请求Body
                // Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
                // 对应HTTP调用文档-请求说明-请求参数-Body参数，具体使用请查看Body参数说明，根据实际使用选择参数
                .body(CollUtils.mapOf(
                    "serviceId","svco-nzxxxxx4h"
                ))
                .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，该参数值为固定值，无需修改；对应HTTP调用文档-请求说明-请求地址的后缀
  //action:调用本文API，该参数值为固定值，无需修改；对应HTTP调用文档-请求说明-请求参数-Query参数的Action
  //data:对应HTTP调用文档-请求说明-请求参数-Body参数，具体使用请查看Body参数说明，根据实际使用选择参数
  const res = await consoleAction({base_api_route: '/v2/service', action: 'DescribeService', data: {
        "serviceId":"svco-nzxxxxx4h"
    }
  });    
    
  console.log(res);
}

main();

返回示例

{
    "requestId": "93c46f79-525a-45af-9d1d-b59c70f3ebcd",
    "result": {
        "serviceId": "svco-nzxxxx4h",
        "baseModel": "CodeLlama-7B",
        "modelSetId": "am-gbxxxxpvb",
        "modelId": "amv-9jxxxxx5m4",
        "name": "lf_postp***",
        "description": "lf_postpay",
        "url": "http://as***",
        "serviceType": "chat",
        "runStatus": "New",
        "scaleStatus": "None",
        "updateStatus": "None",
        "chargeType": "",
        "payType": "",
        "chargeStatus": "NotOpen",
        "resourceConfig": {
            "region": "bd",
            "type": "GPU-1-1",
            "replicasCount": 0,
            "qps": 3
        },
        "isModelUpdating": False,
        "enableLogs": False,
        "logStoreConfig": {},
        "creator": "百里**",
        "createTime": "2024-12-24T09:32:54Z",
        "deploymentConfig": {
            "type": "GPU-1-1",
            "region": "bd",
            "qps": 3,
            "replicasComputeUnitCount": 0,
            "replicasCount": 0
        },
        "protocolVersion": 1
    }
}

{
    "requestId": "93c46f79-525a-45af-9d1d-b59c70f3ebcd",
    "result": {
        "serviceId": "svco-nzxxxx4h",
        "baseModel": "CodeLlama-7B",
        "modelSetId": "am-gbxxxxpvb",
        "modelId": "amv-9jxxxxx5m4",
        "name": "lf_postp***",
        "description": "lf_postpay",
        "url": "http://as***",
        "serviceType": "chat",
        "runStatus": "New",
        "scaleStatus": "None",
        "updateStatus": "None",
        "chargeType": "",
        "payType": "",
        "chargeStatus": "NotOpen",
        "resourceConfig": {
            "region": "bd",
            "type": "GPU-1-1",
            "replicasCount": 0,
            "qps": 3
        },
        "isModelUpdating": false,
        "enableLogs": false,
        "logStoreConfig": {},
        "creator": "百里**",
        "createTime": "2024-12-24T09:32:54Z",
        "deploymentConfig": {
            "type": "GPU-1-1",
            "region": "bd",
            "qps": 3,
            "replicasComputeUnitCount": 0,
            "replicasCount": 0
        },
        "protocolVersion": 1
    }
}

{
    "requestId": "93c46f79-525a-45af-9d1d-b59c70f3ebcd",
    "result": {
        "serviceId": "svco-nzxxxx4h",
        "baseModel": "CodeLlama-7B",
        "modelSetId": "am-gbxxxxpvb",
        "modelId": "amv-9jxxxxx5m4",
        "name": "lf_postp***",
        "description": "lf_postpay",
        "url": "http://as***",
        "serviceType": "chat",
        "runStatus": "New",
        "scaleStatus": "None",
        "updateStatus": "None",
        "chargeType": "",
        "payType": "",
        "chargeStatus": "NotOpen",
        "resourceConfig": {
            "region": "bd",
            "type": "GPU-1-1",
            "replicasCount": 0,
            "qps": 3
        },
        "isModelUpdating": false,
        "enableLogs": false,
        "logStoreConfig": {},
        "creator": "百里**",
        "createTime": "2024-12-24T09:32:54Z",
        "deploymentConfig": {
            "type": "GPU-1-1",
            "region": "bd",
            "qps": 3,
            "replicasComputeUnitCount": 0,
            "replicasCount": 0
        },
        "protocolVersion": 1
    }
}

{
    requestId: '93c46f79-525a-45af-9d1d-b59c70f3ebcd',
    result: {
        serviceId: 'svco-nzxxxx4h',
        baseModel: 'CodeLlama-7B',
        modelSetId: 'am-gbxxxxpvb',
        modelId: 'amv-9jxxxxx5m4',
        name: 'lf_postp***',
        description: 'lf_postpay',
        url: 'http://as***',
        serviceType: 'chat',
        runStatus: 'New',
        scaleStatus: 'None',
        updateStatus: 'None',
        chargeType: '',
        payType: '',
        chargeStatus: 'NotOpen',
        resourceConfig: {
            region: 'bd',
            type: 'GPU-1-1',
            replicasCount: 0,
            qps: 3
        },
        isModelUpdating: false,
        enableLogs: false,
        logStoreConfig: {},
        creator: '百里**',
        createTime: '2024-12-24T09:32:54Z',
        deploymentConfig: {
            type: 'GPU-1-1',
            region: 'bd',
            qps: 3,
            replicasComputeUnitCount: 0,
            replicasCount: 0
        },
        protocolVersion: 1
    }
}

请求参数

名称	类型	必填	描述
serviceId	string	是	服务ID，可以通过任一方式获取：方式一：通过调用接口创建服务，返回参数serviceId获取方式二：通过控制台-在线服务-我的服务页面，点击某服务详情查看，如下图所示：
protocolVersion	int	否	服务版本，可选值如下： · 1，默认1 · 2

返回参数

名称	类型	描述
requestId	string	请求ID
result	object	请求结果

result说明

名称	类型	描述
serviceId	string	服务ID
baseModel	string	基础模型版本
modelSetId	string	模型ID
modelId	string	模型版本ID
name	string	服务名称
description	string	服务描述
url	string	服务URL
serviceType	string	服务类型
runStatus	string	服务状态，说明： · New：待发布 · Deploying：发布中 · Serving：已发布 · Failed：发布失败 · Stopped：暂停服务
chargeType	string	付费类型，说明： · ComputingUnit: 算力单元使用时长 · Tokens: Tokens调用量
payType	string	付费方式，说明： · Prepay: 预付费 · Postpay: 后付费 · Prepay,Postpay: 预付费+后付费
chargeStatus	string	付费状态，说明： · NotOpen · Opened · Free
resourceConfig	object	资源配置
deploymentConfig	object	部署配置
isModelUpdating	bool	模型版本是否更新中
enableLogs	bool	是否绑定日志投递
logStoreConfig	object	日志投递信息
creator	string	创建人
createTime	string	创建时间
protocolVersion	int	服务版本

resourceConfig说明

名称	类型	描述
type	string	资源类型，说明： · GPU-I-2：AI加速卡-I型-2算力单元 · GPU-I-4：AI加速卡-I型-4算力单元 · CPU-I-2：CPU-I型-2算力单元
qps	float	单副本QPS
replicasCount	int	购买副本数量
region	string	资源地域，说明： · bj：北京 · bd：保定 · gz：广州 · su：苏州 · nj：南京

deploymentConfig说明

名称	类型	描述
type	string	资源类型，说明： · GPU-I-2：AI加速卡-I型-2算力单元 · GPU-I-4：AI加速卡-I型-4算力单元 · CPU-I-2：CPU-I型-2算力单元
region	string	资源地域，说明： · bj：北京 · bd：保定 · gz：广州 · su：苏州 · nj：南京
qps	float	单副本QPS
replicasComputeUnitCount	int	单副本算力单元数
replicasCount	int	部署副本总数
deploymentComputeUnitList	List<deploymentComputeUnit>	部署使用算力单元列表

deploymentComputeUnit说明

名称	类型	描述
instanceId	string	算力单元实例ID
deploymentReplicasCount	Int	部署副本数
deploymentComputingUnits	Int	部署使用算力单元数，等于单副本算力单元数*部署副本数
status	string	资源状态
paymentTiming	string	付费类型，具体值如下： · Prepaid：预付费 · Postpaid：表示后付费
expiredTime	string	算力单元实例的到期时间

logStoreConfig说明

名称	类型	描述
logRegion	string	日志集所在地域。当enableLogs为True，显示logRegion
logProject	string	日志组名称。当enableLogs为True，显示logProject
logStoreName	string	日志集名称。当enableLogs为True，显示logStoreName

获取定制服务列表

查询服务调用情况