CreateCollector - Elasticsearch - Alibaba Cloud ドキュメントセンター

シッパーを作成します。

デバッグ

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

リクエストヘッダー

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

リクエスト構文

POST /openapi/collectors HTTP/1.1

リクエストパラメーター

パラメーター	タイプ	場所	必須	例	説明
clientToken	String	クエリ	いいえ	5A2CFF0E-5718-45B5-9D4D-70B3FF****	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用して値を生成できますが、異なるリクエスト間で値が一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。
	Object	本文	いいえ		リクエスト本文のパラメーター。作成するクローラーの構成情報を指定するために使用されます。
dryRun	ブール値	本文	はい	true	クローラーを検証して作成するかどうかを指定します。このパラメーターは、クローラーを作成または更新する場合にのみ使用されます。有効な値： true: 検証のみを行い、データを更新しません。 false: 検証と更新を行います。
name	String	本文	はい	ct-test	コレクターの名前。名前は 1 ～ 30 文字で、文字、数字、アンダースコア (_)、ハイフン (-) を使用できます。名前は文字で始める必要があります。
resType	String	本文	はい	fileBeat	コレクターのタイプ。有効な値: fileBeat、metricBeat、heartBeat、auditBeat。
vpcId	String	本文	はい	vpc-bp12nu14urf0upaf*****	コレクターが属する仮想プライベートクラウド (Virtual Private Cloud) の ID。
resVersion	String	本文	はい	6.8.5_with_community	コレクターのバージョン。有効な値： ECS ベースのデプロイ: 6.8.5_with_community ACK ベースのデプロイ: 6.8.13_with_community
collectorPaths	String の配列	本文	いいえ	["/var/log"]	fileBeat コレクションのパス。このパラメーターは、コレクターが ECS インスタンスにインストールされている場合にのみ必須です。
configs	配列	本文	はい		コレクターの構成ファイル情報。
fileName	String	本文	はい	filebeat.yml	ファイルの名前。
content	String	本文	はい	"filebeat.inputs:xxx"	ファイルの内容。
extendConfigs	Object の配列	本文	はい	{ "instanceId": "es-cn-nif201ihd0012**", "instanceType": "elasticsearch", "configType": "collectorTargetInstance", "hosts": [ "es-cn-nif201ihd0012.elasticsearch.aliyuncs.com:9200" ], "userName": "elastic", "password": "*", "protocol": "HTTP" }, { "type": "ECSInstanceId", "configType": "collectorDeployMachine", "machines": [ { "instanceId": "i-bp11u91xgubypcuz**" } ] } ]	コレクターの拡張構成。詳細については、次の extendConfigs パラメーターのセクションをご参照ください。

extendConfigs パラメーターの説明

次の表は、extendConfigs のパラメーターについて説明しています。

