展示工单中的批次详情
功能介绍
查询：批次详情，分页获取批次中的实例列表。
接口约束
过滤条件：分页参数。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/job/script/orders/{execute_uuid}/batches/{batch_index}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
batch_index |
是 |
Integer |
参数解释： 批次index。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
execute_uuid |
是 |
String |
参数解释： 脚本工单的执行Id，取自executeJobScript和ListJobScriptOrders返回体中。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
status |
否 |
String |
参数解释： 实例执行状态。 约束限制：
取值范围： READY/PROCESSING/ABNORMAL/CANCELED/FINISHED。 默认取值： 不涉及。 |
|
limit |
是 |
Integer |
参数解释： 分页参数：每页返回记录个数限制。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
marker |
否 |
Long |
参数解释： 分页参数：上一页最后一个记录id。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
JobScriptBatchDetailModel object |
参数解释： 展示批次详情返回体。 取值范围： 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
batch_index |
Integer |
参数解释： 批次索引，从1开始。 取值范围： 不涉及。 |
|
total_instances |
Integer |
参数解释： 批次内执行实例数量。 取值范围： 不涉及。 |
|
execute_instances |
Array of ExectionInstanceModel objects |
参数解释： 执行实例列表，分页。 取值范围： 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
Long |
参数解释： 主键id。 取值范围： 不涉及。 |
|
target_instance |
ResourceInstance object |
参数解释： 目标实例。 取值范围： 不涉及。 |
|
gmt_created |
Long |
参数解释： 创建时间。 取值范围： 不涉及。 |
|
gmt_finished |
Long |
参数解释： 完成时间。 取值范围： 不涉及。 |
|
execute_costs |
Long |
参数解释： 耗时时间，单位：秒。 取值范围： 不涉及。 |
|
status |
String |
参数解释： 实例执行状态。 取值范围：
|
|
message |
String |
参数解释： 实例执行日志。 取值范围： 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
resource_id |
String |
参数解释： 实例唯一id。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
provider |
String |
参数解释： 资源提供者：ECS。单个脚本工单， 每个实例的provider是一致的。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
region_id |
String |
参数解释： 机器所属region的ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
type |
String |
参数解释： 资源提供者下资源类型，不传默认为CLOUDSERVER。 CLOUDSERVER：CLOUDSERVER类型。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
custom_attributes |
Array of Customttribute objects |
参数解释： 支持用户自定义5个key_value形式的属性。 约束限制：
取值范围： 不涉及。 默认取值： 不涉及。 |
|
agent_sn |
String |
参数解释： agent纳管id。该参数即将废弃，请勿使用。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
agent_status |
String |
参数解释： agent纳管状态。该参数即将废弃，请勿使用。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
properties |
ResourceInstanceProp object |
参数解释： 主机附加属性。该参数即将废弃，请勿使用。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
key |
String |
参数解释： 自定义属性key。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
value |
String |
参数解释： 自定义属性的value。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
请求示例
展示工单中的批次详情。
GET https://{Endpoint}/v1/job/script/orders/{execute_uuid}/batches/{batch_index}响应示例
状态码：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 |
返回结果。 更多状态码请参考状态码。 |
错误码
请参见错误码。
