すべてのプロダクト
Search

このプロダクト

    Elasticsearch:ListLogstash

    ドキュメントセンター

    Elasticsearch:ListLogstash

    最終更新日:Mar 17, 2025

    すべての Logstash クラスターまたは指定された Logstash クラスターの詳細情報をクエリします。

    デバッグ

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

    リクエストヘッダー

    /openapi/logstashes

    リクエスト構文

    GET /openapi/logstashes HTTP/1.1

    リクエストパラメーター

    パラメーター タイプ 位置 必須 例 説明
    page Integer Query No 1

    返されるページのページ番号。デフォルト値：1。
    size Integer Query No 10

    各ページに返すエントリの数。デフォルト値：20。
    description String Query No ls-cn-abc

    インスタンスの名前。複数のインスタンスを照合するためにキーワードを指定できます。たとえば、abc という名前のインスタンスをクエリすると、abc、abcde、xyabc、xabcy という名前のすべてのインスタンスが返される可能性があります。
    instanceId String Query No ls-cn-n6w1o5jq****

    インスタンスの ID。
    version String Query No 5.5.3_with_X-Pack

    インスタンスのバージョン。
    resourceGroupId String Query No rg-acfm2h5vbzd****

    リソースグループの ID。
    tags String Query No [{"tagKey":"key1","tagValue":"value1"}]

    インスタンスのタグ。有効な値：

    レスポンスパラメーター

    パラメーター タイプ 例 説明
    RequestId String AC442F2F-5068-4434-AA21-E78947A9****

    リクエストの ID。
    Headers Object

    リクエストヘッダーの詳細。
    X-Total-Count Integer 10

    1 ページあたりに返されるエントリの数。
    Result Array of Instance

    一致するインスタンスに関する詳細情報。
    paymentType String postpaid

    インスタンスの課金方法。サポートされているのは、prepaid（サブスクリプション）と postpaid（従量課金）です。
    nodeAmount Integer 2

    データノードの数。
    description String ls-cn-abc

    VPC の名前。
    createdAt String 2018-07-13T03:58:07.253Z

    インスタンスが作成された日時。
    status String active

    インスタンスの状態。有効な値：Normal、Active、Inactive、Invalid。
    updatedAt String 2018-07-18T10:10:04.484Z

    インスタンスが最後に更新された日時。
    instanceId String ls-cn-n6w1o5jq****

    インスタンスの ID。
    version String 6.7.0_with_X-Pack

    インスタンスのバージョン。現在、6.7.0_with_X-Pack と 7.4.0_with_X-Pack のみがサポートされています。
    Tags Array of tags

    インスタンスのタグ。有効な値：
    TagValue String dev

    クラウドディスクのタグ値。
    TagKey String env

    クラウドディスクのタグキー。
    nodeSpec Object

    データノードの構成情報。
    spec String logstash.n4.small

    ECS インスタンスのインスタンスタイプ。
    disk Integer 50

    ノードのディスクサイズ。
    diskEncryption Boolean false

    ディスクの暗号化を使用するかどうかを指定します。有効な値：

    • true：集計クエリ以外のクエリに対して同時クエリ機能を有効にします。
    • false：集計クエリ以外のクエリに対して同時クエリ機能を無効にします。
    diskType String cloud_ssd

    ディスクのタイプ。
    networkConfig Object

    ネットワーク構成。
    vpcId String vpc-abc

    VPC の ID。
    vsArea String cn-hangzhou-*

    クラスターが存在するゾーン。
    type String vpc

    ネットワークタイプ。現在、Virtual Private Cloud（VPC）のみがサポートされています。
    vswitchId String vsw-def

    vSwitch の ID。

    返されるデータには、次のパラメーターも含まれています。

    パラメーター

    タイプ

    例

    説明

    enablePublic

    Boolean

    false

    インターネットアクセスを有効にするかどうかを指定します。デフォルト値：false。

    commodityCode

    String

    elasticsearch_logstash_post

    サービスのコード。

    endTime

    Long

    4749897600000

    サブスクリプションインスタンスの最終有効期限。

    clusterTasks

    Array

    []

    インスタンスのタスクリスト。

    resourceGroupId

    String

    rg-acfm2h5vbzd****

    インスタンスが属するリソースグループの ID。

    zoneCount

    Integer

    1

    Elasticsearch クラスターがデプロイされているゾーンの数。

    protocol

    String

    HTTP

    インスタンスのアクセスプロトコル。

    zoneInfos

    Array

    ゾーンに関する情報。

    └zoneId

    String

    cn-hangzhou-i

    クラスターのゾーン ID。

    └status

    String

    NORMAL

    ゾーンのステータス。サポートされているのは、ISOLATION（オフライン）と NORMAL（通常）です。

    instanceType

    String

    logstash

    インスタンスのエディション。

    inited

    Boolean

    true

    インスタンスが初期化済みかどうかを示します。

    config

    Array

    []

    ECS インスタンスを構成します。

    endpointList

    Array

    ノード情報。

    └host

    String

    172.16.xx.xx

    ノードの IP アドレス。

    └port

    Integer

    9200

    ノードのアクセスポート番号。

    └zoneId

    String

    cn-hangzhou-i

    ノードのゾーン ID。
    説明 └ は子パラメーターを示します。

    例

    サンプルリクエスト

    GET /openapi/logstashes?page=1&size=10&description=ls-cn-abc&instanceId=ls-cn-n6w1o5jq****&version=5.5.3_with_X-Pack&resourceGroupId=rg-acfm2h5vbzd****&tags=[{"tagKey":"key1","tagValue":"value1"}] HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

    サンプルの成功レスポンス

    JSON 形式

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

{
  "Result" : [ {
    "instanceId" : "ls-cn-n6w1o5jq****",
    "version" : "6.7.0_with_X-Pack",
    "description" : "test",
    "nodeAmount" : 1,
    "paymentType" : "postpaid",
    "status" : "active",
    "enablePublic" : false,
    "nodeSpec" : {
      "spec" : "elasticsearch.sn1ne.large",
      "disk" : 20,
      "diskType" : "cloud_ssd"
    },
    "networkConfig" : {
      "vpcId" : "vpc-bp16k1dvzxtmagcva****",
      "vswitchId" : "vsw-bp1k4ec6s7sjdbudw****",
      "vsArea" : "cn-hangzhou-i",
      "type" : "vpc"
    },
    "createdAt" : "2020-05-27T01:30:15.947Z",
    "updatedAt" : "2020-05-27T01:40:51.333Z",
    "commodityCode" : "elasticsearch_logstash_post",
    "extendConfigs" : [ ],
    "endTime" : 4746268800000,
    "clusterTasks" : [ ],
    "resourceGroupId" : "rg-acfm2h5vbzd****",
    "zoneCount" : 1,
    "protocol" : "HTTP",
    "zoneInfos" : [ {
      "zoneId" : "cn-hangzhou-i",
      "status" : "NORMAL"
    } ],
    "instanceType" : "logstash",
    "inited" : true,
    "tags" : [ ],
    "config" : { },
    "endpointList" : [ {
      "host" : "172.16.**.**",
      "port" : 9600,
      "zoneId" : "cn-hangzhou-i"
    } ]
  } ],
  "RequestId" : "918C05D8-4689-4A79-B6D5-D2500991****",
  "Headers" : {
    "X-Total-Count" : 1
  }
}

    エラーコード

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