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

DescribeXpackMonitorConfig を呼び出して、Logstash インスタンスの X-Pack 監視構成を取得します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer を使用すると、API 操作の検索、API 操作の呼び出し、SDK サンプルコードの動的生成を行うことができます。

リクエストヘッダー

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

リクエスト構文

GET /openapi/logstashes/[InstanceId]/xpack-monitor-config HTTPS|HTTP

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
InstanceId	String	はい	ls-cn-oew1qbgl****	Logstash インスタンスの ID。

レスポンスパラメーター

パラメーター	タイプ	例	説明
RequestId	String	5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****	リクエストの ID。
Result	Struct		返された結果。
enable	Boolean	true	X-Pack 監視を有効にするかどうかを示します。有効な値： true: 有効 false: 無効
endpoints	List	["http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"]	監視に関連付けられた Elasticsearch インスタンスへの X-Pack アクセスアドレスのリスト。
esInstanceId	String	es-cn-n6w1o1x0w001c****	Elasticsearch 監視タスクに関連付けられた X-Pack インスタンスの ID。
pipelineIds	List	[]	監視のために関連付けられた Kibana インスタンスによって管理される X-Pack パイプラインのリスト。
userName	String	elastic	監視ジョブに関連付けられた Elasticsearch インスタンスにアクセスするために使用される X-Pack ユーザー名。

例

リクエストの例

GET /openapi/logstashes/ls-cn-oew1qbgl****/xpack-monitor-config HTTP/1.1 
共通リクエストヘッダー

正常なレスポンスの例

JSON 構文

{
    "Result": {
        "esInstanceId": "es-cn-n6w1o1x0w001c****",
        "endpoints": [
            "http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"
        ],
        "pipelineIds": [],
        "userName": "elastic",
        "enable": true
    },
    "RequestId": "9EC7377A-60D7-4AB2-ADE3-983E1D0D****"
}

エラーコード

エラーコードのリストについては、API エラーセンターをご覧ください。