ListInstance - List Elasticsearch instances - - Alibaba Cloud Dokümantasyon Merkezi

Hata Ayıklama

OpenAPI Explorer imza değerini otomatik olarak hesaplar. Bu işlemi OpenAPI Explorer üzerinden çağırmanızı öneririz.

İstek üstbilgileri

Bu işlem yalnızca Ortak parametreler konusunda açıklanan ortak istek üstbilgilerini kullanır.

Söz dizimi

GET /openapi/instances HTTP/1.1

İstek parametreleri

Parameter	Type	Position	Required	Example	Description
page	Integer	Query	No.	1	Sayfa numarası. 1 değerinden başlar. Varsayılan: 1.
size	Integer	Query	No.	10	Sayfa başına kayıt sayısı. Maksimum: 100. Varsayılan: 10.
description	String	Query	No.	aliyunes_test1	Örnek adı. Bulanık eşleştirmeyi destekler. Örneğin, abc araması yapıldığında abc, abcde, xyabc ve xabcy adlı örnekler döndürülür.
instanceId	String	Query	No.	es-cn-v641a0ta3000g****	Örnek kimliği (ID).
esVersion	String	Query	No.	6.7_with_X-Pack	Örneğin sürümü.
resourceGroupId	String	Query	No.	rg-aekzvowej3i****	Kaynak grubu kimliği (ID).
tags	String	Query	No.	[{"tagKey":"key1","tagValue":"value1"}]	Örnek etiketleri.
vpcId	String	Query	No.	vpc-bp16k1dvzxtmagcva****	Örneğin VPC kimliği (ID).
zoneId	String	Query	No.	cn-hangzhou-i	Örneğin alan kimliği (ID).
paymentType	String	Query	No.	postpaid	Örneğin faturalama yöntemi. Geçerli değerler: postpaid: kullandıkça öde prepaid: abonelik
instanceCategory	String	Query	No.	advanced	Elasticsearch kümesinin sürümü. Geçerli değerler: x-pack: Standard Edition advanced/IS: Enhanced Edition community: Basic Edition

Yanıt parametreleri

