查询应用列表 | 大装置帮助中心
跳到主要内容

查询应用列表

接口描述​

GET /compute/workspace/data/v1/subscriptions/{subscription_name}/resourceGroups/{resource_group_name}/zones/{zone}/workspaces/{workspace_name}/apps

调试接口

请求头（Request Header）​

参考认证（authentication）

请求参数（Request Parameters）​

名称位置类型必须默认值取值范围描述
subscription_namepathstringtrue------(资源ID)订阅
resource_group_namepathstringtrue------(资源ID)资源组
zonepathstringtrue------(资源ID)可用区
workspace_namepathstringtrue------(资源ID)工作空间资源名称
statequerystring(enum)false------应用状态
owner_idquerystringfalse------拥有者唯一标识
match_display_namequerystringfalse------过滤显示名. 当为空字符串时表示不过滤显示名
page_sizequeryinteger(int32)false------可选，每一页的大小，需为非负整数，如果不填或填0，则忽略page_token，返回所有数据
page_tokenquerystringfalse------可选，查询第几页，需为正整数字符串，缺省值为"1"
filterquerystringfalse------可选，过滤条件. 当前支持按照创建时间进行过滤，如：'begin_date':'2023-02-08T08:13:24.660710Z','end_date':'2023-02-08T08:16:15.498162Z'，左闭右开

请求体（Request Body）​

无

请求示例（Request Example）​

curl --request GET \
  --url https://example.com/compute/workspace/data/v1/subscriptions/string/resourceGroups/string/zones/string/workspaces/string/apps \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

响应参数（Response Parameters）​

名称类型描述
appsarray应用
total_sizeint符合当前查询条件的后台数据总数(不是当前返回数据总数)
名称类型描述
» metadataMetadata对象的元数据
»» uidstring唯一标识
»» deletedboolean资源是否已删除
»» create_timestring(date-time)资源创建时间
»» update_timestring(date-time)资源更新时间
» ownershipOwnership所有权关系
»» creator_idstring创建者id
»» owner_idstring拥有者id
»» tenant_idstring租户id
»» creator_namestring创建者name
» infoAppInfotrue
»» subscription_namestring订阅
»» resource_group_namestring(资源ID)资源组
»» zonestring(资源ID)可用区
»» workspace_namestring(资源ID)工作空间资源名称
»» workspace_display_namestring(资源ID)工作空间资源名称
»» aec2_namestringtrue
»» aec2_idstringAI弹性计算集群id
»» vpc_idstring虚拟私有集群
»» namestring应用名称. 填写需要遵循规范，如果不填写，则由后台随机生成
»» display_namestringtrue
»» descriptionstring应用描述
» templateInstanceTemplatetrue
»» init_containers[Container]初始化容器列表
»»» namestring容器名称
»»» image_typestring(enum)true
»»» imagestringtrue
»»» image_display_namestring镜像名,用于页面展示
»»» command[string]容器命令列表
»»» env[EnvVar]容器环境变量列表
»»»» namestringtrue
»»»» valuestringtrue
»»»» need_mosaicbooleantrue
»»» need_cacheboolean启动缓存
»»» container_typestring(enum)容器类型
»»» resource_requestobject容器资源请求. 若资源请求为空时，直接取用resource spec的规格
»»»» additionalPropertiesstringnone
»»» volume_mounts[VolumeMount]卷挂载
»»»» typestring(enum)挂载类型
»»»» namestring卷名
»»»» mount_pathstring挂载路径
»»»» afs_idstringAI文件存储配置
»»»» volume_capacitystring卷容量
»» containers[Container]容器列表
»» compute_resource_specComputeResourceSpectrue
»»» namestringtrue
» scalingScalingtrue
»» scaling_strategystringtrue
»» replicasinteger(int32)true
»» cpu_loadinteger(int32)cpu负载
»» min_replicasinteger(int32)最小副本数
»» max_replicasinteger(int32)最大副本数
» networkingNetworking网络配置
»» access_portinteger(int32)true
»» intranet_ipstring内网访问IP
»» intranet_domain_namestring内网访问域名
» schedulingSchedulingtrue
»» prioritystring(enum)true
»» cluster_idstring被调度集群id
»» resource_pool_idstring资源池id
» ready_replicasinteger(int32)应用当前副本中运行中状态的副本数量
» statestring(enum)应用状态
» transition_errorstring失败原因
» need_cacheboolean启动缓存, 每个容器内也有对应配置, 会被内部配置覆盖
» app_port[integer]true
» execution_typestring(enum)true
» aec2AEC2应用所属集群
»» idstringaec2 id
»» uidstringaec2的uuid
»» namestring资源标识
»» display_namestring资源名称
»» statestring资源状态
» last_operation_typestring(enum)service上一次操作
» resource_specResourceSpec资源规格属性
»» idstring资源规格标识
»» namestring资源规格标识
»» descriptionstring资源规格描述
»» categorystring资源规格类型, eg.ACN/JOB/CCI
»» sku_idstring云管sku_id
»» cpuCPUCPU
»»» manufacturerstringcpu厂商. 例: Intel/AMD/Hygon
»»» typestringCPU 类型. 例: 2680v4/6146
»»» frequencynumber(float)CPU 主频
»»» vcpu_allocatableinteger(int32)可分配vCPU数量
»»» vcpu_capacityinteger(int32)物理vCPU总量(暂未使用)
»» memoryMemory内存
»»» allocatablenumber(float)可分配内存
»»» capacitynumber(float)物理内存总量(暂未使用)
»» deviceDevice加速芯片
»»» manufacturerstring加速芯片厂商. 例:NVIDIA/DCU
»»» typestring加速芯片类型. 例:A100/A800/Z800
»»» memorynumber(float)显存
»»» numberinteger(int32)加速芯片数量
»»» physical_interfacestring显卡物理形态
»» training_networkTrainingNetwork训练网
»»» networkNetwork网络
»»»» typestring网络类型. 例:IB/RoCE
»»»» nics_numberinteger(int32)网卡数量
»»»» bandwidthstring网络带宽
»»» namestring训练网编号
»» service_networkServiceNetwork业务网
»»» networkNetwork网络
»» data_networkDataNetwork数据网
»»» networkNetwork网络
»» storageStorage存储
»» customstring自定义字段
参数取值
» stateUNKNOWN_APP_STATE
» stateINIT
» stateUPDATING
» stateQUEUING
» stateSCHEDULED
» statePROGRESSING
» stateRUNNING
» stateFAILED
» stateDELETING
» stateDELETED
» stateSUSPENDING
» stateSUSPENDED
» execution_typeUNKNOWN
» execution_typeSTART
» execution_typeSUSPEND
» last_operation_typeCREATION
» last_operation_typeUPDATE
» last_operation_typeSUSPENSION
» last_operation_typeDELETION

