展示实例状态统计信息 - ShowScriptOrderStatistics

功能介绍

查询指定工单中实例执行状态统计的信息。

接口约束

查询工单中实例实时执行状态。

调试

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

授权信息

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

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

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

URI

GET /v1/job/script/orders/{execute_uuid}/statistics

表1 路径参数
参数	是否必选	参数类型	描述
execute_uuid	是	String	参数解释：脚本工单的执行Id，取自executeJobScript和ListJobScriptOrders返回体中。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

请求参数

表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	JobScriptOrderStatisticsModel object	参数解释：展示实例状态统计信息。取值范围：不涉及。

表4 JobScriptOrderStatisticsModel
参数	参数类型	描述
total_instance	Integer	参数解释：实例总量。取值范围：不涉及。
execute_statistics	Array of ExectuionStatistic objects	参数解释：每个状态一个count，里面记录该状态的总数量，以及包含该状态的批次列表。取值范围：不涉及。

表5 ExectuionStatistic
参数	参数类型	描述
instance_status	String	参数解释：执行实例状态。取值范围：不涉及。
instance_count	Integer	参数解释：该状态下执行实例个数。取值范围：不涉及。
batch_indexes	Array of integers	参数解释：该状态下批次index列表。取值范围：不涉及。

请求示例

查询指定工单中实例状态统计的信息。

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

响应示例

状态码：200

展示实例状态统计信息返回体。

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

{
  "data" : {
    "total_instance" : 1,
    "execute_statistics" : [ {
      "instance_status" : "READY",
      "instance_count" : 0,
      "batch_indexes" : [ ]
    }, {
      "instance_status" : "PROCESSING",
      "instance_count" : 0,
      "batch_indexes" : [ ]
    }, {
      "instance_status" : "ABNORMAL",
      "instance_count" : 0,
      "batch_indexes" : [ ]
    }, {
      "instance_status" : "CANCELED",
      "instance_count" : 1,
      "batch_indexes" : [ 1 ]
    }, {
      "instance_status" : "FINISHED",
      "instance_count" : 0,
      "batch_indexes" : [ ]
    } ]
  }
}