Parameter	Type	Example	Description
RequestId	String	5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****	İstek kimliği (ID).
Headers	Object		Yanıt üstbilgileri.
X-Total-Count	Integer	10	Sayfa başına döndürülen kayıt sayısı.
Result	Array of Instance		Döndürülen örnekler.
advancedDedicateMaster	Boolean	false	Özel ana düğümlerin dahil olup olmadığını belirtir. Geçerli değerler: true: Dizin, Archive depolama sınıfında saklanan dosyalar içerir. false: Dizin, Archive depolama sınıfında saklanan dosyalar içermez.
nodeAmount	Integer	2	Veri düğümü sayısı.
createdAt	String	2018-07-13T03:58:07.253Z	Örneğin oluşturulma zamanı.
status	String	active	Örneğin durumu. Geçerli değerler: active: Küme normal durumda. activating: Küme etkinleştiriliyor. Inactive: Küme dondurulmuş durumda. invalid: Küme mevcut değil veya erişilemiyor. Bu durumda, domain ve kibanaDomain gibi yanıttaki bazı alanlar eksik olabilir. unknown: Küme mevcut değil veya erişilemiyor. Bu durumda, domain ve kibanaDomain gibi yanıttaki bazı alanlar eksik olabilir.
dedicateMaster	Boolean	false	Özel ana düğümlerin dahil olup olmadığını belirtir (kullanımdan kaldırıldı). Geçerli değerler: true: Dizin, Archive depolama sınıfında saklanan dosyalar içerir. false: Dizin, Archive depolama sınıfında saklanan dosyalar içermez.
serviceVpc	Boolean	true	Bunun bir hizmet VPC'si olup olmadığını belirtir.
paymentType	String	postpaid	Kümenin faturalama yöntemi. Geçerli değerler: prepaid: yıllık ve aylık postpaid: kullandıkça öde
resourceGroupId	String	rg-aekzvowej3i****	Kaynak grubunun kimliği (ID).
postpaidServiceStatus	String	active	Abonelik kümesi için kullandıkça öde hizmetinin durumu. Geçerli değerler: active: Normal closed: kapalı indebt: Gecikmiş ödeme nedeniyle dondurulmuş.
description	String	es-cn-abc	Örnek adı.
esVersion	String	6.7_with_X-Pack	Örneğin sürümü.
isNewDeployment	String	true	Kümenin yeni mimaride dağıtılıp dağıtılmadığını belirtir.
updatedAt	String	2018-07-18T10:10:04.484Z	Örneğin en son güncellenme zamanı.
instanceId	String	es-cn-v641a0ta3000g****	Örnek kimliği (ID).
tags	Array of Tag		Örneğin etiketleri. Her etiket bir anahtar-değer çiftidir.
tagKey	String	env	Etiket anahtarı.
tagValue	String	dev	Etiket değeri.
extendConfigs	Array of Object	[{ "configType": "aliVersion", "aliVersion": "ali1.3.0" }]	Genişletilmiş yapılandırma parametreleri.
clientNodeConfiguration	Object		İstemci düğümü yapılandırmaları.
spec	String	elasticsearch.sn2ne.large	Örnek teknik özellikleri. Ürün teknik özellikleri.
amount	Integer	3	Düğüm sayısı.
disk	Integer	20	Düğüm depolama boyutu. Birim: GB.
diskType	String	cloud_efficiency	Düğüm depolama türü. Yalnızca ultra diskler (cloud_efficiency) desteklenir.
specInfo	String	1C 2G	Düğüm teknik özellik ayrıntıları.
elasticDataNodeConfiguration	Object		Esnek düğüm yapılandırmaları.
spec	String	elasticsearch.sn2ne.large	Örnek teknik özellikleri. Ürün teknik özellikleri.
amount	Integer	3	Düğüm sayısı.
disk	Integer	20	Düğüm depolama boyutu. Birim: GB.
diskEncryption	Boolean	true	Disk şifrelemenin etkin olup olmadığını belirtir. Geçerli değerler: true: Adımı çalıştırın. false: Adımı çalıştırmayın.
diskType	String	cloud_ssd	Depolama türü. Geçerli değerler: cloud_ssd: SSD cloud_essd: ESSD cloud_efficiency: ultra disk
specInfo	String	1C 2G	Düğüm teknik özellik ayrıntıları.
kibanaConfiguration	Object		Kibana düğümü yapılandırmaları.
spec	String	elasticsearch.n4.small	Örnek teknik özellikleri. Ürün teknik özellikleri.
amount	Integer	1	Düğüm sayısı.
disk	Integer	20	Düğüm depolama boyutu. Birim: GB.
diskType	String	cloud_ssd	Depolama türü.
specInfo	String	1C 2G	Düğüm teknik özellik ayrıntıları.
masterConfiguration	Object		Özel ana düğüm yapılandırmaları.
spec	String	elasticsearch.sn2ne.large	Örnek teknik özellikleri. Ürün teknik özellikleri.
amount	Integer	3	Düğüm sayısı.
disk	Integer	20	Düğüm depolama boyutu. Birim: GB.
diskType	String	cloud_ssd	Depolama türü. Yalnızca cloud_ssd desteklenir.
specInfo	String	1C 2G	Düğüm teknik özellik ayrıntıları.
networkConfig	Object		Ağ yapılandırması.
vpcId	String	vpc-abc	VPC kimliği (ID).
vsArea	String	cn-hangzhou-e	Kümenin bulunduğu alan.
type	String	vpc	Ağ türü. Yalnızca VPC desteklenir.
vswitchId	String	vsw-def	vSwitch kimliği (ID).
whiteIpGroupList	Array of whiteIpGroupList		Genel ve özel ağ erişimi için IP izin listeleri.
groupName	String	default	IP izin listesinin adı.
whiteIpType	String	PUBLIC_KIBANA	Ağ türü. Geçerli değerler: PRIVATE_ES (Elasticsearch özel ağı), PUBLIC_ES (Elasticsearch genel ağı), PRIVATE_KIBANA (Kibana özel ağı), PUBLIC_KIBANA (Kibana genel ağı).
ips	Array of String	["0.0.0.0", "127.0.XX.XX"]	IP izin listesi.
nodeSpec	Object		Veri düğümü yapılandırmaları.
spec	String	elasticsearch.n4.small	Örnek teknik özellikleri. Ürün teknik özellikleri.
disk	Integer	50	Düğüm depolama kapasitesi. Birim: GB.
diskEncryption	Boolean	false	Disk şifreleme kullanılıp kullanılmayacağını belirtir. Geçerli değerler: true: Yerel biçim modu kullanılır. false: Yerel biçim modu kullanılmaz.
diskType	String	cloud_ssd	Depolama türü. Geçerli değerler: cloud_ssd: standart SSD cloud_efficiency: ultra disk
performanceLevel	String	PL1	ESSD performans düzeyi (PL). Yalnızca diskType cloud_essd olduğunda döndürülür. Geçerli değerler: PL1, PL2 ve PL3.
specInfo	String	1C 2G	Düğüm teknik özellik ayrıntıları.
vpcInstanceId	String	vpc-bp1uag5jj38c****	VPC kimliği (ID).
kibanaIPWhitelist	Array of String	"0.0.0.0/0"	Kibana genel IP izin listesi.
kibanaPrivateIPWhitelist	Array of String	["192.168.XX.XX"]	Kibana özel IP izin listesi.
publicIpWhitelist	Array of String	[ "0.0.0.0/0" ]	Elasticsearch genel ağ izin listesi.
privateNetworkIpWhiteList	Array of String	["192.168.XX.XX/25"]	Elasticsearch özel ağ izin listesi.
endTime	Long	1715826092044	Önbellek rezerv örneğinin sona erme zamanı.
archType	String	public	Dağıtım mimarisi. exclusive: temel yönetim public: cloud-native yeni kontrol
domain	String	es-cn-nif1q8auz0005****.elasticsearch.aliyuncs.com	Kümenin dahili uç noktası.

