DescribeInstance
調(diào)用DescribeInstance,查詢(xún)指定實(shí)例的詳細(xì)信息。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
請(qǐng)求頭
該接口使用公共請(qǐng)求頭,無(wú)特殊請(qǐng)求頭。請(qǐng)參見(jiàn)公共請(qǐng)求參數(shù)文檔。
請(qǐng)求語(yǔ)法
GET /openapi/instances/{InstanceId} HTTP/1.1
請(qǐng)求參數(shù)
名稱(chēng) |
類(lèi)型 |
位置 |
是否必選 |
示例值 |
描述 |
InstanceId | String | Path | 是 | es-cn-3h4k3axh33th9**** | 實(shí)例ID。 |
返回?cái)?shù)據(jù)
名稱(chēng) |
類(lèi)型 |
示例值 |
描述 |
RequestId | String | 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1**** | 請(qǐng)求ID。 |
Result | Object | 返回結(jié)果。 |
|
advancedDedicateMaster | Boolean | true | 是否包含專(zhuān)有主節(jié)點(diǎn)。取值含義如下:
|
protocol | String | HTTP | 訪問(wèn)協(xié)議。支持:HTTP和HTTPS。 |
enableKibanaPublicNetwork | Boolean | true | 是否開(kāi)啟Kibana公網(wǎng)訪問(wèn)。取值含義如下:
|
nodeAmount | Integer | 2 | 實(shí)例的數(shù)據(jù)節(jié)點(diǎn)數(shù)量。 |
createdAt | String | 2018-07-13T03:58:07.253Z | 實(shí)例創(chuàng)建時(shí)間。 |
enableKibanaPrivateNetwork | Boolean | false | 是否開(kāi)啟Kibana私網(wǎng)訪問(wèn)。取值含義如下:
|
vpcInstanceId | String | vpc-bp1uag5jj38c**** | 專(zhuān)有網(wǎng)絡(luò)ID。 |
port | Integer | 9200 | 實(shí)例的訪問(wèn)端口。 |
enablePublic | Boolean | true | 是否開(kāi)啟實(shí)例的公網(wǎng)地址。取值含義如下:
|
dedicateMaster | Boolean | false | 專(zhuān)有主節(jié)點(diǎn)(已廢棄)。 |
kibanaPort | Integer | 5601 | Kibana的訪問(wèn)端口。 |
esConfig | Map | 實(shí)例的YML文件配置信息。 |
|
resourceGroupId | String | rg-aekzvowej3i**** | 實(shí)例所屬的資源組ID。 |
paymentType | String | postpaid | 實(shí)例的付費(fèi)方式。支持:
|
postpaidServiceStatus | String | active | 預(yù)付費(fèi)實(shí)例疊加的后付費(fèi)服務(wù)狀態(tài)。取值含義如下:
|
esVersion | String | 6.3.2_with_X-Pack | 實(shí)例版本。 |
haveKibana | Boolean | true | 是否包含Kibana節(jié)點(diǎn)。取值含義如下:
|
isNewDeployment | Boolean | true | 是否為新部署架構(gòu)。 |
warmNode | Boolean | true | 是否開(kāi)啟冷數(shù)據(jù)節(jié)點(diǎn)。取值含義如下:
|
updatedAt | String | 2018-07-13T03:58:07.253Z | 實(shí)例最后更新時(shí)間。 |
instanceId | String | es-cn-3h4k3axh33th9**** | 實(shí)例ID。 |
zoneCount | Integer | 2 | 實(shí)例的可用區(qū)個(gè)數(shù)。 |
publicDomain | String | es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com | 實(shí)例的公網(wǎng)地址。 |
status | String | active | 實(shí)例的狀態(tài),取值含義如下:
|
serviceVpc | Boolean | true | 是否為服務(wù)vpc。 |
publicPort | Integer | 9200 | 實(shí)例的公網(wǎng)訪問(wèn)端口。 |
haveClientNode | Boolean | true | 是否包含協(xié)調(diào)節(jié)點(diǎn)。取值含義如下:
|
domain | String | es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com | 實(shí)例的內(nèi)網(wǎng)地址。 |
description | String | es-cn-abc | 實(shí)例名稱(chēng)。 |
kibanaDomain | String | es-cn-3h4k3axh33th9****.kibana.elasticsearch.aliyuncs.com | Kibana地址。 |
dictList | Array of DictList | IK詞典配置。 |
|
fileSize | Long | 2782602 | 詞典文件大小,單位:Byte。 |
sourceType | String | ORIGIN | 詞典文件來(lái)源類(lèi)型,取值含義如下:
|
name | String | SYSTEM_MAIN.dic | 詞典文件名稱(chēng)。 |
type | String | MAIN | 詞典文件類(lèi)型,取值含義如下:
|
synonymsDicts | Array of SynonymsDicts | 同義詞詞典配置。 |
|
fileSize | Long | 2782602 | 詞典文件大小,單位:字節(jié)。 |
sourceType | String | ORIGIN | 來(lái)源類(lèi)型。 |
name | String | SYSTEM_MAIN.dic | 詞典文件名稱(chēng)。 |
type | String | STOP | 詞典類(lèi)型。取值含義如下:
|
zoneInfos | Array of ZoneInfo | 可用區(qū)信息。 |
|
status | String | NORMAL | 可用區(qū)狀態(tài)。支持:
|
zoneId | String | cn-hangzhou-b | 可用區(qū)ID。 |
aliwsDicts | Array of Dict | 阿里分詞詞典配置。 |
|
fileSize | Long | 2782602 | 詞典文件大小,單位:字節(jié)。 |
sourceType | String | OSS | 詞典文件來(lái)源類(lèi)型,取值含義如下:
|
name | String | aliws_ext_dict.txt | 詞典文件名稱(chēng)。 |
type | String | ALI_WS | 詞典文件類(lèi)型,取值含義如下:
|
tags | Array of Tag | 實(shí)例標(biāo)簽。 |
|
tagKey | String | env | 標(biāo)簽鍵。 |
tagValue | String | dev | 標(biāo)簽值。 |
esIPWhitelist | Array of String | [ "0.0.0.0/0" ] | 私網(wǎng)訪問(wèn)白名單(已廢棄)。 |
extendConfigs | Array of Object | [{ "configType": "aliVersion","aliVersion": "ali1.3.0" }] | 實(shí)例的擴(kuò)展配置。 |
privateNetworkIpWhiteList | Array of String | 0.0.0.0/0 | 實(shí)例的私網(wǎng)地址訪問(wèn)白名單列表。 |
publicIpWhitelist | Array of String | [ "0.0.0.0/0" ] | 實(shí)例的公網(wǎng)地址訪問(wèn)白名單。 |
kibanaPrivateIPWhitelist | Array of String | ["192.168.XX.XX"] | Kibana私網(wǎng)地址訪問(wèn)白名單列表。 |
esIPBlacklist | Array of String | [ "0.0.0.0/0" ] | 私網(wǎng)訪問(wèn)黑名單(已廢棄)。 |
kibanaIPWhitelist | Array of String | [ "0.0.0.0/0" ] | Kibana公網(wǎng)地址訪問(wèn)白名單列表。 |
nodeSpec | Object | 數(shù)據(jù)節(jié)點(diǎn)配置信息。 |
|
spec | String | elasticsearch.n4.small | 節(jié)點(diǎn)規(guī)格。規(guī)格信息可通過(guò)產(chǎn)品規(guī)格查看。 |
disk | Integer | 0 | 節(jié)點(diǎn)存儲(chǔ)空間大小,單位:GB。 |
diskEncryption | Boolean | true | 是否開(kāi)啟云盤(pán)加密:
|
diskType | String | cloud_ssd | 節(jié)點(diǎn)磁盤(pán)類(lèi)型。支持:
|
performanceLevel | String | PL1 | ESSD云盤(pán)的性能級(jí)別。當(dāng)diskType為cloud_essd時(shí),該參數(shù)必選,支持PL1、PL2、PL3。 |
specInfo | String | 1C 2G | 節(jié)點(diǎn)規(guī)格描述 |
networkConfig | Object | 網(wǎng)絡(luò)配置。 |
|
vpcId | String | vpc-abc | VPC網(wǎng)絡(luò)ID。 |
vsArea | String | cn-hangzhou-b | 實(shí)例所在的可用區(qū)。 |
type | String | vpc | 網(wǎng)絡(luò)類(lèi)型,只支持專(zhuān)有網(wǎng)絡(luò)VPC(Virtual Private Cloud)。 |
vswitchId | String | vsw-abc | 虛擬交換機(jī)ID。 |
whiteIpGroupList | Array of whiteIpGroupList | 白名單組列表。 |
|
whiteIpType | String | PRIVATE_ES | 白名單類(lèi)型。取值含義如下:
|
groupName | String | default | 白名單組的組名。默認(rèn)包含default分組。 |
ips | Array of String | ["0.0.0.0", "127.0.XX.XX"] | 白名單組中的IP列表。 |
kibanaConfiguration | Object | Kibana節(jié)點(diǎn)的配置信息。 |
|
amount | Integer | 1 | 節(jié)點(diǎn)數(shù)量。 |
spec | String | elasticsearch.n4.small | 節(jié)點(diǎn)規(guī)格。規(guī)格信息可通過(guò)產(chǎn)品規(guī)格查看。 |
disk | Integer | 20 | 單節(jié)點(diǎn)存儲(chǔ)空間大小。,單位:GB。 |
specInfo | String | 1C 2G | 節(jié)點(diǎn)規(guī)格描述 |
masterConfiguration | Object | Master節(jié)點(diǎn)配置。 |
|
spec | String | elasticsearch.n4.small | 節(jié)點(diǎn)規(guī)格。規(guī)格信息可通過(guò)產(chǎn)品規(guī)格查看。 |
amount | Integer | 3 | 節(jié)點(diǎn)數(shù)量。 |
disk | Integer | 40 | 節(jié)點(diǎn)存儲(chǔ)空間大小,單位:GB。 |
diskType | String | cloud_ssd | 節(jié)點(diǎn)存儲(chǔ)類(lèi)型。只支持cloud_ssd(SSD云盤(pán))。 |
specInfo | String | 1C 2G | 節(jié)點(diǎn)規(guī)格描述 |
clientNodeConfiguration | Object | 協(xié)調(diào)節(jié)點(diǎn)配置信息。 |
|
spec | String | elasticsearch.n4.small | 節(jié)點(diǎn)規(guī)格。規(guī)格信息可通過(guò)產(chǎn)品規(guī)格查看。 |
amount | Integer | 3 | 節(jié)點(diǎn)數(shù)量。 |
disk | Integer | 40 | 節(jié)點(diǎn)存儲(chǔ)空間大小,單位:GB。 |
diskType | String | cloud_efficiency | 節(jié)點(diǎn)存儲(chǔ)類(lèi)型,只支持高效云盤(pán)(cloud_efficiency)。 |
specInfo | String | 1C 2G | 節(jié)點(diǎn)規(guī)格描述 |
warmNodeConfiguration | Object | 冷數(shù)據(jù)節(jié)點(diǎn)配置信息。 |
|
amount | Integer | 6 | 節(jié)點(diǎn)數(shù)量。 |
spec | String | elasticsearch.n4.small | 節(jié)點(diǎn)規(guī)格。規(guī)格信息可通過(guò)產(chǎn)品規(guī)格查看。 |
disk | Integer | 500 | 節(jié)點(diǎn)存儲(chǔ)空間大小,單位:GB。 |
diskEncryption | Boolean | true | 是否開(kāi)啟云盤(pán)加密。取值含義如下:
|
diskType | String | cloud_efficiency | 節(jié)點(diǎn)存儲(chǔ)空間類(lèi)型。只支持cloud_efficiency(高效云盤(pán))。 |
specInfo | String | 1C 2G | 節(jié)點(diǎn)規(guī)格描述 |
advancedSetting | Object | 高級(jí)配置。 |
|
gcName | String | CMS | GC垃圾回收器名稱(chēng)。支持CMS、G1。 |
elasticDataNodeConfiguration | Object | 彈性數(shù)據(jù)節(jié)點(diǎn)配置。 |
|
amount | Integer | 3 | 節(jié)點(diǎn)數(shù)量。 |
spec | String | elasticsearch.sn2ne.large | 節(jié)點(diǎn)規(guī)格。規(guī)格信息可通過(guò)產(chǎn)品規(guī)格查看。 |
disk | Integer | 20 | 節(jié)點(diǎn)存儲(chǔ)空間大小,單位:GB。 |
diskEncryption | Boolean | true | 是否為節(jié)點(diǎn)開(kāi)啟云盤(pán)加密,取值含義如下:
|
diskType | String | cloud_ssd | 節(jié)點(diǎn)存儲(chǔ)類(lèi)型。支持:
|
specInfo | String | 1C 2G | 節(jié)點(diǎn)規(guī)格描述。 |
ikHotDicts | Array of ikHotDicts | IK詞典熱更新配置。 |
|
type | String | MAIN | 要更新的詞典類(lèi)型。支持:
|
sourceType | String | OSS | 詞典文件來(lái)源類(lèi)型,支持:
|
fileSize | Integer | 6 | 詞典文件大小,單位:Byte。 |
name | String | deploy_0.dic | 詞典文件名。 |
instanceCategory | String | advanced | 實(shí)例版本類(lèi)型。返回值含義如下:
|
endtime | Long | 1715826092044 | 實(shí)例到期時(shí)間。 |
archType | String | public | 部署模式,架構(gòu)類(lèi)型: exclusive:基礎(chǔ)管控 public:云原生新管控 |
示例
請(qǐng)求示例
GET /openapi/instances/es-cn-3h4k3axh33th9**** HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json
正常返回示例
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Result" : {
"instanceId" : "es-cn-3h4k3axh33th9****",
"domain" : "es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com",
"description" : "es-cn-3h4k3axh33th9****",
"nodeAmount" : 2,
"paymentType" : "postpaid",
"status" : "active",
"port" : 9200,
"esVersion" : "6.3.2_with_X-Pack",
"archType" : "exclusive",
"instanceCategory" : "x-pack",
"esConfig" : {
"action.destructive_requires_name" : "true",
"xpack.security.audit.outputs" : "index",
"xpack.watcher.enabled" : "false",
"xpack.security.audit.enabled" : "false",
"action.auto_create_index" : "+.*,-*"
},
"esIPWhitelist" : [ "0.0.0.0/0" ],
"esIPBlacklist" : [ ],
"privateNetworkIpWhiteList" : [ "0.0.0.0/0" ],
"kibanaIPWhitelist" : [ "0.0.0.0/0", "::/0" ],
"publicIpWhitelist" : [ ],
"kibanaDomain" : "es-cn-3h4k3axh33th9****.kibana.elasticsearch.aliyuncs.com",
"kibanaPort" : 5601,
"enablePublic" : false,
"haveKibana" : true,
"nodeSpec" : {
"spec" : "elasticsearch.sn1ne.large",
"disk" : 21,
"diskType" : "cloud_ssd"
},
"serviceVpc" : true,
"networkConfig" : {
"vpcId" : "vpc-bp13n1j3fcv1cqfkg****",
"vswitchId" : "vsw-bp12q2vrqvko0ilg8****",
"vsArea" : "cn-hangzhou-h",
"type" : "vpc",
"whiteIpGroupList" : [ {
"groupName" : "default",
"whiteIpType" : "PRIVATE_ES",
"ips" : [ "0.0.0.0", "127.0.XX.XX" ]
} ]
},
"createdAt" : "2019-08-28T07:48:59.736Z",
"updatedAt" : "2019-08-28T08:11:33.229Z",
"inited" : true,
"dedicateMaster" : false,
"advancedDedicateMaster" : false,
"masterConfiguration" : { },
"haveClientNode" : true,
"warmNode" : true,
"warmNodeConfiguration" : {
"spec" : "elasticsearch.ic5.large",
"amount" : 2,
"diskType" : "cloud_efficiency",
"disk" : 500,
"diskEncryption" : true
},
"clientNodeConfiguration" : {
"spec" : "elasticsearch.ic5.large",
"amount" : 2,
"diskType" : "cloud_efficiency",
"disk" : 20
},
"kibanaConfiguration" : {
"spec" : "elasticsearch.n4.small",
"amount" : 1,
"disk" : 0
},
"commodityCode" : "elasticsearch",
"endTime" : 4722681600000,
"dictList" : [ {
"name" : "SYSTEM_MAIN.dic",
"fileSize" : 2782602,
"type" : "MAIN",
"sourceType" : "ORIGIN"
}, {
"name" : "SYSTEM_STOPWORD.dic",
"fileSize" : 132,
"type" : "STOP",
"sourceType" : "ORIGIN"
} ],
"synonymsDicts" : [ ],
"ikHotDicts" : [ ],
"aliwsDicts" : [ ],
"clusterTasks" : [ ],
"vpcInstanceId" : "es-cn-3h4k3axh33th9****-worker",
"resourceGroupId" : "rg-acfm3ghp32r****",
"zoneCount" : 1,
"protocol" : "HTTP",
"haveGrafana" : false,
"haveCerebro" : false,
"zoneInfos" : [ {
"zoneId" : "cn-hangzhou-h",
"status" : "NORMAL"
} ],
"enableKibanaPublicNetwork" : true,
"advancedSetting" : {
"gcName" : "CMS"
}
},
"RequestId" : "68104CC2-DA27-446D-8049-A024F0D4EFEC"
}
錯(cuò)誤碼
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。