DescribeServerlessJobs - 查询Serverless作业详细信息

按照作业ID或子任务ID(数组作业)查询Serverless作业详细信息。当前仅支持传入单个作业ID或单个子任务ID。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ehpc:DescribeServerlessJobsRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ClusterIdstring

集群 ID。

您可以通过调用 ListClusters 获取集群 ID。

ehpc-hz-FYUr32****
JobIdsarray

Serverless 作业 ID 或子任务 ID(数组作业)列表。

说明
  • 当 Serverless 作业为数组作业时,仅支持传入子任务 ID。子任务 ID 格式为:<数组作业 ID>_<子任务索引>。例如:10_3 表示 ID 为 10 的数组作业中索引为 3 的子任务。
  • 该列表当前仅支持传入一个元素。
  • string

    Serverless 作业 ID 或子任务 ID(数组作业)。

    5

    返回参数

    名称类型描述示例值
    object
    TotalCountinteger

    本次请求条件下的数据总条数。

    1
    RequestIdstring

    请求 ID。

    04F0F334-1335-436C-A1D7-6C044FE73368
    JobInfosobject []

    Serverless 作业详细信息列表。

    JobIdstring

    Serverless 作业 ID 或子任务 ID(数组作业)。

    5
    JobNamestring

    Serverless 作业名。

    testjob
    Statestring

    Serverless 作业状态。可能的值:

    • Pending: 排队中。
    • Initing:初始化中。
    • Running:运行中。
    • Succeeded:已完成。
    • Canceled:已取消。
    • Failed:运行失败。
    Running
    Prioritylong

    Serverless 作业的调度优先级。

    9
    Queuestring

    执行 Serverless 作业的队列名。

    comp
    Userstring

    执行 Serverless 作业的用户名。

    testuser
    SubmitTimelong

    Serverless 作业提交时间戳。

    1647423718
    StartTimelong

    Serverless 作业开始时间戳。

    1647427667
    EndTimelong

    Serverless 作业结束时间戳。

    1662016121
    LastModifyTimelong

    Serverless 作业最近修改时间戳。

    1663831441000
    IsArrayJobboolean

    是否是数组作业。

    false
    ArrayPropertiesobject

    数组作业属性。

    IndexStartlong

    数组作业索引的起始值

    1
    IndexEndlong

    数组作业索引的结束值。

    5
    IndexSteplong

    数组作业索引的间隔。

    2
    ContainerGroupsobject []

    Serverless 作业容器组实例信息列表。

    ContainerGroupIdstring

    容器组实例 ID。

    eci-bp1jrgfqqy54kg5hc****
    ContainerGroupNamestring

    容器组实例名称。

    test
    Statusstring

    实例状态。取值范围:

    • Pending:启动中

    • Running:运行中

    • Succeeded:运行成功

    • Failed:运行失败

    • Scheduling:创建中

    • ScheduleFailed:创建失败

    • Restarting:重启中

    • Updating:更新中

    • Terminating:终止中

    • Expired:过期

    Running
    InstanceTypestring

    指定的 ECS 实例规格。

    ecs.g5.large
    SpotStrategystring

    实例的抢占策略。取值范围:

    • NoSpot(默认):正常按量付费节点。
    • SpotWithPriceLimit:设置上限价格的抢占式节点。
    • SpotAsPriceGo:系统自动出价,跟随当前市场实际价格。
    NoSpot
    SpotPriceLimitfloat

    抢占式实例的每小时最高价格。

    仅当 SpotStrategy 为 SpotWithPriceLimit 时返回。

    0.025
    Cpufloat

    容器的 vCPU 大小。

    2
    Memoryfloat

    实例级别内存大小。单位为 GiB。

    4.0
    Containersobject []

    容器组包含的容器列表。

    Argsarray

    容器启动参数。

    string

    容器启动参数。

    hello.py
    Commandsarray

    容器启动命令。

    string

    容器启动命令。

    /usr/bin/python
    Cpufloat

    容器的 vCPU 大小。

    2.0
    CurrentStateobject

    容器当前状态。

    DetailStatusstring

    容器状态详情。

    working
    ExitCodelong

    容器运行退出码。

    0
    FinishTimestring

    容器运行结束时间。

    2018-08-02T15:00:00Z
    Messagestring

    容器状态信息。

    Back-off 5m0s restarting failed container=test pod=test_eci-xxx(xxx)
    Reasonstring

    容器状态 Reason。

    Started
    Signallong

    容器状态信号。

    1
    StartTimestring

    容器运行开始时间。

    2019-12-19T12:05:02Z
    Statestring

    作业状态。可能值:

    • Waiting
    • Running
    • Terminated
    Terminated
    EnvironmentVarsobject []

    环境变量。

    Keystring

    环境变量名。

    PATH
    Valuestring

    环境变量值。

    /usr/bin/
    ValueFromobject

    环境变量值的来源。 如果值不为空,则无法使用。

    FieldRefobject

    指定字段。

    FieldPathstring

    字段的路径。

    status.podIP
    Gpuinteger

    GPU 个数。

    1
    Imagestring

    容器镜像。

    HPL
    ImagePullPolicystring

    镜像拉取策略。可能值:

    • Always:总是拉取。每次都拉取镜像。
    • IfNotPresent:按需拉取。优先使用本地镜像,本地没有镜像时则拉取镜像。
    • Never:从不拉取。使用本地镜像,不拉取镜像。
    Always
    LivenessProbeobject

    存活探针。

    Execsarray

    执行命令。

    string

    执行命令。

    ["/bin/sh", "-c", "echo Hello world > /usr/share/message"]
    FailureThresholdlong

    从上次检查成功后认定检查失败的检查次数阈值(必须是连续失败)。默认为 3 次。

    3
    HttpGetobject

    HttpGet。

    Pathstring

    HttpGet 检测的路径。

    /usr/nginx/
    Portlong

    HttpGet 检测的端口。

    80
    Schemestring

    HTTP 或 HTTPS。

    HTTP
    InitialDelaySecondslong

    检查开始执行的时间,以容器启动完成为起点计算。

    10
    PeriodSecondslong

    检查执行的周期。默认为 10 秒,最小为 1 秒。

    5
    SuccessThresholdlong

    从上次检查失败后重新认定检查成功的检查次数阈值(必须是连续成功),默认为 1。当前必须为 1。

    1
    TcpSocketobject

    TcpSocket。

    Hoststring

    主机名。

    1.2.3.4
    Portlong

    端口号。

    80
    TimeoutSecondslong

    检查超时的时间,默认为 1 秒,最小为 1 秒。

    10
    Memoryfloat

    实例级别内存大小。单位为 GiB。

    4.0
    Namestring

    容器名称。

    HPL
    Portsobject []

    暴露端口和协议。

    Portlong

    端口号。可能值:1~65535。

    8080
    Protocolstring

    协议类型。

    TCP
    PreviousStateobject

    上一次状态。

    DetailStatusstring

    状态详情。

    working
    ExitCodelong

    容器运行退出码。

    0
    FinishTimestring

    容器运行结束时间。

    2018-08-02T15:00:00Z
    Messagestring

    容器状态信息。

    Back-off 5m0s restarting failed container=test pod=test_eci-xxx(xxx)
    Reasonstring

    容器状态 Reason。

    Completed
    Signallong

    容器状态信号。

    1
    StartTimestring

    容器运行开始时间。

    2018-08-02T15:00:00Z
    Statestring

    容器状态。可能值:

    • Waiting:启动中
    • Running:运行中
    • Terminated:运行终止
    Terminated
    ReadinessProbeobject

    应用业务探针(即就绪探针),用于检查容器是否已经就绪,可以为请求提供服务。

    Execsarray

    使用命令行方式进行健康检查时,在容器内执行的命令。

    string

    使用命令行方式进行健康检查时,在容器内执行的命令。

    [ "/bin/sh", "-c", "echo Hello world > /usr/share/message" ]
    FailureThresholdlong

    从上次检查成功后认定检查失败的检查次数阈值(必须是连续失败),默认为 3。

    3
    HttpGetobject

    使用 HTTP 请求方式进行健康检查。

    Pathstring

    HttpGet 检测的路径。

    /usr/local
    Portlong

    HttpGet 检测的端口号。

    8080
    Schemestring

    HTTP/HTTPS。

    HTTP
    InitialDelaySecondslong

    检查开始执行的时间,以容器启动完成为起点计算。

    10
    PeriodSecondslong

    检查执行的周期,默认为 10 秒,最小为 1 秒。

    5
    SuccessThresholdlong

    从上次检查失败后重新认定检查成功的检查次数阈值(必须是连续成功),默认为 1。当前必须为 1

    1
    TcpSocketobject

    使用 TCP Socket 方式进行健康检查。

    Hoststring

    Host。

    1.2.3.4
    Portlong

    端口号。

    8888
    TimeoutSecondslong

    检查超时的时间,默认为 1 秒,最小为 1 秒。

    1
    Readyboolean

    指定容器是否已通过其就绪探针。

    true
    RestartCountinteger

    重启次数。

    5
    SecurityContextobject

    容器运行的安全上下文。

    Capabilityobject

    容器内的进程所具备的特定权限。

    Addsarray

    容器内的进程所具备的特定权限。

    string

    容器内的进程所具备的特定权限。

    NET_ADMIN
    ReadOnlyRootFilesystemboolean

    是否只读根文件系统,目前仅支持 True。

    true
    RunAsUserlong

    用于运行容器进程入口点的 UID。

    1558
    Stdinboolean

    此容器是否应在容器运行时为标准输入分配缓冲区。如果未设置,则容器中标准输入的读取值将导致 EOF。默认为 false。

    true
    StdinOnceboolean

    当标准输入为 true 时,标准输入流将在多个附加会话中保持开启状态。如果 StdinOnce 设为 true,标准输入在容器开启时被打开,在首个客户端附加到标准输入之前都为空,然后会一直保持开启状态,接收数据,直到客户端连接断开,此时标准输入被关闭,在容器重启前一直保持关闭状态。

    true
    Ttyboolean

    是否开启交互。默认为 false。例如:当 Command 配置为/bin/bash 时,需要配置为 true。

    false
    VolumeMountsobject []

    挂载的数据卷信息。

    MountPathstring

    挂载目录,容器的挂载目录下的内容被 Volume 的内容直接覆盖。

    /usr/share/
    MountPropagationstring

    数据卷的挂载传播设置。挂载传播允许将 Container 挂载的卷共享到同一 Pod 中的其他 Container,甚至可以共享到同一节点上的其他 Pod。可能值:

    • None:该卷不感知任何后续在此卷或其子目录上执行的挂载操作。
    • HostToContainer:该卷将会感知到后续在此卷或其子目录上的挂载操作。
    • Bidirectional:和 HostToContainer 类似,能感知挂载操作。另外,该卷将被传播回主机和使用同一卷的所有 Pod 的所有容器。
    None
    Namestring

    数据卷名称。

    test-empty
    ReadOnlyboolean

    是否只读。

    false
    SubPathstring

    数据卷下的子目录。方便实例将同一个数据卷下的不同目录挂载到容器的不同目录。

    /usr/sub
    WorkingDirstring

    工作目录。

    /usr/local/nginx
    Volumesobject []

    数据卷信息。

    ConfigFileVolumeConfigFileToPathsobject []

    配置文件路径列表。

    Contentstring

    配置文件内容 (32KB)。

    hello world
    Pathstring

    相对文件路径。

    /usr/bin/
    DiskVolumeDiskIdstring

    DiskVolume 的 ID。

    d-xxxx
    DiskVolumeFsTypestring

    数据卷类型。

    xfs
    EmptyDirVolumeMediumstring

    EmptyDir 数据卷的存储媒介。默认为空,表示使用 node 文件系统。支持配置为以下值:

    • Memory:表示使用内存。
    • LocalRaid0:表示将本地盘组成 RAID 0。该取值仅适用于创建本地盘实例并挂载本地盘的场景。更多信息,请参见创建本地盘实例
    Memory
    EmptyDirVolumeSizeLimitstring

    EmptyDir 数据卷的大小。取值请带上单位,建议使用 Gi 或 Mi

    256Mi
    FlexVolumeDriverstring

    用于 FlexVolume 的驱动程序名称。

    flexvolume
    FlexVolumeFsTypestring

    挂载的文件系统类型,默认取决于 FlexVolume 的 script。

    ntfs
    FlexVolumeOptionsstring

    FlexVolume 对象选项列表。

    [nolock,tcp,noresvport]
    NFSVolumePathstring

    NFS 数据卷路径。

    /eci
    NFSVolumeReadOnlyboolean

    是否只读。

    false
    NFSVolumeServerstring

    NFS 服务器地址。

    0eafxxxxx-xxxxx.cn-hangzhou.nas.aliyuncs.com
    Namestring

    数据卷名称。

    test-empty
    Typestring

    数据卷类型,可能值:

    • EmptyDirVolume
    • NFSVolume
    • ConfigFileVolume
    • FlexVolume
    EmptyDirVolume
    Eventsobject []

    事件信息,上限 50。

    Countinteger

    事件数量。

    20
    FirstTimestampstring

    事件起始时间。

    2018-08-02T15:00:00Z
    LastTimestampstring

    事件结束时间。

    2018-08-02T15:00:00Z
    Messagestring

    事件消息。

    Started container
    Namestring

    事件的归属对象名。

    test-xxx
    Reasonstring

    事件名。

    Created
    Typestring

    事件类型。可能值:

    • Normal
    • Warning
    Normal
    CreationTimestring

    接到请求后的系统创建时间。UTC 时间,RFC3339 标准。

    2018-08-02T15:00:00Z
    SucceededTimestring

    容器全部成功退出后的时间。UTC 时间,RFC3339 标准。

    2019-12-11T04:33:42Z
    ExpiredTimestring

    由于账户欠费导致实例运行失败的时间。UTC 时间,RFC3339 标准。

    2018-08-02T15:00:00Z
    FailedTimestring

    实例运行失败的时间。UTC 时间,RFC 3339 标准。

    2018-08-02T15:00:00Z
    Discountlong

    折扣。

    9
    DnsConfigobject

    DNS 配置信息。

    NameServersarray

    DNS 服务器 IP 地址列表。

    string

    IP 地址。

    [10.2.*.*]
    Optionsobject []

    对象选项列表,每个对象由 Name 和 Value(可选)构成。

    Namestring

    对象变量名。

    name
    Valuestring

    对象变量值。

    value
    Searchesarray

    DNS 搜索域列表。

    string

    DNS 搜索域。

    svc.local.kubenetes
    EciSecurityContextobject

    容器组运行的安全上下文。

    Sysctlsobject []

    sysctl 参数。

    Namestring

    sysctl 参数名。

    kernel.msgmax
    Valuestring

    sysctl 参数值。

    65536
    EniInstanceIdstring

    弹性网卡 ID。

    eni-bp14rzqi6fd8satm****
    EphemeralStoragelong

    临时存储空间大小。单位为:GiB。

    20
    HostAliasesobject []

    自定义实例内一个容器的 Hostname 映射。

    Hostnamesarray

    主机信息。

    string

    主机名。

    ['hehe.com', 'haha.com']
    Ipstring

    IP 地址。

    192.0.XX.XX
    InitContainersobject []

    Init 容器列表。

    Argsarray

    启动参数。

    string

    启动参数。

    ['hello world']
    Commandarray

    启动命令。

    string

    启动命令。

    [/bin/sh echo]
    Cpulong

    vCPU 大小。

    1.0
    CurrentStateobject

    当前状态。

    DetailStatusstring

    状态详情。

    working
    ExitCodelong

    容器退出码。

    0
    FinishTimestring

    容器运行结束时间。

    2018-08-02T15:00:00Z
    Messagestring

    事件消息。

    Created container
    Reasonstring

    容器状态 Reason。

    Started
    Signallong

    容器状态信号。

    1
    StartTimestring

    容器运行开始时间。

    2018-08-02T15:00:00Z
    Statestring

    容器状态。可能值:

    • Waiting
    • Running
    • Terminated
    Running
    EnvironmentVarsobject []

    环境变量。

    Keystring

    环境变量名。

    PATH
    Valuestring

    环境变量值。

    /usr/local/bin
    ValueFromobject

    环境变量值的来源。 如果值不为空,则无法使用。

    FieldRefobject

    指定的字段。

    FieldPathstring

    指定的版本中选择字段的路径,目前只支持 status.podIP

    status.podIP
    Gpulong

    GPU 个数。

    1
    Imagestring

    镜像。

    nginx
    ImagePullPolicystring

    镜像拉取策略。

    Always
    Memorylong

    Init 容器内存大小。单位为 GiB。

    2.0
    Namestring

    容器名称。

    Init-xxx
    Portsobject []

    暴露端口和协议。

    Portlong

    端口号。可能值:1~65535。

    8888
    Protocolstring

    协议类型。

    TCP
    PreviousStateobject

    上一次状态。

    DetailStatusstring

    状态详情。

    working
    ExitCodelong

    容器运行退出码。

    0
    FinishTimestring

    容器运行结束时间。

    2019-12-24T05:35:44Z
    Messagestring

    容器状态信息。

    Started container
    Reasonstring

    容器状态 Reason。

    completed
    Signallong

    容器状态信号。

    1
    StartTimestring

    容器运行开始时间。

    2019-12-24T05:35:44Z
    Statestring

    容器状态,枚举值:Waiting,Running,Terminated。

    Terminated
    Readyboolean

    指定容器是否已通过其就绪探针。

    true
    RestartCountlong

    重启次数。

    5
    SecurityContextobject

    容器运行的安全上下文。

    Capabilityobject

    容器内的进程所具备的特定权限。

    Addsarray

    容器内的进程所具备的特定权限。

    string

    容器内的进程所具备的特定权限。

    NET_ADMIN
    ReadOnlyRootFilesystemboolean

    是否只读根文件系统,目前仅支持 True。

    true
    RunAsUserlong

    用于运行容器进程入口点的 UID。

    1557
    VolumeMountsobject []

    Init 容器挂载的数据卷信息。

    MountPathstring

    挂载目录,容器的挂载目录下的内容被 Volume 的内容直接覆盖。

    /usr/share/
    MountPropagationstring

    数据卷的挂载传播设置。挂载传播允许将 Container 挂载的卷共享到同一 Pod 中的其他 Container,甚至可以共享到同一节点上的其他 Pod。可能值:

    • None:该卷不感知任何后续在此卷或其子目录上执行的挂载操作。
    • HostToCotainer:该卷将会感知到后续在此卷或其子目录上的挂载操作。
    • Bidirectional:和 HostToCotainer 类似,能感知挂载操作。另外,该卷将被传播回主机和使用同一卷的所有 Pod 的所有容器。

    默认值:None。

    None
    Namestring

    数据卷名称,同 Volume 中的 Name。

    test-empty
    ReadOnlyboolean

    默认值为 False。

    false
    WorkingDirstring

    工作目录。

    /usr/test
    InternetIpstring

    公网 IP。

    192.0.XX.XX
    IntranetIpstring

    内网 IP。