获取子任务实例信息 - ShowTaskInstances
功能介绍
获取子任务实例信息。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs/{job_id}/tasks/{task_name}/instances
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| eihealth_project_id | 是 | String | 参数解释: 空间ID,您可以从获取空间ID中获取。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
| job_id | 是 | String | 参数解释: 作业ID。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
| project_id | 是 | String | 参数解释: 项目ID,您可以从获取项目ID中获取。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
| task_name | 是 | String | 参数解释: 子任务名称。 约束限制: 不涉及 取值范围: 长度为[1-128]个字符。 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| task_index | 否 | String | 参数解释: 子任务的并发序号。 约束限制: 不涉及 取值范围: 长度为[1-128]个字符。 默认取值: 0 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 约束限制: 不涉及 取值范围: 长度为[1-32768]个字符。 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| count | Integer | 参数解释: 实例个数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| instances | Array of TaskInstanceRsp objects | 参数解释: 实例响应结构体。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | TaskInstanceStatusRsp object | 参数解释: 实例状态信息。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
| metadata | TaskInstanceMetadataRsp object | 参数解释: 实例元数据信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| spec | TaskInstanceSpecRsp object | 参数解释: 实例cpu和内存使用率信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| phase | String | 参数解释: 实例执行状态。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| pod_ip | String | 参数解释: 实例IP。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| host_ip | String | 参数解释: 实例所在节点IP。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| host_name | String | 参数解释: 计算节点的名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| start_time | String | 参数解释: 实例创建时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| container_statuses | Array of TaskInstanceContainerStatusRsp objects | 参数解释: 实例状态信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| restart_count | Integer | 参数解释: 重启次数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| name | String | 参数解释: 实例名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| namespace | String | 参数解释: 命名空间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| containers | Array of TaskInstanceSpecContainersRsp objects | 参数解释: 实例详情响应体。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| resources | 参数解释: 实例规格信息响应体。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求示例
查询作业子任务实例信息。
https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs/{job_id}/tasks/{task_name}/instances 响应示例
状态码:200
OK
{
"count" : 0,
"instances" : [ {
"status" : {
"phase" : "Failed",
"pod_ip" : "192.168.0.1",
"host_ip" : "192.168.0.1",
"host_name" : "health-f789d9c5-e8e6-44e7-84fb-8e234bba1cee",
"start_time" : "2021-01-30T02:34:36Z",
"container_statuses" : [ {
"restart_count" : 0
} ]
},
"metadata" : {
"name" : "string",
"namespace" : "default"
},
"spec" : {
"containers" : [ {
"resources" : {
"limits" : {
"cpu" : "string",
"memory" : "string"
},
"requests" : {
"cpu" : "string",
"memory" : "string"
}
}
} ]
}
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
错误码
请参见错误码。