調用DescribeLogstash,查詢指定實例的詳細信息。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求頭
該接口使用公共請求頭,無特殊請求頭。請參見公共請求參數文檔。
請求語法
GET /openapi/logstashes/{InstanceId} HTTP/1.1
請求參數
名稱 | 類型 | 位置 | 是否必選 | 示例值 | 描述 |
---|---|---|---|---|---|
InstanceId | String | Path | 是 | ls-cn-s9dsk3k4k**** |
實例ID。 |
返回數據
名稱 | 類型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | C9334241-4837-46C2-B24B-9BDC517318DE |
請求ID。 |
Result | Object |
當前實例的詳細信息。 |
|
config | Map |
實例配置信息。 |
|
paymentType | String | prepaid |
實例的付費模式。支持:
|
ResourceGroupId | String | rg-aekzvowej3i**** |
實例所屬的資源組ID。 |
nodeAmount | Integer | 2 |
實例的節點個數。 |
description | String | ls-cn-abc |
實例名稱。 |
createdAt | String | 2020-02-06T14:12:03.672Z |
實例創建時間。 |
status | String | active |
實例的狀態。支持四種狀態:
|
vpcInstanceId | String | vpc-bp16k1dvzxtmagcva**** |
實例所屬的VPC ID。 |
updatedAt | String | 2020-02-06T14:22:36.850Z |
實例最后更新的時間。 |
version | String | 7.4.0_with_X-Pack |
實例版本。 |
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 |
實例標簽。 |
|
tagKey | String | env |
標簽鍵。 |
tagValue | String | dev |
標簽值。 |
ZoneInfos | Array of zoneInfos |
可用區信息。 |
|
status | String | 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 |
是否使用云盤加密:
|
diskType | String | cloud_ssd |
節點的磁盤類型。 |
networkConfig | Object |
網絡配置。 |
|
vpcId | String | vpc-bp16k1dvzxtmagcva**** |
專有網絡ID。 |
vsArea | String | cn-hangzhou-* |
實例所在的可用區。 |
type | String | vpc |
網絡類型。目前只支持專有網絡VPC(Virtual Private Cloud)。 |
vswitchId | String | vsw-bp1k4ec6s7sjdbudw**** |
虛擬交換機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"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。