响应示例（Response Example）​

{
    "apps": [
        {
            "metadata": {
                "uid": "qdma7pfgkadofjoiqgu44s29fp4hnns96ty0",
                "deleted": false,
                "create_time": "2023-12-13T08:47:51.136723Z",
                "update_time": "2023-12-13T08:47:51.136723Z"
            },
            "ownership": {
                "creator_id": "01bf84bf-92e0-4774-9e36-c31f852d28c8",
                "owner_id": "01bf84bf-92e0-4774-9e36-c31f852d28c8",
                "tenant_id": "d1f3a37a-995b-409d-8001-97a5f48a88da",
                "creator_name": "acptest"
            },
            "info": {
                "subscription_name": "d1f3a37a-995b-409d-8001-97a5f48a88da",
                "resource_group_name": "default",
                "zone": "cn-sh-01a",
                "workspace_name": "e87cb6db-863c-4392-b6c7-31c04e91d462",
                "workspace_display_name": "test_jiangxiaowei",
                "aec2_name": "e4a32c09-2eda-4b2e-a5ed-f73e11330a20",
                "aec2_id": "20ffa01a-2564-11ee-9c2c-c6bcf437a3e9",
                "vpc_id": "",
                "name": "app-x12or2jz",
                "display_name": "msw_test",
                "description": ""
            },
            "template": {
                "init_containers": [],
                "containers": [
                    {
                        "name": "mswtest",
                        "image_type": "OFFICIAL",
                        "image": "registry.sensecore.tech/lepton-cci-dev/ubuntu20.04-cuda12.2-tritonserver2.6.0-amd64:20230830-121344",
                        "image_display_name": "lepton-cci-dev/ubuntu20.04-cuda12.2-tritonserver2.6.0-amd64:20230830-121344",
                        "command": [],
                        "env": [],
                        "need_cache": false,
                        "container_type": "MAIN",
                        "resource_request": {
                            "cpu": "1",
                            "memory": "8GiB",
                            "nvidia.com/gpu": "1"
                        },
                        "volume_mounts": []
                    }
                ],
                "compute_resource_spec": {
                    "name": "N2lS.Ie.I60.1"
                }
            },
            "scaling": {
                "scaling_strategy": "",
                "replicas": 1,
                "cpu_load": 0,
                "min_replicas": 0,
                "max_replicas": 0
            },
            "networking": {
                "access_port": 0,
                "intranet_ip": "",
                "intranet_domain_name": "app-x12or2jz.ns-acptest-22ecc49f.svc.cluster.local"
            },
            "scheduling": {
                "priority": "HIGH",
                "cluster_id": "",
                "resource_pool_id": ""
            },
            "ready_replicas": 0,
            "state": "QUEUING",
            "transition_error": "",
            "need_cache": false,
            "app_port": [
                200
            ],
            "execution_type": "START",
            "aec2": {
                "id": "/subscriptions/d1f3a37a-995b-409d-8001-97a5f48a88da/resourceGroups/default/zones/cn-sh-01a/aec2s/e4a32c09-2eda-4b2e-a5ed-f73e11330a20",
                "uid": "20ffa01a-2564-11ee-9c2c-c6bcf437a3e9",
                "name": "e4a32c09-2eda-4b2e-a5ed-f73e11330a20",
                "display_name": "test_jiangxiaowei",
                "state": "ACTIVE",
                "type": "private"
            },
            "last_operation_type": "CREATION",
            "resource_spec": {
                "id": "N2lS.Ie.I60.1",
                "name": "N2lS.Ie.I60.1",
                "description": "1XA100-80GB",
                "category": "JOB",
                "sku_id": "N2lS.Ie.I60",
                "cpu": {
                    "manufacturer": "Intel",
                    "type": "6348",
                    "frequency": 2.6,
                    "vcpu_allocatable": 12,
                    "vcpu_capacity": 0
                },
                "memory": {
                    "allocatable": 120,
                    "capacity": 0
                },
                "device": {
                    "manufacturer": "NVIDIA",
                    "type": "A100",
                    "memory": 80,
                    "number": 1,
                    "physical_interface": "SXM4"
                },
                "training_network": {
                    "network": {
                        "type": "IB",
                        "nics_number": 2,
                        "bandwidth": "200G"
                    },
                    "name": ""
                },
                "service_network": {
                    "network": {
                        "type": "",
                        "nics_number": 0,
                        "bandwidth": ""
                    }
                },
                "data_network": {
                    "network": {
                        "type": "",
                        "nics_number": 0,
                        "bandwidth": ""
                    }
                },
                "storage": null,
                "custom": ""
            }
        }
    ],
    "next_page_token": "",
    "total_size": 1
}