展示脚本工单列表 - ListScriptOrders

功能介绍

查询作业工单列表，分页查询。

接口约束

查询条件：创建时间开始，创建时间结束、创建人。

返回信息：id、脚本名称、区域、创建人、创建时间、结束时间、总耗时、状态。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
coc:job:list
List
job *
-
-
-
-
coc:JobType

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
coc:job:list	List	job *	-	-	-
-	coc:JobType

URI

GET /v1/job/script/orders

表1 Query参数
参数	是否必选	参数类型	描述
limit	否	Integer	参数解释：分页参数。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
marker	否	Long	参数解释：分页参数。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
start_time	否	Long	参数解释：创建时间开始。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
end_time	否	Long	参数解释：创建时间结束。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
creator	否	String	参数解释：创建人。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
status	否	String	参数解释：工单状态。约束限制： PROCESSING：执行中。 ABNORMAL：异常。 PAUSED：暂停。 CANCELED：已取消。 FINISHED：成功。取值范围： PROCESSING/ABNORMAL/PAUSED/CANCELED/FINISHED。默认取值：不涉及。
name_like	否	String	参数解释：工单名称。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：租户token。约束限制：从IAM获取的租户token。取值范围：不涉及。默认取值：不涉及。
X-Language	否	String	参数解释：国际化标记，zh-cn表示中文，en-us或不传表示英文。约束限制： zh-cn表示中文，en-us或不传表示英文。取值范围： zh-cn/en-us。默认取值：不涉及。
x-project-id	否	String	参数解释：项目ID。约束限制： region对应的项目ID。取值范围：不涉及。默认取值：不涉及。
x-user-profile	否	String	参数解释： IAM5.0用户信息。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
data	JobScriptOrderListPage object	参数解释：展示工单列表返回结果。取值范围：不涉及。

表4 JobScriptOrderListPage
参数	参数类型	描述
total	Long	参数解释：总条数。取值范围：不涉及。
data	Array of JobScriptOrderListModel objects	参数解释：单页数据列表。取值范围：不涉及。

表5 JobScriptOrderListModel
参数	参数类型	描述
order_id	Long	参数解释：主键id，对应job_order_do的主键。取值范围：不涉及。
order_name	String	参数解释：工单名称。取值范围：不涉及。
execute_uuid	String	参数解释：列表跳转到详情时，用这个uuid，对应execute_data_do的execute_uuid。取值范围：不涉及。
gmt_created	Long	参数解释：创建时间。取值范围：不涉及。
gmt_finished	Long	参数解释：完成时间。取值范围：不涉及。
execute_costs	Long	参数解释：执行耗时，单位：秒。取值范围：不涉及。
creator	String	参数解释：创建人。取值范围：不涉及。
status	String	参数解释：工单状态。取值范围： READY：准备。 PROCESSING:处理。 ABNORMAL：异常。 PAUSED：中断。 CANCELED：取消。 FINISHED：完成。
properties	JobScriptOrderListProp object	参数解释：标签：区域信息等。取值范围：不涉及。

表6 JobScriptOrderListProp
参数	参数类型	描述
region_ids	String	参数解释： CMDB服务实例区域id，可能有多个。取值范围：不涉及。

请求示例

展示脚本工单列表。

GET https://{Endpoint}/v1/job/script/orders

响应示例

状态码：200

执行分页数据。

更多状态码请参考状态码。

{
  "data" : {
    "total" : 222,
    "data" : [ {
      "order_id" : 74,
      "order_name" : "071201",
      "execute_uuid" : "SCT20230724201xxxxxxxxxxxx",
      "gmt_created" : 1690200829451,
      "gmt_finished" : 1690200850293,
      "execute_costs" : 20842,
      "creator" : "xxxxxxxxxxxcontainer1",
      "status" : "CANCELED",
      "properties" : {
        "region_ids" : "***"
      }
    }, {
      "order_id" : 73,
      "order_name" : "071201",
      "execute_uuid" : "SCT2023072411xxxxxxxxxxxxx",
      "gmt_created" : 1690168434460,
      "gmt_finished" : 1690168443277,
      "execute_costs" : 8817,
      "creator" : "xxxxxxxxxxxcontainer1",
      "status" : "FINISHED",
      "properties" : {
        "region_ids" : "***"
      }
    }, {
      "order_id" : 72,
      "order_name" : "xxx",
      "execute_uuid" : "SCT2023072217181xxxxxxxxxx",
      "gmt_created" : 1690017490247,
      "gmt_finished" : null,
      "execute_costs" : null,
      "creator" : "xxxxxxxxxxxcontainer1",
      "status" : "ABNORMAL",
      "properties" : {
        "region_ids" : "***"
      }
    }, {
      "order_id" : 71,
      "order_name" : "patch_730",
      "execute_uuid" : "SCT2023071915xxxxxxxxxxxxx",
      "gmt_created" : 1689753553241,
      "gmt_finished" : 1689753579363,
      "execute_costs" : 26122,
      "creator" : "xxxxxxxxxxxcontainer1",
      "status" : "FINISHED",
      "properties" : {
        "region_ids" : "***"
      }
    }, {
      "order_id" : 70,
      "order_name" : "111",
      "execute_uuid" : "SCT2023071915xxxxxxxxxxxxx",
      "gmt_created" : 1689751168547,
      "gmt_finished" : null,
      "execute_costs" : null,
      "creator" : "xxxxxxxxxxxcontainer1",
      "status" : "ABNORMAL",
      "properties" : {
        "region_ids" : "***"
      }
    } ]
  }
}