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

Logstash パイプライン管理構成を取得するには、DescribePipelineManagementConfig を呼び出します。

デバッグ

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

リクエストヘッダー

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

リクエスト構文

GET /openapi/logstashes/[InstanceId]/pipeline-management-config HTTPS|HTTP

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
InstanceId	String	はい	ls-cn-oew1qbgl****	Logstash インスタンスの ID。
clientToken	String	いいえ	5A2CFF0E-5718-45B5-9D4D-70B3FF****	リクエストの冪等性を保証するためにクライアントによって生成された一意のトークン。このパラメーターの値はクライアントによって生成され、異なるリクエスト間で一意です。最大長は 64 ASCII 文字です。

レスポンスパラメーター

パラメーター	タイプ	例	説明
RequestId	String	5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***	リクエストの ID。
Result	Struct		戻り結果。
endpoints	String	["http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"]	Elasticsearch インスタンスのアクセスアドレスのリスト。フォーマット：`ドメイン：ポート番号`。
esInstanceId	String	es-cn-n6w1o1x0w001c****	Elasticsearch インスタンスの ID。
pipelineIds	List	["testKibanaManagement"]	パイプライン名のリスト。
pipelineManagementType	String	MULTIPLE_PIPELINE	パイプライン管理方法。 Kibana と MULTIPLE_PIPELINE をサポートしています。
userName	String	elastic	インスタンスへのアクセスに使用されるユーザー名。

例

リクエストの例

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

正常なレスポンスの例

JSON 構文

{
    "Result": {
        "pipelineManagementType": "MULTIPLE_PIPELINE",
        "esInstanceId": "es-cn-n6w1o1x0w001c****",
        "endpoints": [
            "http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"
        ],
        "pipelineIds": [
            "testKibanaManagement"
        ],
        "userName": "elastic"
    },
    "RequestId": "6822F07C-A896-4A2C-A430-BC01D5D1****"
}

エラーコード

HttpCode	エラーコード	エラーメッセージ	説明
400	InstanceNotFound	The instanceId provided does not exist.	インスタンスが見つからないために返されるエラーメッセージ。インスタンスの状態を確認してください。

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