パラメーター	タイプ	必須	例	説明
extendConfigs	配列			コレクターの拡張構成。
└configType	String	はい	collectorElasticsearchForKibana	構成タイプ。有効な値: collectorTargetInstance (コレクター出力)、collectorDeployMachine (コレクターデプロイマシン)、collectorElasticsearchForKibana (Kibana ダッシュボードをサポートする Elasticsearch インスタンス情報)。
└type	String	いいえ	ECSInstanceId	コレクターがデプロイされているマシンのタイプ。有効な値: ECSInstanceId (ECS) および ACKCluster (Container Kubernetes)。このパラメーターは、configType が collectorDeployMachine に設定されている場合に必須です。
└instanceType	String	いいえ	elasticsearch	コレクター出力で指定されたインスタンスタイプ。有効な値: Elasticsearch および logstash。このパラメーターは、configType が collectorTargetInstance に設定されている場合に必須です。
└instanceId	String	はい	es-cn-nif201ihd0012****	クローラーに関連付けられているインスタンスの ID。 configType パラメーターが collectorTargetInstance に設定されている場合、このパラメーターの値はクローラーの出力の ID です。 configType パラメーターが collectorDeployMachines に設定され、type パラメーターが ACKCluster に設定されている場合、このパラメーターの値は ACK クラスタの ID です。
└machines	配列	いいえ		コレクターがデプロイされている ECS インスタンスのリスト。このパラメーターは、configType が collectorDeployMachines で、type が ECSInstanceId の場合に必須です。
└└instanceId	String	はい	i-bp11u91xgubypcuz****	ECS インスタンスの ID。
└groupId	String		default_ct-cn-5i2l75bz4776****	configType が collectorDeployMachine に設定されている場合に必須となるホストグループの ID です。
└protocol	String	いいえ	HTTP	転送プロトコル。これは、出力で指定されたインスタンスのアクセスプロトコルと同じである必要があります。有効な値: HTTP および HTTPS。このパラメーターは、configType が collectorTargetInstance に設定されている場合に必須です。
└userName	String	いいえ	elastic	インスタンスにアクセスするために使用されるユーザー名。デフォルト値は elastic です。このパラメーターは、configType が collectorTargetInstance または collectorElasticsearchForKibana に設定されている場合に必須です。
└password	String	いいえ	*****	対応するユーザー名のパスワード。
└enableMonitoring	ブール値	いいえ	true	configType が collectorTargetInstance で、instanceType が Elasticsearch の場合に必須となる、モニタリングが有効かどうかを示します。有効な値: true (有効) および false (無効)。
└hosts	List<String>	いいえ	["es-cn-nif201i*****.elasticsearch.aliyuncs.com:9200"]	コレクターの出力用に指定されたインスタンスのアクセスアドレスのリスト。このパラメーターは、configType が collectorTargetInstance に設定されている場合に必須です。
└host	String	いいえ	es-cn-nif201ihd0012****-kibana.internal.elasticsearch.aliyuncs.com:5601	configType が collectorElasticsearchForKibana に設定されている場合に必須となる、Kibana ダッシュボードを有効にした後の Kibana のプライベートエンドポイント。
└kibanaHost	String	いいえ	https://es-cn-nif201ihd0012****.kibana.elasticsearch.aliyuncs.com:5601	configType が collectorElasticsearchForKibana に設定されている場合に必須となる、Kibana ダッシュボードを有効にした後の Kibana のパブリックエンドポイント。

説明

└ は子パラメーターを示します。

extendConfigs には、collectorTargetInstance、collectorElasticsearchForKibana、collectorDeployMachine の 3 つの configType が含まれています。構成するパラメーターは、デプロイマシンによって異なります。具体的な組み合わせは次のとおりです。

collectorTargetInstance
- ECS
  configType、instanceId、instanceType、hosts、userName、password、protocol、enableMonitoring
- ACK
  configType、instanceId、instanceType、userName、password、protocol、enableMonitoring
collectorElasticsearchForKibana
- ECS
  configType、instanceId、host、kibanaHost、userName、password、protocol
- ACK
  configType
collectorDeployMachine
- ECS
  configType、type、machines、groupId
- ACK
  configType、type、instanceId

レスポンスパラメーター

要素	タイプ	例	説明
RequestId	String	8466BDFB-C513-4B8D-B4E3-5AB256AB****	リクエストの ID。
Result	Object		返された結果。
resId	String	ct-cn-4135is2tj194p****	作成されたクローラーの ID。

例

リクエストの例

POST /openapi/collectors?clientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF**** HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

{
    "dryRun": false, 
    "name": "test_beats_1", 
    "resType": "fileBeat", 
    "resVersion": "6.8.5_with_community", 
    "vpcId": "vpc-bp12nu14urf0upaf*****", 
    "collectorPaths": [
        "/var/log"
    ], 
    "extendConfigs": [
        {
            "instanceId": "es-cn-nif201ihd0012****", 
            "instanceType": "elasticsearch", 
            "configType": "collectorTargetInstance", 
            "hosts": [
                "es-cn-nif201ihd0012****.elasticsearch.aliyuncs.com:9200"
            ], 
            "userName": "elastic", 
            "password": "*****", 
            "protocol": "HTTP"
        }, 
        {
            "type": "ECSInstanceId", 
            "configType": "collectorDeployMachine", 
            "machines": [
                {
                    "instanceId": "i-bp11u91xgubypcuz****"
                }
            ]
        }
    ], 
    "configs": [
        {
            "fileName": "filebeat.yml", 
            "content": "filebeat.inputs:xxx"
        }, 
        {
            "fileName": "fields.yml", 
            "content": "- key: log\n title: Log file content\n description: >\n Contains log file lines.\n ...."
        }
    ]
}

成功レスポンスの例

JSON 形式

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

{
  "Result" : {
    "resId" : "ct-cn-4135is2tj194p****"
  },
  "RequestId" : "8466BDFB-C513-4B8D-B4E3-5AB256AB****"
}

エラーコード

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