文档首页/ 云运维中心 COC/ API参考/ API/ 脚本工单/ 展示批次详情
更新时间：2024-06-06 GMT+08:00
查看PDF
分享

展示批次详情

功能介绍

查询：批次详情，分页获取批次中的实例列表。 过滤条件：分页参数

URI

GET /v1/job/script/orders/{execute_uuid}/batches/{batch_index}

表1 路径参数

参数

是否必选

参数类型

描述

batch_index

是

Integer

批次index

最小值：1

最大值：20

execute_uuid

是

String

脚本工单的执行Id，取自executeJobScript和ListJobScriptOrders返回体中

最小长度：1

最大长度：26
表2 Query参数

参数

是否必选

参数类型

描述

status

否

String

实例执行状态 READY：待执行 PROCESSING：执行中 ABNORMAL：异常 CANCELED：已取消 FINISHED：成功

枚举值：

  • READY
  • PROCESSING
  • ABNORMAL
  • CANCELED
  • FINISHED

limit

是

Integer

分页参数：每页返回记录个数限制

最小值：1

最大值：50

marker

是

Long

分页参数：上一页最后一个记录id

最小值：0

最大值：2147483647

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

batch_index

Integer

批次索引，从1开始

total_instances

Integer

批次内执行实例数量

execute_instances

Array of ExectionInstanceModel objects

执行实例列表，分页
表4 ExectionInstanceModel

参数

参数类型

描述

id

Long

主键id

target_instance

ResourceInstance object

目标实例

gmt_created

Long

创建时间

gmt_finished

Long

完成时间

execute_costs

Long

耗时时间，单位:秒

status

String

实例执行状态

枚举值：

  • READY
  • PROCESSING
  • ABNORMAL
  • CANCELED
  • FINISHED
  • ROLLBACKED

message

String

实例执行日志
表5 ResourceInstance

参数

参数类型

描述

resource_id

String

ecs对应的主机id

agent_sn

String

agent纳管id

agent_status

String

agent纳管状态

properties

ResourceInstanceProp object

主机附加属性
表6 ResourceInstanceProp

参数

参数类型

描述

host_name

String

主机名 未校验：长度

fixed_ip

String

内网ip 未校验： 格式，长度

floating_ip

String

弹性公网ip 未校验： 格式，长度

region_id

String

区域 未校验： 长度

zone_id

String

可用区

application

String

CMDB应用，CMDB应用视图才有值。类似管理面的云服务

group

String

CMDB分组，CMDB应用视图才有值。类似管理面的schema

project_id

String

实例的 project_id

需要消费，建议必填 未校验长度

请求示例

无

响应示例

状态码： 200

返回结果

{
  "data" : {
    "batch_index" : 1,
    "total_instances" : 1,
    "execute_instances" : [ {
      "id" : 1588,
      "target_instance" : {
        "resource_id" : "resource_id",
        "agent_sn" : "agent_sn",
        "agent_status" : null,
        "region_id" : null,
        "project_id" : null,
        "properties" : {
          "host_name" : "host_name",
          "fixed_ip" : "x.x.x.x",
          "floating_ip" : null,
          "region_id" : "cn-north-7",
          "zone_id" : "cn-north-7c",
          "application" : null,
          "group" : null,
          "project_id" : null
        }
      },
      "gmt_created" : 1697946452436,
      "gmt_finished" : 1697946763467,
      "execute_costs" : 311031,
      "status" : "CANCELED",
      "message" : "Script execution result"
    } ]
  }
}

状态码

状态码

描述

200

返回结果

错误码

请参见错误码。

父主题： 脚本工单