創(chuàng)建Beats采集器時(shí),調(diào)用ListEcsInstances,獲取ECS機(jī)器列表。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
請求頭
該接口使用公共請求頭,無特殊請求頭。請參見公共請求參數(shù)文檔。
請求語法
GET /openapi/ecs HTTP/1.1
請求參數(shù)
名稱 | 類型 | 位置 | 是否必選 | 示例值 | 描述 |
---|---|---|---|---|---|
page | Integer | Query | 否 | 1 |
返回結(jié)果頁數(shù)。最大值500。 |
size | Integer | Query | 否 | 10 |
每頁包含的結(jié)果數(shù)。默認(rèn)值10,最大值500。 |
ecsInstanceIds | String | Query | 否 | ["i-bp13y63575oypr9d****","i-bp1gyhphjaj73jsr****"] |
ECS實(shí)例ID列表。取值可以由多個(gè)實(shí)例ID組成一個(gè)JSON數(shù)組,最多支持100個(gè)ID,ID之間用半角逗號(,)隔開。 |
ecsInstanceName | String | Query | 否 | test |
ECS實(shí)例名稱。 |
tags | String | Query | 否 | [{ "tagKey":"a","tagValue":"b"}] |
ECS實(shí)例標(biāo)簽,必須包含:
|
vpcId | String | Query | 否 | vpc-bp16k1dvzxtmagcva**** |
ECS實(shí)例所在的VPC ID。 |
返回?cái)?shù)據(jù)
名稱 | 類型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D*** |
請求ID。 |
Headers | Object |
返回頭信息。 |
|
X-Total-Count | Integer | 11 |
返回的記錄數(shù)。 |
Result | Array of Result |
返回結(jié)果。 |
|
cloudAssistantStatus | String | true |
云助手安裝狀態(tài),支持:
|
ecsInstanceName | String | ecsTestName |
ECS實(shí)例名稱。 |
ecsInstanceId | String | i-bp14ncqge8wy3l3d**** |
ECS實(shí)例ID。 |
tags | String | [ { "tagKey": "a", "tagValue": "b" } ] |
ECS實(shí)例的標(biāo)簽信息。 |
osType | String | linux |
ECS實(shí)例的操作系統(tǒng)類型。支持:
|
status | String | running |
ECS實(shí)例的狀態(tài)。支持:
|
ipAddress | Array of ipAddress |
ECS實(shí)例的IP地址信息。 |
|
ipType | String | private |
IP地址類型。支持:
|
host | String | 172.16.xx.xx |
IP地址。 |
collectors | Array of collectors |
該ECS實(shí)例上,采集器信息列表。 |
|
resId | String | ct-cn-0v3xj86085dvq**** |
采集器實(shí)例ID。 |
gmtUpdateTime | String | 2020-06-20T07:26:47.000+0000 |
采集器更新時(shí)間。 |
dryRun | Boolean | false |
是否校驗(yàn)并創(chuàng)建采集器。支持:
|
ownerId | String | 16852***488***** |
賬號ID。 |
vpcId | String | vpc-bp16k1dvzxtm****** |
采集器所在的專有網(wǎng)絡(luò)ID。 |
resType | String | fileBeat |
采集器類型。支持fileBeat、metricBeat、heartBeat和auditBeat。 |
resVersion | String | 6.8.5_with_community |
采集器版本。采集器部署的機(jī)器類型為ECS時(shí),只支持6.8.5_with_community。 |
gmtCreatedTime | String | 2020-06-20T07:26:47.000+0000 |
采集器創(chuàng)建時(shí)間。 |
status | String | activing |
采集器狀態(tài)。支持:
|
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 .... |
文件內(nèi)容。 |
fileName | String | fields.yml |
文件名稱。 |
extendConfigs | Array of extendConfigs |
擴(kuò)展參數(shù)信息。 |
|
enableMonitoring | Boolean | true |
是否啟用Monitoring,當(dāng)configType為collectorTargetInstance,且instanceType為elasticsearch時(shí)顯示。支持:
|
groupId | String | default_ct-cn-5i2l75bz4776**** |
機(jī)器組ID。當(dāng)configType為collectorDeployMachine時(shí)顯示。 |
configType | String | collectorDeployMachine |
配置類型。支持:
|
instanceType | String | elasticsearch |
采集器Output指定的實(shí)例類型。支持elasticsearch、logstash。當(dāng)configType為collectorTargetInstance時(shí)顯示。 |
protocol | String | HTTP |
傳輸協(xié)議,需要與采集器Output指定實(shí)例的訪問協(xié)議保持一致。支持HTTP、HTTPS。當(dāng)configType為collectorTargetInstance時(shí)顯示。 |
userName | String | elastic |
采集器Output指定實(shí)例的訪問用戶名,默認(rèn)為elastic。當(dāng)configType為collectorTargetInstance或collectorElasticsearchForKibana時(shí)顯示。 |
type | String | ECSInstanceId |
采集器部署的機(jī)器類型,當(dāng)configType為collectorDeployMachine時(shí)顯示。支持:
|
instanceId | String | es-cn-nif1z89fz003i**** |
采集器關(guān)聯(lián)的實(shí)例ID。當(dāng)configType為collectorTargetInstance時(shí),為采集器Output的實(shí)例ID;當(dāng)configType為collectorDeployMachines,且type為ACKCluster時(shí),為ACK(容器Kubernetes)集群ID。 |
machines | Array of machines |
采集器所部署的ECS機(jī)器列表信息。當(dāng)configType為collectorDeployMachines,且type為ECSInstanceId時(shí)顯示。 |
|
agentStatus | String | heartOk |
ECS上各采集器的狀態(tài)。支持:
|
instanceId | String | i-bp13y63575oypr9d**** |
ECS機(jī)器ID列表。 |
hosts | Array of String | ["es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200"] |
采集器Output指定實(shí)例的訪問地址列表。當(dāng)configType為collectorTargetInstance時(shí)顯示。 |
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
}
}
錯(cuò)誤碼
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。