すべてのプロダクト
Search
ドキュメントセンター

Elasticsearch:DescribeLogstash

最終更新日:Mar 17, 2025

指定された Logstash クラスタの詳細情報を照会します。

デバッグ

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

リクエストヘッダー

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

リクエスト構文

GET /openapi/logstashes/{InstanceId} HTTP/1.1

リクエストパラメーター

パラメーター タイプ 位置 必須 説明
InstanceId String Path Yes ls-cn-s9dsk3k4k****

インスタンス ID。

レスポンスパラメーター

パラメーター タイプ 説明
RequestId String C9334241-4837-46C2-B24B-9BDC517318DE

リクエスト ID。

Result Object

インスタンスの詳細情報。

config Map

インスタンスの構成。

paymentType String prepaid

インスタンスの課金方法。有効な値:

  • prepaid:サブスクリプション
  • postpaid:従量課金
ResourceGroupId String rg-aekzvowej3i****

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

nodeAmount Integer 2

データノードの数。

description String ls-cn-abc

インスタンスの名前。

createdAt String 2020-02-06T14:12:03.672Z

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

status String active

インスタンスの状態。 4 つの状態がサポートされています。

  • Normal:アクティブ
  • Active:アクティブ化中
  • Freeze:非アクティブ
  • Invalid:無効
vpcInstanceId String vpc-bp16k1dvzxtmagcva****

Elastic Container インスタンスが属する VPC (Virtual Private Cloud) の ID。

updatedAt String 2020-02-06T14:22:36.850Z

インスタンスが最後に更新された日時。

version String 7.4.0_with_X-Pack

専用 KMS インスタンスのエディション。

instanceId String ls-cn-abc

インスタンスの ID。

endpointList Array of endpoint

ノードのアクセス情報。

zoneId String cn-hangzhou-b

ノードが存在するゾーンの ID。

port String 9600

ポート番号。

host String 172.16.**.**

ノードの IP アドレス。

Tags Array of tags

ALB インスタンスに追加されたタグ。

tagKey String env

タグのキー。

tagValue String dev

タグの値。

ZoneInfos Array of zoneInfos

ゾーンに関する情報。

status String NORMAL

ゾーンのステータス。有効な値:

  • ISOLATION:オフライン
  • NORMAL
zoneId String cn-hangzhou-b

新しいインスタンスのゾーン ID。

ExtendConfigs Array of Object [{ "configType": "aliVersion","aliVersion": "ali1.3.0" }]

クラスタ拡張パラメーターの構成。

nodeSpec Object

ノードの構成情報。

spec String elasticsearch.sn1ne.large

ノードの仕様。

disk Integer 20

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

diskEncryption Boolean true

ディスクの暗号化を使用するかどうか:

  • true
  • false
diskType String cloud_ssd

ノードのディスクタイプ。

networkConfig Object

ネットワーク構成。

vpcId String vpc-bp16k1dvzxtmagcva****

VPC (Virtual Private Cloud) の ID。

vsArea String cn-hangzhou-*

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

type String vpc

インスタンスのネットワークタイプ。有効な値:現在、VPC (Virtual Private Cloud) のみがサポートされています。

vswitchId String vsw-bp1k4ec6s7sjdbudw****

インスタンスが接続されている vSwitch の ID。

詳細については、「ListLogstash」をご参照ください。

サンプルリクエスト

GET /openapi/logstashes/ls-cn-s9dsk3k4k**** 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-m7r1o6cl****",
    "version" : "6.7.0_with_X-Pack",
    "description" : "ls-cn-abc",
    "nodeAmount" : 2,
    "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-27T11:53:43.104Z",
    "updatedAt" : "2020-05-27T11:53:43.104Z",
    "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" : {
      "slowlog.threshold.warn" : "2s",
      "slowlog.threshold.info" : "1s",
      "slowlog.threshold.debug" : "500ms",
      "slowlog.threshold.trace" : "100ms"
    },
    "endpointList" : [ {
      "host" : "172.16.**.**",
      "port" : 9600,
      "zoneId" : "cn-hangzhou-i"
    }, {
      "host" : "172.16.**.**",
      "port" : 9600,
      "zoneId" : "cn-hangzhou-i"
    } ]
  },
  "RequestId" : "C9334241-4837-46C2-B24B-9BDC517318DE"
}

エラーコード

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