文档首页/ 云运维中心 COC/ API参考/ API/ 脚本管理/ 脚本管理/ 获取自动分批结果 - ListInstancesBatch
更新时间：2025-11-03 GMT+08:00
查看PDF
分享

获取自动分批结果 - ListInstancesBatch

功能介绍

根据分批策略获取分批结果，只支持自动分批。

接口约束

约束条件：

  • 单个批次的所有实例必须属于同一个区域；

  • 单个批次的所有实例必须属于同一个可用区；

  • 单个批次的所有实例必须属于同一个应用；

  • 单个批次内同一分组下的实例不超过50%（除分组下仅以一个实例的情况外）；

  • 前三批每批节点数量不超过10。

  • 每批次实例数量不超过10。

  • 总机器数量为200。

调试

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

授权信息

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

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    coc:instance:autoBatchInstances

    Write

    -

    -

    -

    -

URI

POST /v1/instances/batches

请求参数

表1 请求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用户信息。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表2 请求Body参数

参数

是否必选

参数类型

描述

batch_strategy

是

String

参数解释：

分批策略：只支持自动分批。

约束限制：

AUTO_BATCH：自动分批。

取值范围：

AUTO_BATCH：自动分批。

默认取值：

不涉及。

target_instances

是

Array of ResourceInstance objects

参数解释：

目标主机实例。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表3 ResourceInstance

参数

是否必选

参数类型

描述

resource_id

是

String

参数解释：

实例唯一id。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

provider

是

String

参数解释：

资源提供者：ECS。单个脚本工单， 每个实例的provider是一致的。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

region_id

是

String

参数解释：

机器所属region的ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

type

是

String

参数解释：

资源提供者下资源类型，不传默认为CLOUDSERVER。

CLOUDSERVER：CLOUDSERVER类型。

约束限制：

不涉及。

取值范围：

  • CLOUDSERVER：CLOUDSERVER类型。

默认取值：

不涉及。

custom_attributes

否

Array of Customttribute objects

参数解释：

支持用户自定义5个key_value形式的属性。

约束限制：

  • key值长度为10 。

  • value长度为20 。

  • map长度最大为5。

取值范围：

不涉及。

默认取值：

不涉及。

agent_sn

否

String

参数解释：

agent纳管id。该参数即将废弃，请勿使用。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

agent_status

否

String

参数解释：

agent纳管状态。该参数即将废弃，请勿使用。

约束限制：

不涉及。

取值范围：

  • ONLINE：在线。

  • OFFLINE：离线。

默认取值：

不涉及。

properties

否

ResourceInstanceProp object

参数解释：

主机附加属性。该参数即将废弃，请勿使用。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表4 Customttribute

参数

是否必选

参数类型

描述

key

是

String

参数解释：

自定义属性key。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

value

是

String

参数解释：

自定义属性的value。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表5 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

表6 响应Body参数

参数

参数类型

描述

data

Array of InstancesBatchResultMode objects

参数解释：

分批结果。

取值范围：

不涉及。
表7 InstancesBatchResultMode

参数

参数类型

描述

batch_index

Integer

参数解释：

批次Id。

取值范围：

不涉及。

target_instances

Array of ResourceInstance objects

参数解释：

当前批次内机器。

取值范围：

不涉及。
表8 ResourceInstance

参数

参数类型

描述

resource_id

String

参数解释：

实例唯一id。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

provider

String

参数解释：

资源提供者：ECS。单个脚本工单， 每个实例的provider是一致的。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

region_id

String

参数解释：

机器所属region的ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

type

String

参数解释：

资源提供者下资源类型，不传默认为CLOUDSERVER。

CLOUDSERVER：CLOUDSERVER类型。

约束限制：

不涉及。

取值范围：

CLOUDSERVER：CLOUDSERVER类型。

默认取值：

不涉及。

custom_attributes

Array of Customttribute objects

参数解释：

支持用户自定义5个key_value形式的属性。

约束限制：

  • key值长度为10 。

  • value长度为20 。

  • map长度最大为5。

取值范围：

不涉及。

默认取值：

不涉及。

agent_sn

String

参数解释：

agent纳管id。该参数即将废弃，请勿使用。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

agent_status

String

参数解释：

agent纳管状态。该参数即将废弃，请勿使用。

约束限制：

不涉及。

取值范围：

  • ONLINE：在线。

  • OFFLINE：离线。

默认取值：

不涉及。

properties

ResourceInstanceProp object

参数解释：

主机附加属性。该参数即将废弃，请勿使用。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表9 Customttribute

参数

参数类型

描述

key

String

参数解释：

自定义属性key。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

value

String

参数解释：

自定义属性的value。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表10 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。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求示例

获取自动分批结果

POST https://{Endpoint}/v1/instances/batches

{
  "batch_strategy" : "AUTO_BATCH",
  "target_instances" : [ {
    "resource_id" : "7c118539-15ab-41d3-9xxxxxxxxx",
    "region_id" : "cn-north-x",
    "provider" : "ECS",
    "type" : "CLOUDSERVERS",
    "agent_sn" : "705c526eb7774c51b321xxxxxxxxx",
    "agent_status" : "ONLINE",
    "properties" : {
      "host_name" : "ecs-0001",
      "fixed_ip" : "192.168.xx.xx",
      "region_id" : "cn-north-x",
      "zone_id" : "cn-north-xx",
      "project_id" : "10a6c23c2a1xxxxxxxxxxxxx"
    }
  } ]
}

响应示例

状态码：200

请求成功。

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

{
  "data" : [ {
    "batch_index" : 1,
    "target_instances" : [ {
      "resource_id" : "7c118539-15ab-41d3xxxxxxxxxxx",
      "agent_sn" : "705c526eb7774c51b32xxxxxxxxxxx",
      "agent_status" : "ONLINE",
      "provider" : "ECS",
      "type" : "CLOUDSERVERS",
      "properties" : {
        "host_name" : "ecs-0001",
        "fixed_ip" : "192.168.xx.xx",
        "floating_ip" : null,
        "region_id" : "cn-north-x",
        "zone_id" : "cn-north-xx",
        "application" : null,
        "group" : null,
        "project_id" : "10a6c23c2a10xxxxxxxxxxx"
      }
    } ]
  } ]
}

状态码

状态码

描述

200

请求成功。

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

错误码

请参见错误码。

父主题： 脚本管理

相关文档