Elasticsearch:DescribeCollector

パラメーター

タイプ

場所

必須

例

説明

ResId

String

パス

はい

ct-cn-rg31ahn82m0qd****

シッパー ID。

パラメーター

タイプ

例

説明

RequestId

String

5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

リクエスト ID。

Result

Struct

返された結果。

collectorPaths

List

["/var/log"]

シッパーのコレクションパス。

configs

configs の配列

シッパーの構成ファイルに関する情報。

content

String

fileBeat.inputs:xxx

構成ファイルの内容。

fileName

String

filebeat.yml

構成ファイルの名前。

dryRun

ブール値

false

ドライランを実行するかどうかを示します。有効な値：

• true

• false

extendConfigs

extendConfigs の配列

シッパーの拡張構成。

configType

String

collectorDeployMachine

構成タイプ。有効な値：

• collectorTargetInstance: シッパーの出力に関する情報を示します。

• collectorDeployMachine: シッパーがインストールされているマシンに関する情報を示します。

• collectorElasticsearchForKibana: Kibana ダッシュボードが有効になっている Elasticsearch クラスターに関する情報を示します。

enableMonitoring

ブール値

true

の値が の場合にのみ、Kibana Monitoring が有効になっているかどうかを示します。構成タイプ 有効な値：collectorTargetInstance。有効な値:

• true

• false

groupId

String

default_ct-cn-5i2l75bz4776****

の値が の場合にのみ、マシングループの ID を返します。 構成タイプ です collectorDeployMachine。

host

String

es-cn-n6w1o1x0w001c****-kibana.internal.elasticsearch.aliyuncs.com:5601

の値が の場合にのみ、Kibana ダッシュボードを有効にした後、内部ネットワーク経由で Kibana にアクセスするために使用されるアドレスを返します。 構成タイプ です collectorElasticsearchForKibana。

hosts

List

["es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200"]

の値が の場合にのみ、シッパーの出力のアクセスアドレスを返します。 構成タイプ です collectorTargetInstance。

instanceId

String

es-cn-n6w1o1****

シッパーに関連付けられているオブジェクトの ID です。configType の値が collectorTargetInstance の場合、このパラメーターの値は、シッパーの出力構成部分で指定されたリソースの ID です。configType の値が collectorDeployMachine で、type の値が ACKCluster の場合、このパラメーターの値は Container Service for Kubernetes (ACK) クラスターの ID です。

instanceType

String

elasticsearch

の値が の場合にのみ、シッパーの出力のタイプを返します。有効な値： elasticsearch および logstash。 構成タイプ です collectorTargetInstance。

kibanaHost

String

https://es-cn-nif1z89fz003i****.kibana.elasticsearch.aliyuncs.com:5601

の値が の場合にのみ、Kibana ダッシュボードを有効にした後、インターネット経由で Kibana にアクセスするために使用されるアドレスを返します。 構成タイプ です collectorElasticsearchForKibana。

machines

machines の配列

の値が で、 の値が の場合にのみ、シッパーがインストールされている ECS インスタンスに関する情報を返します。 構成タイプ です collectorDeployMachine と値 種類 です ECSインスタンス ID。

agentStatus

String

heartOk

ECS インスタンス上のシッパーのステータス。有効な値：

• heartOk: ハートビートは正常です。

• heartLost: ハートビートが異常です。

• uninstalled: シッパーはインストールされていません。

• failed: シッパーのインストールに失敗しました。

instanceId

String

i-bp1gyhphjaj73jsr****

シッパーがインストールされている ECS インスタンスの ID。

protocol

String

HTTP

の値が の場合にのみ、使用される転送プロトコルを返します。シッパーの出力にアクセスできるプロトコルと同じです。有効な値： HTTP および HTTPS。 構成タイプ です collectorTargetInstance。

successPodsCount

String

8

ACK クラスターでデータが正常に収集されたポッドの数。

totalPodsCount

String

10

ACK クラスターでログを収集する必要のあるポッドの数。

type

String

ECSInstanceId

の値が の場合にのみ、シッパーがインストールされているマシンのタイプを返します。構成タイプ です collectorDeployMachine 有効な値：

• ECSInstanceId

• ACKCluster

userName

String

elastic

の値が または の場合にのみ、シッパーの出力にアクセスするために使用されるユーザー名を返します。デフォルト値： elastic。 構成タイプ です collectorTargetInstance または collectorElasticsearchForKibana。

gmtCreatedTime

String

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

シッパーが作成された時刻。

gmtUpdateTime

String

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

シッパーが更新された時刻。

name

String

ct-cn-4135is2tj194p****

シッパーの名前。

ownerId

String

16852099488*****

アカウント ID。

resId

String

ct-cn-rg31ahn82m0qd****

シッパー ID。

resType

String

fileBeat

シッパーのタイプ。有効な値： fileBeat、metricBeat、heartBeat、および auditBeat。

resVersion

String

6.8.5_with_community

シッパーのバージョン。

status

String

active

シッパーのステータス。有効な値：

• activing: シッパーは初期化中です。

• active: シッパーは有効です。

vpcId

String

vpc-bp16k1dvzxtma*****

シッパーが存在する仮想プライベートクラウド (VPC) の ID。