获取应用列表
更新时间:2025-05-16
功能介绍
用于查询应用列表。
权限说明
调用本文API,需符合以下权限要求,权限介绍及分配,请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限:
- 完全控制千帆大模型平台的权限:QianfanFullControlAccessPolicy
- 只读访问千帆大模型平台的权限:QianfanReadAccessPolicy
- 只读访问千帆大模型平台预测服务的权限:QianfanServiceReadAccessPolicy
SDK调用
调用示例
1import os
2from qianfan import resources
3
4# 通过环境变量初始化认证信息
5# 使用安全认证AK/SK调用,替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk,如何获取请查看https://cloud.baidu.com/doc/Reference/s/9jwvz2egb
6os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
7os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"
8
9resp = resources.console.utils.call_action(
10 # 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
11 "/v2/application",
12 # 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
13 "DescribeApplications",
14 # 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
15 {
16 "protocolVersion": 2
17 }
18)
19
20print(resp.body)
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/application",
21 // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
22 "DescribeApplications",
23 // 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
24 map[string]interface{}{
25 "protocolVersion": 2,
26 })
27 if err != nil {
28 panic(err)
29 }
30 fmt.Println(string(res.Body))
31
32}
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/application")
15 // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
16 .action("DescribeApplications")
17 // 需要传入参数的场景,可以自行封装请求类,或者使用Map.of()来构建请求Body
18 // Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
19 // 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
20 .body(CollUtils.mapOf(
21 "protocolVersion", 2
22 ))
23 .execute();
24
25 System.out.println(Json.serialize(response));
26 }
27}
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/application', action: 'DescribeApplications', data: {
12 "protocolVersion": 2
13 }
14 });
15
16 console.log(res);
17}
18
19main();
返回示例
1{
2 "requestId": "c20ca6b6-1417-4fb2-8c7a-3e90bc5fe7f0",
3 "result": {
4 "appList": [
5 {
6 "dev_app_id": "app-Oy***0Gr",
7 "name": "app_test_v2"
8 },
9 {
10 "dev_app_id": "app-p***H",
11 "name": "app_jsx1_v2"
12 },
13 ........
14 ],
15 "pageInfo": {
16 "marker": "",
17 "maxKeys": 10,
18 "isTruncated": true,
19 "nextMarker": "app-Z****JP"
20 }
21 }
22}
1{
2 "requestId": "c20ca6b6-1417-4fb2-8c7a-3e90bc5fe7f0",
3 "result": {
4 "appList": [
5 {
6 "dev_app_id": "app-Oy***0Gr",
7 "name": "app_test_v2"
8 },
9 {
10 "dev_app_id": "app-p***H",
11 "name": "app_jsx1_v2"
12 },
13 ........
14 ],
15 "pageInfo": {
16 "marker": "",
17 "maxKeys": 10,
18 "isTruncated": true,
19 "nextMarker": "app-Z****JP"
20 }
21 }
22}
1{
2 requestId: 'c20ca6b6-1417-4fb2-8c7a-3e90bc5fe7f0',
3 result: {
4 appList: [
5 {
6 dev_app_id: 'app-Oy***0Gr',
7 name: 'app_test_v2'
8 },
9 {
10 dev_app_id: 'app-p***H',
11 name: 'app_jsx1_v2'
12 },
13 ........
14 ],
15 pageInfo: {
16 marker: '',
17 maxKeys: 10,
18 isTruncated: true,
19 nextMarker: 'app-Z****JP'
20 }
21 }
22}
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
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的值 |