创建Beats采集器时，调用ListEcsInstances，获取ECS机器列表。

重要
接口前置需要创建AliyunElasticsearchAccessingOOSRole和AliyunOOSAccessingECS4ESRole的系统服务角色，用于Elasticsearch服务账号获取主账号的ECS访问权限等，详细信息请参见采集ECS服务日志。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

请求头

该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。

请求语法

GET /openapi/ecs HTTP/1.1

请求参数

名称类型位置是否必选示例值描述
名称 类型 位置 是否必选 示例值 描述
page Integer Query 否 1

返回结果页数。最大值500。
size Integer Query 否 10

每页包含的结果数。默认值10，最大值500。
ecsInstanceIds String Query 否 ["i-bp13y63575oypr9d****","i-bp1gyhphjaj73jsr****"]

ECS实例ID列表。取值可以由多个实例ID组成一个JSON数组，最多支持100个ID，ID之间用半角逗号（,）隔开。
ecsInstanceName String Query 否 test

ECS实例名称。
tags String Query 否 [{ "tagKey":"a","tagValue":"b"}]

ECS实例标签，必须包含：

  • tagKey：标签键
  • tagValue：标签值
vpcId String Query 否 vpc-bp16k1dvzxtmagcva****

ECS实例所在的VPC ID。

返回数据

名称类型示例值描述
名称 类型 示例值 描述
RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***

请求ID。
Headers Object

返回头信息。
X-Total-Count Integer 11

返回的记录数。
Result Array of Result

返回结果。
cloudAssistantStatus String true

云助手安装状态，支持：

  • true：已安装
  • false：未安装
ecsInstanceName String ecsTestName

ECS实例名称。
ecsInstanceId String i-bp14ncqge8wy3l3d****

ECS实例ID。
tags String [ { "tagKey": "a", "tagValue": "b" } ]

ECS实例的标签信息。
osType String linux

ECS实例的操作系统类型。支持：

  • windows：Windows操作系统
  • linux：Linux操作系统
status String running

ECS实例的状态。支持：

  • running：运行中
  • starting：启动中
  • stopping：停止中
  • stopped：已停止
ipAddress Array of ipAddress

ECS实例的IP地址信息。
ipType String private

IP地址类型。支持：

  • public：公网地址
  • private：私网地址
host String 172.16.xx.xx

IP地址。
collectors Array of collectors

该ECS实例上，采集器信息列表。
resId String ct-cn-0v3xj86085dvq****

采集器实例ID。
gmtUpdateTime String 2020-06-20T07:26:47.000+0000

采集器更新时间。
dryRun Boolean false

是否校验并创建采集器。支持：

  • true：只校验不创建
  • false：校验并创建
ownerId String 16852***488*****

账号ID。
vpcId String vpc-bp16k1dvzxtm******

采集器所在的专有网络ID。
resType String fileBeat

采集器类型。支持fileBeat、metricBeat、heartBeat和auditBeat。
resVersion String 6.8.5_with_community

采集器版本。采集器部署的机器类型为ECS时，只支持6.8.5_with_community。

gmtCreatedTime String 2020-06-20T07:26:47.000+0000

采集器创建时间。
status String activing

采集器状态。支持：

  • activing：生效中
  • active：已生效
name String ct-testAbc

采集器名称。
configs Array of configs

采集器的配置文件信息。
content String - key: log\n title: Log file content\n description: >\n Contains log file lines.\n ....

文件内容。
fileName String fields.yml

文件名称。
extendConfigs Array of extendConfigs

扩展参数信息。
enableMonitoring Boolean true

是否启用Monitoring，当configType为collectorTargetInstance，且instanceType为elasticsearch时显示。支持：

  • true：启用
  • false：不启用
groupId String default_ct-cn-5i2l75bz4776****

机器组ID。当configType为collectorDeployMachine时显示。

configType String collectorDeployMachine

