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

获取应用列表

功能介绍

用于查询应用列表。

权限说明

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

  • 完全控制千帆大模型平台的权限:QianfanFullControlAccessPolicy
  • 只读访问千帆大模型平台的权限:QianfanReadAccessPolicy
  • 只读访问千帆大模型平台预测服务的权限: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,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
    "/v2/application", 
    # 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action 
    "DescribeApplications", 
    # 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
    {
        "protocolVersion": 2
    }
)

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/application",
    // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action 
    "DescribeApplications",
    // 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
    map[string]interface{}{
        "protocolVersion": 2
    })
    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/application")
                // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action 
                .action("DescribeApplications")
                // 需要传入参数的场景,可以自行封装请求类,或者使用Map.of()来构建请求Body
                // Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
                // 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
                .body(CollUtils.mapOf(
                    "protocolVersion", 2
                ))
                .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/application', action: 'DescribeApplications', data:     {
        "protocolVersion": 2
    }
  });    
    
  console.log(res);
}

main();

返回示例

{
    "requestId": "c20ca6b6-1417-4fb2-8c7a-3e90bc5fe7f0",
    "result": {
        "appList": [
            {
                "appId": "app-Oy***0Gr",
                "name": "app_1_v2",
                "description": "app_1_v2"

            },
            {
                "appId": "app-p***H",
                "name": "app_2_v2",
                "description": "app_2_v2"

            },
           ........
        ],
        "pageInfo": {
            "marker": "",
            "maxKeys": 10,
            "isTruncated": True,
            "nextMarker": "app-Z****JP"
        }
    }
}
{
    "requestId": "c20ca6b6-1417-4fb2-8c7a-3e90bc5fe7f0",
    "result": {
        "appList": [
            {
                "appId": "app-Oy***0Gr",
                "name": "app_1_v2",
                "description": "app_1_v2"

            },
            {
                "appId": "app-p***H",
                "name": "app_2_v2",
                "description": "app_2_v2"

            },
           ........
        ],
        "pageInfo": {
            "marker": "",
            "maxKeys": 10,
            "isTruncated": true,
            "nextMarker": "app-Z****JP"
        }
    }
}
{
    "requestId": "c20ca6b6-1417-4fb2-8c7a-3e90bc5fe7f0",
    "result": {
        "appList": [
            {
                "appId": "app-Oy***0Gr",
                "name": "app_1_v2",
                "description": "app_1_v2"

            },
            {
                "appId": "app-p***H",
                "name": "app_2_v2",
                "description": "app_2_v2"

            },
           ........
        ],
        "pageInfo": {
            "marker": "",
            "maxKeys": 10,
            "isTruncated": true,
            "nextMarker": "app-Z****JP"
        }
    }
}
{
    requestId: 'c20ca6b6-1417-4fb2-8c7a-3e90bc5fe7f0',
    result: {
        appList: [
            {
                appId: 'app-Oy***0Gr',
                name: 'app_1_v2',
                description: 'app_1_v2'

            },
            {
                appId: 'app-p***H',
                name: 'app_2_v2',
                description: 'app_2_v2'

            },
           ........
        ],
        pageInfo: {
            marker: '',
            maxKeys: 10,
            isTruncated: true,
            nextMarker: 'app-Z****JP'
        }
    }
}

请求参数

名称 类型 必填 描述
marker string 本次查询的起始位置,默认从第一条数据开始
maxKeys int 请求列表长度,说明:
(1)默认值是10
(2)列表长度最大为100,如果指定的值大于100,按100操作
pageReverse bool 是否倒序,默认为false
creator List<string> 创建人,说明:填写此参数,表示按创建人进行筛选
protocolVersion int 推理接口版本,默认为2

返回参数

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

result说明

名称 类型 描述
appList List<object> 应用列表
pageInfo object 分页信息

appList说明

名称 类型 描述
appName string 应用名称
appId string 应用ID

pageInfo说明

名称 类型 描述
marker string 本次查询的起始位置,说明:若是从第一条数据查询,该字段返回值为空
maxKeys int 请求返回的列表长度,说明:
(1)默认值是10
(2)列表长度最大为100,如果指定的值大于100,按100操作
isTruncated bool 指明是否只返回了部分数据,说明:
· false:表示本次已经返回所有结果
· true:表示本次还没有返回所有结果
nextMarker string 当isTruncated为true时,返回该字段,作为下次查询marker的值
上一篇
用户记忆
下一篇
创建应用