更新时间:2021-12-27 GMT+08:00
分享

查询应用实例列表

功能介绍

查询应用实例列表

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/{project_id}/edgemgr/pods

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

表2 Query参数

参数

是否必选

参数类型

描述

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四选一

limit

Integer

查询返回记录的数量限制

offset

Integer

偏移量,表示查询该偏移量后面的记录

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

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

应用实例列表

表5 PodResp

参数

参数类型

描述

id

String

应用实例uuid

name

String

应用实例名称

configs

PodConfigs object

应用实例配置

affinity

Affinity 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

应用实例创建时间

updated_at

String

应用实例更新时间

state

String

应用实例状态

表6 PodConfigs

参数

参数类型

描述

host_network

Boolean

应用实例是否启用主机网络,不启用则使用端口映射,默认值false

host_pid

Boolean

应用实例是否与主机共PID命名空间,默认值false

migration

Boolean

应用实例故障是否迁移,指定节点组部署时必选,默认值false

restart_policy

String

应用实例重启策略,可选值Always、OnFailure、Never

toleration_seconds

Integer

应用实例故障容忍时间,容忍时间到达后迁移应用实例,只在指定节点组部署时生效

表7 Affinity

参数

参数类型

描述

nodeAffinity

nodeAffinity object

节点亲和规则

podAffinity

podAffinity object

Pod亲和规则

podAntiAffinity

podAntiAffinity object

Pod反亲和规则

表8 nodeAffinity

参数

参数类型

描述

preferredDuringSchedulingIgnoredDuringExecution

Array of PreferredSchedulingTerm objects

优先使用定义的规则调度,且不会影响已经在节点上运行的Pod。即优先选择调度到满足规则的节点,但也可能会调度到不满足规则的节点。

requiredDuringSchedulingIgnoredDuringExecution

RequiredDuringScheduling object

强制使用定义的规则调度,且不会影响已经在节点上运行的Pod。即强制选择调度到满足规则的节点,不会调度到不满足规则的节点。

表9 PreferredSchedulingTerm

参数

参数类型

描述

preference

preference object

与相应权重关联的节点选择器项。

weight

Integer

权重,范围为1-100

表10 preference

参数

参数类型

描述

matchExpressions

Array of MatchExpression objects

匹配规则表达式

表11 RequiredDuringScheduling

参数

参数类型

描述

nodeSelectorTerms

Array of MatchExpressions objects

节点选择规则

表12 MatchExpressions

参数

参数类型

描述

matchExpressions

Array of MatchExpression objects

匹配规则表达式

表13 podAffinity

参数

参数类型

描述

preferredDuringSchedulingIgnoredDuringExecution

Array of WeightPodAffinityTerms objects

优先使用定义的规则调度,且不会影响已经在节点上运行的Pod。即优先选择调度到满足规则的节点,但也可能会调度到不满足规则的节点。

requiredDuringSchedulingIgnoredDuringExecution

Array of PodAffinityTerm objects

强制使用定义的规则调度,且不会影响已经在节点上运行的Pod。即强制选择调度到满足规则的节点,不会调度到不满足规则的节点。

表14 podAntiAffinity

参数

参数类型

描述

preferredDuringSchedulingIgnoredDuringExecution

Array of WeightPodAffinityTerms objects

优先使用定义的规则调度,且不会影响已经在节点上运行的Pod。即优先选择调度到满足规则的节点,但也可能会调度到不满足规则的节点。

requiredDuringSchedulingIgnoredDuringExecution

Array of PodAffinityTerm objects

强制使用定义的规则调度,且不会影响已经在节点上运行的Pod。即强制选择调度到满足规则的节点,不会调度到不满足规则的节点。

表15 WeightPodAffinityTerms

参数

参数类型

描述

podAffinityTerm

podAffinityTerm object

Pod亲和规则

weight

Integer

权重,范围为1-100

表16 podAffinityTerm

参数

参数类型

描述

labelSelector

LabelSelector object

标签选择器

namespaces

Array of strings

命名空间

topologyKey

String