Not

Aşağıdaki örnek çoğu yanıt parametresini içerir. Gerçek yanıtlar değişebilir. Belirli parametrelere bağımlılıkları sabit kodlamayın.

Örnekler

İstek örneği

GET /openapi/instances?esVersion=6.7_with_X-Pack&resourceGroupId=rg-aekzvowej3i****&tags=[{"tagKey":"key1","tagValue":"value1"}]&vpcId=vpc-bp16k1dvzxtmagcva****&zoneId=cn-hangzhou-i HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

Yanıt örneği

JSON biçimi

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

{
  "Result" : [ {
    "instanceId" : "es-cn-v641a0ta3000g****",
    "description" : "aliyunes_test1",
    "nodeAmount" : 3,
    "paymentType" : "postpaid",
    "status" : "active",
    "esVersion" : "6.7.0_with_X-Pack",
    "esConfig" : { },
    "esIPWhitelist" : [ ],
    "esIPBlacklist" : [ ],
    "privateNetworkIpWhiteList" : [ ],
    "kibanaIPWhitelist" : [ ],
    "publicIpWhitelist" : [ ],
    "serviceVpc" : true,
    "enablePublic" : false,
    "haveKibana" : true,
    "nodeSpec" : {
      "spec" : "elasticsearch.sn1ne.large",
      "disk" : 20,
      "diskType" : "cloud_ssd",
      "diskEncryption" : true
    },
    "networkConfig" : {
      "vpcId" : "vpc-bp1xk0naij7jx4ph1****",
      "vswitchId" : "vsw-bp1ogpdintii5qvyx****",
      "vsArea" : "cn-hangzhou-g",
      "type" : "vpc"
    },
    "createdAt" : "2019-08-26T08:18:06.652Z",
    "updatedAt" : "2019-08-26T08:19:49.448Z",
    "inited" : true,
    "tags" : [ {
      "tagKey" : "key1",
      "tagValue" : "value1"
    } ],
    "dedicateMaster" : false,
    "advancedDedicateMaster" : true,
    "masterConfiguration" : {
      "spec" : "elasticsearch.ic5.large",
      "amount" : 3,
      "diskType" : "cloud_ssd",
      "disk" : 20
    },
    "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" : 4722508800000,
    "dictList" : [ ],
    "synonymsDicts" : [ ],
    "ikHotDicts" : [ ],
    "aliwsDicts" : [ ],
    "clusterTasks" : [ ],
    "resourceGroupId" : "rg-acfmwriiikz****",
    "zoneCount" : 1,
    "protocol" : "HTTP",
    "haveGrafana" : false,
    "haveCerebro" : false,
    "zoneInfos" : [ {
      "zoneId" : "cn-hangzhou-g",
      "status" : "NORMAL"
    } ],
    "enableKibanaPublicNetwork" : false,
    "advancedSetting" : {
      "gcName" : "CMS"
    }
  }, {
    "instanceId" : "es-cn-v641920bh0006****",
    "description" : "aliyunes_test2",
    "nodeAmount" : 2,
    "paymentType" : "postpaid",
    "status" : "active",
    "esVersion" : "6.7.0_with_X-Pack",
    "archType" : "exclusive",
    "esConfig" : { },
    "esIPWhitelist" : [ ],
    "esIPBlacklist" : [ ],
    "privateNetworkIpWhiteList" : [ ],
    "kibanaIPWhitelist" : [ ],
    "publicIpWhitelist" : [ ],
    "enablePublic" : false,
    "haveKibana" : true,
    "nodeSpec" : {
      "spec" : "elasticsearch.sn2ne.2xlarge",
      "disk" : 20,
      "diskType" : "cloud_ssd",
      "diskEncryption" : false
    },
    "networkConfig" : {
      "vpcId" : "vpc-bp1op7luys63go2x5****",
      "vswitchId" : "vsw-bp1rusvg785q97ucp****",
      "vsArea" : "cn-hangzhou-i",
      "type" : "vpc"
    },
    "createdAt" : "2019-08-07T13:14:07.974Z",
    "updatedAt" : "2019-08-12T03:04:27.215Z",
    "inited" : true,
    "tags" : [ ],
    "dedicateMaster" : false,
    "advancedDedicateMaster" : false,
    "masterConfiguration" : { },
    "haveClientNode" : false,
    "warmNode" : false,
    "warmNodeConfiguration" : { },
    "clientNodeConfiguration" : { },
    "kibanaConfiguration" : {
      "spec" : "elasticsearch.n4.small",
      "amount" : 1,
      "disk" : 0
    },
    "commodityCode" : "elasticsearch",
    "endTime" : 4720867200000,
    "dictList" : [ ],
    "synonymsDicts" : [ ],
    "ikHotDicts" : [ ],
    "aliwsDicts" : [ ],
    "clusterTasks" : [ ],
    "resourceGroupId" : "rg-acfmwriiikz****",
    "zoneCount" : 1,
    "protocol" : "HTTP",
    "haveGrafana" : false,
    "haveCerebro" : false,
    "zoneInfos" : [ {
      "zoneId" : "cn-hangzhou-i",
      "status" : "NORMAL"
    } ],
    "enableKibanaPublicNetwork" : false,
    "advancedSetting" : {
      "gcName" : "CMS"
    }
  } ]
}

Hata kodları

Hizmet hata kodları.