Tüm Ürünler
Search

Bu Ürün

    :DescribeInstance

    Belge Merkezi

    :DescribeInstance

    Son Güncelleme:Oct 04, 2026

    Belirtilen Elasticsearch kümesinin ayrıntılı bilgilerini sorgular.

    Hata ayıklama

    OpenAPI Explorer, imza değerini otomatik olarak hesaplar. Kolaylık sağlaması açısından bu işlemi OpenAPI Explorer'da çağırmanızı öneririz. OpenAPI Explorer, farklı SDK'ler için işlemin örnek kodunu dinamik olarak oluşturur.

    İstek üst bilgileri

    Bu işlemde işleme özel istek üst bilgileri bulunmaz; yalnızca ortak istek üst bilgileri kullanılır. Daha fazla bilgi için "Ortak parametreler" konusunun "Ortak istek üst bilgileri" bölümüne bakın.

    Söz dizimi

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

    İstek parametreleri


    Parametre


    Tür


    Konum


    Gerekli


    Örnek


    Açıklama
    InstanceId String Path Evet es-cn-3h4k3axh33th9****


    N numaralı örneğin kimliği.

    Yanıt parametreleri

    Parametre

    Tür

    Örnek

    Açıklama
    RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

    İstek kimliği.

    Result Object

    Yanıt parametreleri.

    advancedDedicateMaster Boolean true

    Kümede özel ana düğümlerin bulunup bulunmadığını gösterir. Geçerli değerler:

    • true: Kümede istemci düğümleri bulunur.
    • false: Kümede istemci düğümleri bulunmaz.
    protocol String HTTP

    İletişim protokolü. Geçerli değerler: HTTP ve HTTPS.

    enableKibanaPublicNetwork Boolean true

    İnternet üzerinden Kibana erişiminin etkinleştirilip etkinleştirilmediğini gösterir. Geçerli değerler:

    • true: etkin
    • false
    nodeAmount Integer 2

    Veri düğümü sayısı.

    createdAt String 2018-07-13T03:58:07.253Z

    Örneğin oluşturulma zamanı.

    enableKibanaPrivateNetwork Boolean false

    Bir iç ağ üzerinden Kibana erişiminin etkinleştirilip etkinleştirilmediğini gösterir. Geçerli değerler:

    • true: etkin
    • false
    vpcInstanceId String vpc-bp1uag5jj38c****

    VPC kimliği.

    port Integer 9200

    Kümeye erişmek için kullanılan bağlantı noktası numarası.

    enablePublic Boolean true

    İnternet üzerinden kümeye erişimin etkinleştirilip etkinleştirilmediğini gösterir. Geçerli değerler:

    • true: etkin
    • false
    dedicateMaster Boolean false

    Kümede özel ana düğümlerin bulunup bulunmadığını gösterir. Bu parametre kullanım dışıdır.

    kibanaPort Integer 5601

    Kibana'ya erişmek için kullanılan bağlantı noktası numarası.

    esConfig Map

    Kümenin YML dosyası yapılandırması.

    resourceGroupId String rg-aekzvowej3i****

    ALB örneğinin ait olduğu kaynak grubunun kimliği.

    paymentType String postpaid

    Kümenin faturalama yöntemi. Geçerli değerler:

    • prepaid: abonelik
    • postpaid: kullandıkça öde
    postpaidServiceStatus String active

    Abonelik kümesi için kullandıkça öde hizmetinin durumu. Geçerli değerler:

    • active: normal
    • closed: kapalı
    • indebt: geciken ödeme nedeniyle donduruluyor
    esVersion String 6.3.2_with_X-Pack

    Örneğin sürümü.

    haveKibana Boolean true

    Kümede Kibana düğümlerinin bulunup bulunmadığını gösterir. Geçerli değerler:

    • true: Kümede istemci düğümleri bulunur.
    • false: Kümede istemci düğümleri bulunmaz.
    isNewDeployment Boolean true

    Kümenin yeni mimaride dağıtılıp dağıtılmadığını gösterir.

    warmNode Boolean true

    Küme için sıcak düğümlerin etkinleştirilip etkinleştirilmediğini gösterir. Geçerli değerler:

    • true: etkin
    • false
    updatedAt String 2018-07-13T03:58:07.253Z

    Örneğin en son güncellendiği zaman.

    instanceId String es-cn-3h4k3axh33th9****

    Örnek kimliği.

    zoneCount Integer 2

    Alan sayısı.

    publicDomain String es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com

    Kümenin genel uç noktası.

    status String active

    Örneğin durumu. Geçerli değerler:

    • active: Küme normal durumdadır.
    • activating: Küme başlatılıyor.
    • inactive: Küme donduruldu.
    • invalid: Küme mevcut değil veya erişilemiyor. Bu durumda yanıtta alan eksik olabilir; örneğin domain ve kibanaDomain alanları.
    • unknown: Küme mevcut değil veya erişilemiyor. Bu durumda yanıtta alan eksik olabilir; örneğin domain ve kibanaDomain alanları.
    serviceVpc Boolean true

    VPC'nin Elasticsearch hizmet hesabı içinde olup olmadığını gösterir.

    publicPort Integer 9200

    İnternet üzerinden kümeye erişmek için kullanılan bağlantı noktası numarası.

    haveClientNode Boolean true

    Kümede istemci düğümlerinin bulunup bulunmadığını gösterir. Geçerli değerler:

    • true: Kümede istemci düğümleri bulunur.
    • false: Kümede istemci düğümleri bulunmaz.
    domain String es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com

    Kümenin iç uç noktası.

    description String es-cn-abc

    Örnek adı.

    kibanaDomain String es-cn-3h4k3axh33th9****.kibana.elasticsearch.aliyuncs.com

    Kibana uç noktası.

    dictList Array of DictList

    IK sözlüklerinin yapılandırmaları.

    fileSize Long 2782602

    Sözlük dosyasının boyutu. Birim: bayt.

    sourceType String ORIGIN

    Sözlük dosyasının kaynak türü. Geçerli değerler:

    • OSS: OSS. İlgili OSS paketinin ACL'sinin genel okuma olduğundan emin olmalısınız.
    • ORIGIN: açık kaynaklı Elasticsearch.
    • UPLOAD: yüklenen dosya.
    name String SYSTEM_MAIN.dic

    Sözlük dosyasının adı.

    type String MAIN

    Sözlük türü. Geçerli değerler:

    • STOP: durdurma sözcüğü listesi
    • MAIN: ana sözlük
    • SYNONYMS: eş anlamlı sözlük
    • ALI_WS: Alibaba Cloud sözlüğü
    synonymsDicts Array of SynonymsDicts

    Eş anlamlı sözlüklerin yapılandırmaları.

    fileSize Long 2782602

    Sözlük dosyasının boyutu. Birim: bayt.

    sourceType String ORIGIN

    Kaynak türü.

    name String SYSTEM_MAIN.dic

    Sözlük dosyasının adı.

    type String STOP

    Sözlük türü. Geçerli değerler:

    • STOP: durdurma sözcüğü listesi
    • MAIN: ana sözlük
    • SYNONYMS: eş anlamlı sözlük
    • ALI_WS: Alibaba Cloud sözlüğü
    zoneInfos Array of ZoneInfo

    Alan bilgisi.

    status String NORMAL

    Alan durumu. Geçerli değerler:

    • ISOLATION: devre dışı
    • NORMAL: normal
    zoneId String cn-hangzhou-b

    Alan kimliği.

    aliwsDicts Array of Dict

    Alibaba Cloud IK sözlüklerinin yapılandırmaları.

    fileSize Long 2782602

    Sözlük dosyasının boyutu. Birim: bayt.

    sourceType String OSS

    Sözlük dosyasının kaynak türü. Geçerli değerler:

    • OSS: OSS. İlgili OSS paketinin ACL'sinin genel okuma olduğundan emin olmalısınız.
    • ORIGIN: açık kaynaklı Elasticsearch.
    • UPLOAD: yüklenen dosya.
    name String aliws_ext_dict.txt

    Sözlük dosyasının adı.

    type String ALI_WS

    Sözlük türü. Geçerli değerler:

    • STOP: durdurma sözcüğü listesi
    • MAIN: ana sözlük
    • SYNONYMS: eş anlamlı sözlük
    • ALI_WS: Alibaba Cloud sözlüğü
    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.

    esIPWhitelist Array of String [ "0.0.0.0/0" ]

    Özel IP adresi izin listesi. Bu parametre kullanım dışıdır.

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

    Örneğin genişletilmiş yapılandırmaları.

    privateNetworkIpWhiteList Array of String 0.0.0.0/0

    Örneğin IP adresi izin listesi.

    publicIpWhitelist Array of String [ "0.0.0.0/0" ]

    Örneğin genel uç nokta erişim izin listesi.

    kibanaPrivateIPWhitelist Array of String ["192.168.XX.XX"]

    Kibana izin listesindeki özel IP adreslerinin listesi.

    esIPBlacklist Array of String [ "0.0.0.0/0" ]

    Özel ağ erişim engelleme listesi (kullanım dışı).

    kibanaIPWhitelist Array of String [ "0.0.0.0/0" ]

    Kibana genel uç nokta erişim izin listesi.

    nodeSpec Object

    Veri düğümlerinin yapılandırmaları.

    spec String elasticsearch.n4.small

    Teknik özellikler kategorisi. Daha fazla bilgi için bkz. Ürün teknik özellikleri.

    disk Integer 0

    Depolama kapasitesi. Birim: GB.

    diskEncryption Boolean true

    Disk şifrelemenin etkinleştirilip etkinleştirilmediğini gösterir. Geçerli değerler:

    • true
    • false
    diskType String cloud_ssd

    Düğümün disk kategorisi. Geçerli değerler:

    • cloud_ssd: standart SSD
    • cloud_efficiency: ultra disk
    performanceLevel String PL1

    ESSD'nin performans düzeyi (PL). diskType değeri cloud_essd ise bu parametre döndürülür. Geçerli değerler: PL1, PL2 ve PL3.

    specInfo String 1C 2G

    Düğüm teknik özellikleri açıklaması
    networkConfig Object

    Ağ türü.

    vpcId String vpc-abc

    Sanal özel bulut (VPC) kimliği.

    vsArea String cn-hangzhou-b

    Kümenin bulunduğu alan.

    type String vpc

    Ağ türü. Yalnızca VPC desteklenir.

    vswitchId String vsw-abc

    vSwitch kimliği.

    whiteIpGroupList Array of whiteIpGroupList

    İzin listelerinin listesi.

    whiteIpType String PRIVATE_ES

    İzin listesi türü. Geçerli değerler:

    • PRIVATE_ES: Elasticsearch için özel IP adresi izin listesi
    • PUBLIC_ES: Elasticsearch için genel IP adresi izin listesi
    • PRIVATE_KIBANA: Kibana için özel IP adresi izin listesi
    • PUBLIC_KIBANA: Kibana için genel IP adresi izin listesi
    groupName String default

    İzin listesi grubunun adı. Varsayılan olarak varsayılan izin listesi dahildir.

    ips Array of String ["0.0.0.0", "127.0.XX.XX"]

    IP adresi izin listesindeki IP adresleri.

    kibanaConfiguration Object

    Kibana düğümlerinin yapılandırmaları.

    amount Integer 1

    Düğüm sayısı.

    spec String elasticsearch.n4.small

    Teknik özellikler kategorisi. Daha fazla bilgi için bkz. Ürün teknik özellikleri.

    disk Integer 20

    Her düğümün depolama kapasitesi. Birim: GB.

    specInfo String 1C 2G

    Düğüm teknik özellikleri açıklaması
    masterConfiguration Object

    Özel ana düğümlerin yapılandırmaları.

    spec String elasticsearch.n4.small

    Teknik özellikler kategorisi. Daha fazla bilgi için bkz. Ürün teknik özellikleri.

    amount Integer 3

    Düğüm sayısı.

    disk Integer 40

    Depolama kapasitesi. Birim: GB.

    diskType String cloud_ssd

    Depolama türü. Yalnızca cloud_ssd desteklenir.

    specInfo String 1C 2G

    Düğüm teknik özellikleri açıklaması
    clientNodeConfiguration Object

    İstemci düğümlerinin yapılandırmaları.

    spec String elasticsearch.n4.small

    Teknik özellikler kategorisi. Daha fazla bilgi için bkz. Ürün teknik özellikleri.

    amount Integer 3

    Düğüm sayısı.

    disk Integer 40

    Depolama kapasitesi. Birim: GB.

    diskType String cloud_efficiency

    Depolama türü. Yalnızca cloud_efficiency desteklenir.

    specInfo String 1C 2G

    Düğüm teknik özellikleri açıklaması
    warmNodeConfiguration Object

    Sıcak düğümlerin yapılandırmaları.

    amount Integer 6

    Düğüm sayısı.

    spec String elasticsearch.n4.small

    Teknik özellikler kategorisi. Daha fazla bilgi için bkz. Ürün teknik özellikleri.

    disk Integer 500

    Depolama kapasitesi. Birim: GB.

    diskEncryption Boolean true

    Disk şifrelemenin etkinleştirilip etkinleştirilmeyeceğini belirtir. Geçerli değerler:

    • true: etkin
    • false
    diskType String cloud_efficiency

    Depolama türü. Yalnızca cloud_efficiency desteklenir.

    specInfo String 1C 2G

    Düğüm teknik özellikleri açıklaması
    advancedSetting Object

    Gelişmiş yapılandırmalar.

    gcName String CMS

    Çöp toplayıcının (GC) adı. Geçerli değerler: CMS ve G1.

    elasticDataNodeConfiguration Object

    Esnek düğümlerin yapılandırmaları.

    amount Integer 3

    Düğüm sayısı.

    spec String elasticsearch.sn2ne.large

    Teknik özellikler kategorisi. Daha fazla bilgi için bkz. Ürün teknik özellikleri.

    disk Integer 20

    Depolama kapasitesi. Birim: GB.

    diskEncryption Boolean true

    Disk şifrelemenin etkinleştirilip etkinleştirilmediğini gösterir. Geçerli değerler:

    • true
    • false
    diskType String cloud_ssd

    Depolama türü. Geçerli değerler:

    • cloud_ssd: standart SSD
    • cloud_essd: Gelişmiş SSD (ESSD)
    • cloud_efficiency: ultra disk.
    specInfo String 1C 2G

    Düğüm teknik özelliklerinin açıklaması.

    ikHotDicts Array of ikHotDicts

    IK sözlükleri için yuvarlanan güncelleştirmelerin yapılandırmaları.

    type String MAIN

    Güncellemek istediğiniz sözlük türü. Geçerli değerler:

    • MAIN: IK ana sözlüğü
    • STOP: IK durdurma sözcüğü listesi
    sourceType String OSS

    Sözlük dosyasının kaynak türü. Geçerli değerler:

    • OSS
    • ORIGIN
    fileSize Integer 6

    Sözlük dosyasının boyutu. Birim: bayt.

    name String deploy_0.dic

    Sözlük dosyasının adı.

    instanceCategory String advanced

    Elasticsearch kümesinin sürümü. Döndürülen değerler aşağıdaki gibidir:

    • x-pack: Standart Sürüm
    • advanced/IS: Gelişmiş Sürüm
    • community: Temel Sürüm
    endtime Long 1715826092044

    Önbellek rezervasyon örneğinin süresinin dolduğu zaman.

    archType String public

    Dağıtım modu, mimari türü:

    exclusive: temel yönetim

    public: cloud-native yeni kontrol
    kibanaPrivateDomain String es-cn-x0r3*********.elasticsearch.aliyuncs.com

    Kibana özel uç noktası
    kibanaPrivatePort String 5601

    Kibana özel bağlantı noktası
    Not

    Aşağıdaki dönüş örneğinde bu konu, döndürülen veri listesindeki parametrelerin dahil edilmesini garanti eder; bahsedilmeyen parametreler yalnızca referans amaçlıdır. Program bu parametreleri almak için zorunlu olarak bunlara güvenemez.

    Örnekler

    Örnek istekler

    GET /openapi/instances/es-cn-3h4k3axh33th9**** HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

    Örnek başarılı yanıtlar

    JSON biçimi

    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"
}

    Hata kodları

    Hata kodlarının listesi için bkz. Hizmet hata kodları.