# 查询应用实例列表 - ListPods #### 功能介绍 查询应用实例列表 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/IEF/doc?api=ListPods)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ief/ief_02_1003.html)。 #### URI GET /v3/{project_id}/edgemgr/pods 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | node_id | 否 | String | 指定节点查询应用实例，可选， 与group_id、deployment_id、deployment_ids四选一 | | group_id | 否 | String | 指定节点组查询应用实例，可选，与node_id、deployment_id、deployment_ids四选一 | | deployment_id | 否 | String | 指定应用部署ID查询应用实例，可选， 与node_id、group_id、deployment_ids四选一 | | deployment_ids | 否 | String | 指定应用部署ID列表查询应用实例，多个ID使用逗号分隔，可选， 与node_id、group_id、deployment_id四选一 | | plugin_instance_name | 否 | String | 指定插件实例名称查询对应的应用实例列表，可选 | | limit | 否 | Integer | 查询返回记录的数量限制 | | offset | 否 | Integer | 偏移量，表示查询该偏移量后面的记录 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Content-Type | 是 | String | 消息体的类型（格式），默认取值为"application/json"。 | | X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 | | ief-instance-id | 否 | String | 企业版实例ID，专业版实例为空值。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | count | Integer | 应用实例总数 | | pods | Array of [PodResp] objects | 应用实例列表 | 表5PodResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 应用实例uuid | | name | String | 应用实例名称 | | configs | [PodConfigs] object | 应用实例配置 | | init_containers | Array of [ContainerResp] objects | 应用实例init容器 | | containers | Array of [ContainerResp] objects | 应用实例业务容器 | | node_id | String | 应用实例所在节点 | | deployment_id | String | 应用ID | | project_id | String | 项目ID | | reason | String | 应用实例故障原因 | | message | String | 应用实例故障详情 | | created_at | String | 应用实例创建时间 | | state | String | 应用实例状态： - RUNNING：实例运行中 - PENDING：实例等待创建 - SUCCEEDED：实例执行成功 - FAILED：实例运行失败 - CREATE_FAIL：实例创建失败 - TERMINATING：实例终止中 - PENDING_DELETE：实例等待删除 - DELETE_FAILED：实例删除失败 - FREEZE：实例冻结 - UNKNOWN：实例状态未知 | 表6PodConfigs | 参数 | 参数类型 | 描述 | |:---|:---|:---| | host_network | Boolean | 应用实例是否启用主机网络，不启用则使用端口映射，默认值false | | host_pid | Boolean | 应用实例是否与主机共PID命名空间，默认值false | | migration | Boolean | 应用实例故障是否迁移，指定节点组部署时必选，默认值false | | restart_policy | String | 应用实例重启策略，可选值Always、OnFailure、Never | | toleration_seconds | Integer | 应用实例故障容忍时间，容忍时间到达后迁移应用实例，只在指定节点组部署时生效 | | dns_policy | String | 应用实例DNS策略，可选值Default、ClusterFirst、ClusterFirstWithHostNet，默认为Default。应用实例启用主机网络时只能选填Default、ClusterFirstWithHostNet，不启用主机网络时只能选填Default、ClusterFirst | 表7ContainerResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | args | Array of strings | 容器启动参数，字符总长度最大为65536 | | command | Array of strings | 容器启动命令，字符总长度最大为65536。 command支持使用数组定义多条命令，但在IEF控制台界面只会显示第一条命令。 | | name | String | 容器名称，只允许英文小写字母、数字、中划线，最大长度32， 英文小写字母或数字开头和结尾 | | envs | Array of [EnvPods] objects | 环境变量 | | image_url | String | 容器镜像URL | | version | String | 容器镜像版本 | | liveness_probe | [Probe] object | 探针配置 | | readiness_probe | [Probe] object | 探针配置 | | ports | Array of [HostContainerPort] objects | 容器端口映射值 | | resources | [DeploymentResources] object | 创建容器时使用的资源 | | volumes | Array of [Volumes] objects | 卷配置 | | restarts | Long | 容器重启次数 | | message | String | 容器故障详情 | | reason | String | 容器故障原因 | | is_ready | String | 健康检查结果 | | privileged | Boolean | 是否启用特权容器，默认值false | | container_id | String | 容器ID | | state | String | 容器状态 | | npu_type | String | NPU类型，支持D310、D310B，支持填写： - D310：D310类型 - D310B：D310B类型 - 不填表示为D310类型。 | 表8EnvPods | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | 环境变量的key，由大小写字母或下划线开头，由数字、大小写字母、下划线组成，最大长度2048个字符，不允许重复 | | value | String | 环境变量的value，最大长度20480个字符。value、value_from和field_path必须三选一使用。 | 表9Probe | 参数 | 参数类型 | 描述 | |:---|:---|:---| | exec | [Exec] object | 执行命令检查，与http_get二选一 | | http_get | [HttpGetDetail] object | 执行http探测 | | initial_delay_seconds | Integer | 表示从工作负载启动后从多久开始探测，大于0且不大于3600的整数，默认为10 | | timeout_seconds | Integer | 表示探测超时时间，大于0且不大于3600的整数，默认为1 | 表10Exec | 参数 | 参数类型 | 描述 | |:---|:---|:---| | command | String | 探针执行命令，最大长度10240个字符 | 表11HttpGetDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | path | String | 必须要以/开头，构造结果为：协议类型://主机地址:端口路径 | | port | Integer | 探测的http端口，1到65535之间的整数 | | host | String | 请求的主机地址，默认为容器IP | | scheme | String | 协议类型，HTTP或HTTPS，默认HTTP | 表12HostContainerPort | 参数 | 参数类型 | 描述 | |:---|:---|:---| | container_port | Integer | 构成一对映射的容器端口 | | host_port | Integer | 构成一对映射的物理机对应网卡端口 | | host_ip | String | 对应网卡地址 | 表13DeploymentResources | 参数 | 参数类型 | 描述 | |:---|:---|:---| | limits | Map\ | - 允许容器使用的最大资源，key值支持填写：cpu, memory, gpu, npu。 - 申请NPU资源时可填写指定的NPU芯片类型，支持填写：D310、D310B。注意：key值填写为npu时，默认使用npu_type字段指定的芯片类型。如果npu_type字段为空，默认使用D310芯片类型。 | | requests | Map\ | - 容器需要使用的最小资源，key值支持填写：cpu, memory, gpu, npu - 申请NPU资源时可填写指定的NPU芯片类型，支持填写：D310、D310B。注意：key值填写为npu时，默认使用npu_type字段指定的芯片类型。如果npu_type字段为空，默认使用D310芯片类型。 | 表14Volumes | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | 卷名称，小写字母或数字，最长63个字符 | | type | String | 卷的类型，支持configMap,secret,emptyDir,hostPath | | source | String | 卷来源，type为hostPath时输入路径，要求以/开头，后面可包含中划线，反斜杠，下划线，点号，字母，数字； secret时输入secret名称，configMap时输入configMap名称，emptyDir时输入disk或memory | | destination | String | 卷挂载路径，必须是合法的路径 | | read_only | Boolean | 读写权限，configMap和secret类型只支持读权限 | | default_mode | Integer | 挂载的文件权限，仅configMap和secret类型生效，填写值为十进制表示的linux文件权限，默认为420（对应权限644） | **状态码：400** 表15响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述信息 | **状态码：500** 表16响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述信息 | #### 请求示例 ``` GET https://{endpoint}//v3/{project_id}/edgemgr/pods?deployment_ids=a71077f0-a491-4e1c-a41a-7d6910da26cb,77340b19-b52e-4708-83fd-3ca86f5a292e ``` #### 响应示例 **状态码：200** ok ``` { "count" : 1, "pods" : [ { "id" : "3e64d98a-37c5-43a6-9bfe-052b9083e362", "name" : "app-test-69f9dc4b67-wfwn6", "configs" : { "host_network" : true, "host_pid" : true, "migration" : true, "restart_policy" : "Always", "toleration_seconds" : 300 }, "containers" : [ { "args" : [ "-c", "sleep 1000" ], "command" : [ "/bin/bash" ], "name" : "container-0", "envs" : [ { "name" : "CERT_PATH", "value" : "/opt/cert" } ], "image_url" : "nginx:latest", "npu_type" : "", "liveness_probe" : { "http_get" : { "path" : "/", "port" : 80, "scheme" : "http" }, "initial_delay_seconds" : 10, "timeout_seconds" : 10 }, "readiness_probe" : { "http_get" : { "path" : "/", "port" : 80, "scheme" : "http" }, "initial_delay_seconds" : 10, "timeout_seconds" : 10 }, "ports" : [ { "container_port" : 80, "host_port" : 80 } ], "resources" : { "limits" : { "cpu" : 0.25, "memory" : 500, "gpu" : 500 }, "requests" : { "cpu" : 0.25, "memory" : 500, "gpu" : 500 } }, "volumes" : [ { "name" : "log-volume", "type" : "hostPath", "read_only" : false, "source" : "/var/IEF", "destination" : "/var/IEF" } ], "restarts" : 0, "message" : "", "reason" : "" } ], "node_id" : "bcd83056c918480f8f190844bd425b23", "project_id" : "bcd83056c918480f8f190844bd425b23", "reason" : "", "message" : "", "created_at" : "2019-10-10T02:24:02.325Z", "state" : "RUNNING" } ] } ``` **状态码：400** error ``` { "error_code" : "IEF.100001", "error_msg" : "PROJECT_ID not found" } ``` **状态码：500** error ``` { "error_code" : "IEF.100158", "error_msg" : "Fail to extract gpu infomation" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | ok | | 400 | error | | 500 | error | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-ief/ErrorCode.html)。