按照作业ID或子任务ID(数组作业)查询Serverless作业详细信息。当前仅支持传入单个作业ID或单个子任务ID。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ehpc:DescribeServerlessJobs | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClusterId | string | 是 | 集群 ID。 您可以通过调用 ListClusters 获取集群 ID。 | ehpc-hz-FYUr32**** |
JobIds | array | 是 | Serverless 作业 ID 或子任务 ID(数组作业)列表。 说明
| |
string | 是 | Serverless 作业 ID 或子任务 ID(数组作业)。 | 5 |
返回参数
名称 | 类型 | 描述 | 示例值 |
---|---|---|---|
object | |||
TotalCount | integer | 本次请求条件下的数据总条数。 | 1 |
RequestId | string | 请求 ID。 | 04F0F334-1335-436C-A1D7-6C044FE73368 |
JobInfos | object [] | Serverless 作业详细信息列表。 | |
JobId | string | Serverless 作业 ID 或子任务 ID(数组作业)。 | 5 |
JobName | string | Serverless 作业名。 | testjob |
State | string | Serverless 作业状态。可能的值:
| Running |
Priority | long | Serverless 作业的调度优先级。 | 9 |
Queue | string | 执行 Serverless 作业的队列名。 | comp |
User | string | 执行 Serverless 作业的用户名。 | testuser |
SubmitTime | long | Serverless 作业提交时间戳。 | 1647423718 |
StartTime | long | Serverless 作业开始时间戳。 | 1647427667 |
EndTime | long | Serverless 作业结束时间戳。 | 1662016121 |
LastModifyTime | long | Serverless 作业最近修改时间戳。 | 1663831441000 |
IsArrayJob | boolean | 是否是数组作业。 | false |
ArrayProperties | object | 数组作业属性。 | |
IndexStart | long | 数组作业索引的起始值 | 1 |
IndexEnd | long | 数组作业索引的结束值。 | 5 |
IndexStep | long | 数组作业索引的间隔。 | 2 |
ContainerGroups | object [] | Serverless 作业容器组实例信息列表。 | |
ContainerGroupId | string | 容器组实例 ID。 | eci-bp1jrgfqqy54kg5hc**** |
ContainerGroupName | string | 容器组实例名称。 | test |
Status | string | 实例状态。取值范围:
| Running |
InstanceType | string | 指定的 ECS 实例规格。 | ecs.g5.large |
SpotStrategy | string | 实例的抢占策略。取值范围:
| NoSpot |
SpotPriceLimit | float | 抢占式实例的每小时最高价格。 仅当 SpotStrategy 为 SpotWithPriceLimit 时返回。 | 0.025 |
Cpu | float | 容器的 vCPU 大小。 | 2 |
Memory | float | 实例级别内存大小。单位为 GiB。 | 4.0 |
Containers | object [] | 容器组包含的容器列表。 | |
Args | array | 容器启动参数。 | |
string | 容器启动参数。 | hello.py | |
Commands | array | 容器启动命令。 | |
string | 容器启动命令。 | /usr/bin/python | |
Cpu | float | 容器的 vCPU 大小。 | 2.0 |
CurrentState | object | 容器当前状态。 | |
DetailStatus | string | 容器状态详情。 | working |
ExitCode | long | 容器运行退出码。 | 0 |
FinishTime | string | 容器运行结束时间。 | 2018-08-02T15:00:00Z |
Message | string | 容器状态信息。 | Back-off 5m0s restarting failed container=test pod=test_eci-xxx(xxx) |
Reason | string | 容器状态 Reason。 | Started |
Signal | long | 容器状态信号。 | 1 |
StartTime | string | 容器运行开始时间。 | 2019-12-19T12:05:02Z |
State | string | 作业状态。可能值:
| Terminated |
EnvironmentVars | object [] | 环境变量。 | |
Key | string | 环境变量名。 | PATH |
Value | string | 环境变量值。 | /usr/bin/ |
ValueFrom | object | 环境变量值的来源。 如果值不为空,则无法使用。 | |
FieldRef | object | 指定字段。 | |
FieldPath | string | 字段的路径。 | status.podIP |
Gpu | integer | GPU 个数。 | 1 |
Image | string | 容器镜像。 | HPL |
ImagePullPolicy | string | 镜像拉取策略。可能值:
| Always |
LivenessProbe | object | 存活探针。 | |
Execs | array | 执行命令。 | |
string | 执行命令。 | ["/bin/sh", "-c", "echo Hello world > /usr/share/message"] | |
FailureThreshold | long | 从上次检查成功后认定检查失败的检查次数阈值(必须是连续失败)。默认为 3 次。 | 3 |
HttpGet | object | HttpGet。 | |
Path | string | HttpGet 检测的路径。 | /usr/nginx/ |
Port | long | HttpGet 检测的端口。 | 80 |
Scheme | string | HTTP 或 HTTPS。 | HTTP |
InitialDelaySeconds | long | 检查开始执行的时间,以容器启动完成为起点计算。 | 10 |
PeriodSeconds | long | 检查执行的周期。默认为 10 秒,最小为 1 秒。 | 5 |
SuccessThreshold | long | 从上次检查失败后重新认定检查成功的检查次数阈值(必须是连续成功),默认为 1。当前必须为 1。 | 1 |
TcpSocket | object | TcpSocket。 | |
Host | string | 主机名。 | 1.2.3.4 |
Port | long | 端口号。 | 80 |
TimeoutSeconds | long | 检查超时的时间,默认为 1 秒,最小为 1 秒。 | 10 |
Memory | float | 实例级别内存大小。单位为 GiB。 | 4.0 |
Name | string | 容器名称。 | HPL |
Ports | object [] | 暴露端口和协议。 | |
Port | long | 端口号。可能值:1~65535。 | 8080 |
Protocol | string | 协议类型。 | TCP |
PreviousState | object | 上一次状态。 | |
DetailStatus | string | 状态详情。 | working |
ExitCode | long | 容器运行退出码。 | 0 |
FinishTime | string | 容器运行结束时间。 | 2018-08-02T15:00:00Z |
Message | string | 容器状态信息。 | Back-off 5m0s restarting failed container=test pod=test_eci-xxx(xxx) |
Reason | string | 容器状态 Reason。 | Completed |
Signal | long | 容器状态信号。 | 1 |
StartTime | string | 容器运行开始时间。 | 2018-08-02T15:00:00Z |
State | string | 容器状态。可能值:
| Terminated |
ReadinessProbe | object | 应用业务探针(即就绪探针),用于检查容器是否已经就绪,可以为请求提供服务。 | |
Execs | array | 使用命令行方式进行健康检查时,在容器内执行的命令。 | |
string | 使用命令行方式进行健康检查时,在容器内执行的命令。 | [ "/bin/sh", "-c", "echo Hello world > /usr/share/message" ] | |
FailureThreshold | long | 从上次检查成功后认定检查失败的检查次数阈值(必须是连续失败),默认为 3。 | 3 |
HttpGet | object | 使用 HTTP 请求方式进行健康检查。 | |
Path | string | HttpGet 检测的路径。 | /usr/local |
Port | long | HttpGet 检测的端口号。 | 8080 |
Scheme | string | HTTP/HTTPS。 | HTTP |
InitialDelaySeconds | long | 检查开始执行的时间,以容器启动完成为起点计算。 | 10 |
PeriodSeconds | long | 检查执行的周期,默认为 10 秒,最小为 1 秒。 | 5 |
SuccessThreshold | long | 从上次检查失败后重新认定检查成功的检查次数阈值(必须是连续成功),默认为 1。当前必须为 1 | 1 |
TcpSocket | object | 使用 TCP Socket 方式进行健康检查。 | |
Host | string | Host。 | 1.2.3.4 |
Port | long | 端口号。 | 8888 |
TimeoutSeconds | long | 检查超时的时间,默认为 1 秒,最小为 1 秒。 | 1 |
Ready | boolean | 指定容器是否已通过其就绪探针。 | true |
RestartCount | integer | 重启次数。 | 5 |
SecurityContext | object | 容器运行的安全上下文。 | |
Capability | object | 容器内的进程所具备的特定权限。 | |
Adds | array | 容器内的进程所具备的特定权限。 | |
string | 容器内的进程所具备的特定权限。 | NET_ADMIN | |
ReadOnlyRootFilesystem | boolean | 是否只读根文件系统,目前仅支持 True。 | true |
RunAsUser | long | 用于运行容器进程入口点的 UID。 | 1558 |
Stdin | boolean | 此容器是否应在容器运行时为标准输入分配缓冲区。如果未设置,则容器中标准输入的读取值将导致 EOF。默认为 false。 | true |
StdinOnce | boolean | 当标准输入为 true 时,标准输入流将在多个附加会话中保持开启状态。如果 StdinOnce 设为 true,标准输入在容器开启时被打开,在首个客户端附加到标准输入之前都为空,然后会一直保持开启状态,接收数据,直到客户端连接断开,此时标准输入被关闭,在容器重启前一直保持关闭状态。 | true |
Tty | boolean | 是否开启交互。默认为 false。例如:当 Command 配置为/bin/bash 时,需要配置为 true。 | false |
VolumeMounts | object [] | 挂载的数据卷信息。 | |
MountPath | string | 挂载目录,容器的挂载目录下的内容被 Volume 的内容直接覆盖。 | /usr/share/ |
MountPropagation | string | 数据卷的挂载传播设置。挂载传播允许将 Container 挂载的卷共享到同一 Pod 中的其他 Container,甚至可以共享到同一节点上的其他 Pod。可能值:
| None |
Name | string | 数据卷名称。 | test-empty |
ReadOnly | boolean | 是否只读。 | false |
SubPath | string | 数据卷下的子目录。方便实例将同一个数据卷下的不同目录挂载到容器的不同目录。 | /usr/sub |
WorkingDir | string | 工作目录。 | /usr/local/nginx |
Volumes | object [] | 数据卷信息。 | |
ConfigFileVolumeConfigFileToPaths | object [] | 配置文件路径列表。 | |
Content | string | 配置文件内容 (32KB)。 | hello world |
Path | string | 相对文件路径。 | /usr/bin/ |
DiskVolumeDiskId | string | DiskVolume 的 ID。 | d-xxxx |
DiskVolumeFsType | string | 数据卷类型。 | xfs |
EmptyDirVolumeMedium | string | EmptyDir 数据卷的存储媒介。默认为空,表示使用 node 文件系统。支持配置为以下值:
| Memory |
EmptyDirVolumeSizeLimit | string | EmptyDir 数据卷的大小。取值请带上单位,建议使用 Gi 或 Mi | 256Mi |
FlexVolumeDriver | string | 用于 FlexVolume 的驱动程序名称。 | flexvolume |
FlexVolumeFsType | string | 挂载的文件系统类型,默认取决于 FlexVolume 的 script。 | ntfs |
FlexVolumeOptions | string | FlexVolume 对象选项列表。 | [nolock,tcp,noresvport] |
NFSVolumePath | string | NFS 数据卷路径。 | /eci |
NFSVolumeReadOnly | boolean | 是否只读。 | false |
NFSVolumeServer | string | NFS 服务器地址。 | 0eafxxxxx-xxxxx.cn-hangzhou.nas.aliyuncs.com |
Name | string | 数据卷名称。 | test-empty |
Type | string | 数据卷类型,可能值:
| EmptyDirVolume |
Events | object [] | 事件信息,上限 50。 | |
Count | integer | 事件数量。 | 20 |
FirstTimestamp | string | 事件起始时间。 | 2018-08-02T15:00:00Z |
LastTimestamp | string | 事件结束时间。 | 2018-08-02T15:00:00Z |
Message | string | 事件消息。 | Started container |
Name | string | 事件的归属对象名。 | test-xxx |
Reason | string | 事件名。 | Created |
Type | string | 事件类型。可能值:
| Normal |
CreationTime | string | 接到请求后的系统创建时间。UTC 时间,RFC3339 标准。 | 2018-08-02T15:00:00Z |
SucceededTime | string | 容器全部成功退出后的时间。UTC 时间,RFC3339 标准。 | 2019-12-11T04:33:42Z |
ExpiredTime | string | 由于账户欠费导致实例运行失败的时间。UTC 时间,RFC3339 标准。 | 2018-08-02T15:00:00Z |
FailedTime | string | 实例运行失败的时间。UTC 时间,RFC 3339 标准。 | 2018-08-02T15:00:00Z |
Discount | long | 折扣。 | 9 |
DnsConfig | object | DNS 配置信息。 | |
NameServers | array | DNS 服务器 IP 地址列表。 | |
string | IP 地址。 | [10.2.*.*] | |
Options | object [] | 对象选项列表,每个对象由 Name 和 Value(可选)构成。 | |
Name | string | 对象变量名。 | name |
Value | string | 对象变量值。 | value |
Searches | array | DNS 搜索域列表。 | |
string | DNS 搜索域。 | svc.local.kubenetes | |
EciSecurityContext | object | 容器组运行的安全上下文。 | |
Sysctls | object [] | sysctl 参数。 | |
Name | string | sysctl 参数名。 | kernel.msgmax |
Value | string | sysctl 参数值。 | 65536 |
EniInstanceId | string | 弹性网卡 ID。 | eni-bp14rzqi6fd8satm**** |
EphemeralStorage | long | 临时存储空间大小。单位为:GiB。 | 20 |
HostAliases | object [] | 自定义实例内一个容器的 Hostname 映射。 | |
Hostnames | array | 主机信息。 | |
string | 主机名。 | ['hehe.com', 'haha.com'] | |
Ip | string | IP 地址。 | 192.0.XX.XX |
InitContainers | object [] | Init 容器列表。 | |
Args | array | 启动参数。 | |
string | 启动参数。 | ['hello world'] | |
Command | array | 启动命令。 | |
string | 启动命令。 | [/bin/sh echo] | |
Cpu | long | vCPU 大小。 | 1.0 |
CurrentState | object | 当前状态。 | |
DetailStatus | string | 状态详情。 | working |
ExitCode | long | 容器退出码。 | 0 |
FinishTime | string | 容器运行结束时间。 | 2018-08-02T15:00:00Z |
Message | string | 事件消息。 | Created container |
Reason | string | 容器状态 Reason。 | Started |
Signal | long | 容器状态信号。 | 1 |
StartTime | string | 容器运行开始时间。 | 2018-08-02T15:00:00Z |
State | string | 容器状态。可能值:
| Running |
EnvironmentVars | object [] | 环境变量。 | |
Key | string | 环境变量名。 | PATH |
Value | string | 环境变量值。 | /usr/local/bin |
ValueFrom | object | 环境变量值的来源。 如果值不为空,则无法使用。 | |
FieldRef | object | 指定的字段。 | |
FieldPath | string | 指定的版本中选择字段的路径,目前只支持 | status.podIP |
Gpu | long | GPU 个数。 | 1 |
Image | string | 镜像。 | nginx |
ImagePullPolicy | string | 镜像拉取策略。 | Always |
Memory | long | Init 容器内存大小。单位为 GiB。 | 2.0 |
Name | string | 容器名称。 | Init-xxx |
Ports | object [] | 暴露端口和协议。 | |
Port | long | 端口号。可能值:1~65535。 | 8888 |
Protocol | string | 协议类型。 | TCP |
PreviousState | object | 上一次状态。 | |
DetailStatus | string | 状态详情。 | working |
ExitCode | long | 容器运行退出码。 | 0 |
FinishTime | string | 容器运行结束时间。 | 2019-12-24T05:35:44Z |
Message | string | 容器状态信息。 | Started container |
Reason | string | 容器状态 Reason。 | completed |
Signal | long | 容器状态信号。 | 1 |
StartTime | string | 容器运行开始时间。 | 2019-12-24T05:35:44Z |
State | string | 容器状态,枚举值:Waiting,Running,Terminated。 | Terminated |
Ready | boolean | 指定容器是否已通过其就绪探针。 | true |
RestartCount | long | 重启次数。 | 5 |
SecurityContext | object | 容器运行的安全上下文。 | |
Capability | object | 容器内的进程所具备的特定权限。 | |
Adds | array | 容器内的进程所具备的特定权限。 | |
string | 容器内的进程所具备的特定权限。 | NET_ADMIN | |
ReadOnlyRootFilesystem | boolean | 是否只读根文件系统,目前仅支持 True。 | true |
RunAsUser | long | 用于运行容器进程入口点的 UID。 | 1557 |
VolumeMounts | object [] | Init 容器挂载的数据卷信息。 | |
MountPath | string | 挂载目录,容器的挂载目录下的内容被 Volume 的内容直接覆盖。 | /usr/share/ |
MountPropagation | string | 数据卷的挂载传播设置。挂载传播允许将 Container 挂载的卷共享到同一 Pod 中的其他 Container,甚至可以共享到同一节点上的其他 Pod。可能值:
默认值:None。 | None |
Name | string | 数据卷名称,同 Volume 中的 Name。 | test-empty |
ReadOnly | boolean | 默认值为 False。 | false |
WorkingDir | string | 工作目录。 | /usr/test |
InternetIp | string | 公网 IP。 | 192.0.XX.XX |
IntranetIp | string | 内网 IP。 |