配置类型。支持：

  • collectorTargetInstance：采集器Output
  • collectorDeployMachine：采集器的部署机器
  • collectorElasticsearchForKibana：支持Kibana仪表盘的Elasticsearch实例信息
instanceType String elasticsearch

采集器Output指定的实例类型。支持elasticsearch、logstash。当configType为collectorTargetInstance时显示。

protocol String HTTP

传输协议，需要与采集器Output指定实例的访问协议保持一致。支持HTTP、HTTPS。当configType为collectorTargetInstance时显示。

userName String elastic

采集器Output指定实例的访问用户名，默认为elastic。当configType为collectorTargetInstance或collectorElasticsearchForKibana时显示。

type String ECSInstanceId

采集器部署的机器类型，当configType为collectorDeployMachine时显示。支持：

  • ECSInstanceId：ECS
  • ACKCluster：容器Kubernetes
instanceId String es-cn-nif1z89fz003i****

采集器关联的实例ID。当configType为collectorTargetInstance时，为采集器Output的实例ID；当configType为collectorDeployMachines，且type为ACKCluster时，为ACK（容器Kubernetes）集群ID。

machines Array of machines

采集器所部署的ECS机器列表信息。当configType为collectorDeployMachines，且type为ECSInstanceId时显示。

agentStatus String heartOk

ECS上各采集器的状态。支持：

  • heartOk：心跳正常
  • heartLost：心跳异常
  • uninstalled：未安装
  • failed：安装失败
instanceId String i-bp13y63575oypr9d****

ECS机器ID列表。
hosts Array of String ["es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200"]

采集器Output指定实例的访问地址列表。当configType为collectorTargetInstance时显示。

collectorPaths Array of String ["/var/log"]

Filebeat的采集路径。

示例

请求示例

GET /openapi/ecs?page=1&size=10 HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

正常返回示例

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Result" : [ {
    "ecsInstanceId" : "i-bp1gyhphjaj73jsr****",
    "ecsInstanceName" : "test",
    "status" : "running",
    "ipAddress" : [ {
      "host" : "47.98.xx.xx",
      "ipType" : "public"
    }, {
      "host" : "172.16.xx.xx",
      "ipType" : "private"
    } ],
    "tags" : [ ],
    "collectors" : [ {
      "gmtCreatedTime" : "2020-12-30T08:04:32.000+0000",
      "gmtUpdateTime" : "2020-12-30T08:20:48.000+0000",
      "name" : "uptime-test",
      "resId" : "ct-cn-4135is2tj194p****",
      "resVersion" : "6.8.5_with_community",
      "vpcId" : "vpc-bp16k1dvzxtmagcva****",
      "resType" : "heartBeat",
      "ownerId" : "168520994880****",
      "configs" : [ {
        "fileName" : "fields.yml"
      }, {
        "fileName" : "heartbeat.yml"
      } ],
      "status" : "active",
      "extendConfigs" : [ {
        "configType" : "collectorTargetInstance",
        "instanceId" : "es-cn-n6w1o1x0w001c****",
        "instanceType" : "elasticsearch",
        "hosts" : [ "es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200" ],
        "protocol" : "HTTP",
        "userName" : "elastic",
        "enableMonitoring" : true
      }, {
        "configType" : "collectorDeployMachine",
        "type" : "ECSInstanceId",
        "machines" : [ {
          "instanceId" : "i-bp1gyhphjaj73jsr****",
          "agentStatus" : "heartOk"
        } ],
        "groupId" : "default_ct-cn-4135is2tj194p****"
      } ],
      "dryRun" : false
    } ],
    "osType" : "linux",
    "cloudAssistantStatus" : "true"
  } ],
  "RequestId" : "58E5DE98-33B0-4D9B-B5F6-E70A77C5933E",
  "Headers" : {
    "X-Total-Count" : 2
  }
}

错误码

访问错误中心查看更多错误码。