Beats コレクタ用の ECS インスタンス取得 - Elasticsearch (ES)

Beatsコレクターを作成する際に、ListEcsInstances を呼び出して ECS インスタンスのリストを取得します。

重要この操作を呼び出すには、Aliyun Elasticsearch AccessingOOSRole とシステムサービスロール AliyunOOSAccessingECS 4ESRole を Elasticsearch サービスアカウントに作成して、プライマリアカウントの ECS アクセス権限を取得する必要があります。詳細については、「ECS サービスログを収集する」をご参照ください。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

リクエストヘッダー

この操作では、共通のリクエストヘッダーのみを使用します。詳細については、共通のリクエストヘッダーをご参照ください。

リクエスト構文

GET /openapi/ecs HTTP/1.1

リクエストパラメーター

パラメーター	タイプ	場所	必須	例	説明
page	Integer	Query	No	1	返される結果ページの数。最大値は 500 です。
size	Integer	Query	No	10	1 ページに含まれる結果の数。デフォルト値：10。最大値：500。
ecsInstanceIds	String	Query	No	["i-bp13y63575oypr9d**","i-bp1gyhphjaj73jsr**"]	ECS インスタンス N の ID。値は、最大 100 個のインスタンス ID で構成される JSON 配列です。インスタンス ID はコンマ（,）で区切ります。
ecsInstanceName	String	Query	No	test	ECS インスタンスの名前。
tags	String	Query	No	[{ "tagKey":"a","tagValue":"b"}]	ECS インスタンスのタグ。以下を含める必要があります。 tagKey: タグキー tagValue: タグ値
vpcId	String	Query	No	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: Prometheus エージェントがインストールされています。 false: Prometheus エージェントはインストールされていません。
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***	Alibaba Cloud アカウントの ID。
vpcId	String	vpc-bp16k1dvzxtm******	コレクターが属する Virtual Private Cloud の 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	コレクターのステータス。有効な値： activating: プロジェクトは有効化中です。 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	configType が collectorTargetInstance で、instanceType が Elasticsearch の場合に、Monitoring が有効になっているかどうかが表示されます。有効な値： true false
groupId	String	default_ct-cn-5i2l75bz4776****	configType が collectorDeployMachine の場合に表示されます。ホストグループの ID。
configType	String	collectorDeployMachine	構成タイプ。有効な値： collectorTargetInstance: コレクター出力 collectorDeployMachine: コレクターデプロイマシン Collector Elasticsearch ForKibana: Kibana ダッシュボードをサポートする Elasticsearch インスタンス情報
instanceType	String	elasticsearch	コレクター出力で指定されたインスタンスタイプ。Elasticsearch と Logstash をサポートします。configType が collectorTargetInstance の場合に表示されます。
protocol	String	HTTP	転送プロトコル。出力で指定されたインスタンスのアクセスプロトコルと同じである必要があります。HTTP および HTTPS。configType が collectorTargetInstance の場合に表示されます。
userName	String	elastic	インスタンスへのアクセスに使用するユーザー名。デフォルト値は elastic です。configType が collectorTargetInstance または collectorElasticsearchForKibana の場合に表示されます。
type	String	ECSInstanceId	コレクターがデプロイされているマシンのタイプ。configType が collectorDeployMachine の場合に、このパラメーターが表示されます。有効な値： ECSInstanceId: ECS ACKCluster: Container Kubernetes
instanceId	String	es-cn-nif1z89fz003i****	クローラーに関連付けられているインスタンスの ID。configType パラメーターが collectorTargetInstance に設定されている場合、このパラメーターの値は出力コレクターの ID です。configType パラメーターが collectorDeployMachines に設定されていて、type パラメーターが ACKCluster に設定されている場合、このパラメーターの値は ACK クラスタの 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"]	コレクターの出力用に指定されたインスタンスのアクセスアドレスのリスト。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
  }
}

エラーコード

エラーコードの一覧については、「サービスエラーコード」をご参照ください。