拓扑标签。 先圈定topologyKey指定的范围,然后再选择labelSelector定义的内容,即亲和调度只会在有topologyKey指定的标签节点上调度。

表17 LabelSelector

参数

参数类型

描述

matchExpressions

Array of MatchExpression objects

匹配规则表达式

matchLabels

Map<String,String>

匹配的标签,格式为key:value键值对。 单个键值对相当于matchExpressions的一个元素,key字段为key,操作符为In,values数组中只有value。

表18 PodAffinityTerm

参数

参数类型

描述

labelSelector

labelSelector object

标签选择器

namespaces

Array of strings

命名空间

topologyKey

String

拓扑标签。 先圈定topologyKey指定的范围,然后再选择labelSelector定义的内容,即亲和调度只会在有topologyKey指定的标签节点上调度。

表19 labelSelector

参数

参数类型

描述

matchExpressions

Array of MatchExpression objects

匹配规则表达式

matchLabels

Map<String,String>

匹配的标签,格式为key:value键值对。 单个键值对相当于matchExpressions的一个元素,key字段为key,操作符为In,values数组中只有value。

表20 MatchExpression

参数

参数类型

描述

key

String

规则的标签

operator

String

操作符,取值如下。 In:标签值需要在values的列表中 NotIn:标签的值不在某个列表中 Exists:某个标签存在 DoesNotExist:某个标签不存在 Gt:标签的值大于某个值(字符串比较) Lt:标签的值小于某个值(字符串比较)

values

Array of strings

一组标签值。 如果运算符为In或NotIn,则值数组必须非空。 如果运算符为Exists 或DoesNotExist,则值数组必须为空。 如果运算符是Gt或Lt,则值数组必须具有单个元素,该元素将被解释为整数。

表21 ContainerResp

参数

参数类型

描述

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类型和D910类型。

  • D310表示D310类型。

  • D910表示D910类型。

  • 不填表示为D310类型。

表22 EnvPods

参数

参数类型

描述

name

String

环境变量的key,由大小写字母或下划线开头,由数字、大小写字母、下划线组成,最大长度2048个字符,不允许重复

value

String

环境变量的value,最大长度20480个字符。value、value_from和field_path必须三选一使用。

表23 Probe

参数

参数类型

描述

exec

exec object

执行命令检查,与http_get二选一

http_get

http_get object

执行http探测

initial_delay_seconds

Integer

表示从工作负载启动后从多久开始探测,大于0且不大于3600的整数,默认为10

timeout_seconds

Integer

表示探测超时时间,大于0且不大于3600的整数,默认为1

表24 exec

参数

参数类型

描述

command

String

探针执行命令,最大长度10240个字符

表25 http_get

参数

参数类型

描述

path

String

必须要以/开头,构造结果为:协议类型://主机地址:端口路径

port

Integer

探测的http端口,1到65535之间的整数

host

String

请求的主机地址,默认为容器IP

scheme

String

协议类型,HTTP或HTTPS,默认HTTP

表26 exec

参数

参数类型

描述

command

String

探针执行命令,最大长度10240个字符

表27 http_get

参数

参数类型

描述

path

String

必须要以/开头,构造结果为:协议类型://主机地址:端口路径

port

Integer

探测的http端口,1到65535之间的整数

host

String

请求的主机地址,默认为容器IP

scheme

String

协议类型,HTTP或HTTPS,默认HTTP

表28 HostContainerPort

参数

参数类型

描述

container_port

Integer

构成一堆映射的容器端口

host_port

Integer

构成一对映射的物理机对应网卡端口

host_ip

String

对应网卡地址

表29 DeploymentResources

参数

参数类型

描述

limits

Map<String,String>

允许容器使用的最大资源

requests

Map<String,String>

容器需要使用的最小资源

表30 Volumes

参数

参数类型

描述

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类型只支持读权限

状态码: 400

表31 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述信息

状态码: 500

表32 响应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",
    "description" : "this is a test pod",
    "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" : "swr.cn-north-1.myhuaweicloud.com/ief-test/nginx:0705",
      "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",
    "updated_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

错误码

请参见错误码

分享:

    相关文档

    相关产品

关闭导读