全部產品
Search

搜尋本產品

    Elasticsearch：DescribeInstance

    文件中心

    Elasticsearch：DescribeInstance

    更新時間：Jan 15, 2025

    調用DescribeInstance，查詢指定執行個體的詳細資料。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    要求標頭

    該介面使用公用要求標頭，無特殊要求標頭。請參見公用請求參數文檔。

    請求文法

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

    請求參數

    名稱

    類型

    位置

    是否必選

    樣本值

    描述
    InstanceId String Path 是 es-cn-3h4k3axh33th9****

    執行個體ID。

    返回資料

    名稱

    類型

    樣本值

    描述
    RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

    請求ID。
    Result Object

    返回結果。
    advancedDedicateMaster Boolean true

    是否包含專有主節點。取值含義如下：

    • true：包含。
    • false：不包含。
    protocol String HTTP

    訪問協議。支援：HTTP和HTTPS。
    enableKibanaPublicNetwork Boolean true

    是否開啟Kibana公網訪問。取值含義如下：

    • true：開啟。
    • false：不開啟。
    nodeAmount Integer 2

    執行個體的資料節點數量。
    createdAt String 2018-07-13T03:58:07.253Z

    執行個體建立時間。
    enableKibanaPrivateNetwork Boolean false

    是否開啟Kibana私網訪問。取值含義如下：

    • true：開啟。
    • false：不開啟。
    vpcInstanceId String vpc-bp1uag5jj38c****

    專用網路ID。
    port Integer 9200

    執行個體的訪問連接埠。
    enablePublic Boolean true

    是否開啟執行個體的公網地址。取值含義如下：

    • true：開啟。
    • false：不開啟。
    dedicateMaster Boolean false

    專有主節點（已廢棄）。
    kibanaPort Integer 5601

    Kibana的訪問連接埠。
    esConfig Map

    執行個體的YML檔案配置資訊。
    resourceGroupId String rg-aekzvowej3i****

    執行個體所屬的資源群組ID。
    paymentType String postpaid

    執行個體的付費方式。支援：

    • prepaid：訂用帳戶。
    • postpaid：隨用隨付。
    postpaidServiceStatus String active

    預付費執行個體疊加的後付費服務狀態。取值含義如下：

    • active：正常。
    • closed：關閉。
    • indebt：欠費凍結中。
    esVersion String 6.3.2_with_X-Pack

    執行個體版本。
    haveKibana Boolean true

    是否包含Kibana節點。取值含義如下：

    • true：包含。
    • false：不包含。
    isNewDeployment Boolean true

    是否為新部署架構。
    warmNode Boolean true

    是否開啟冷資料節點。取值含義如下：

    • true：開啟。
    • false：不開啟。
    updatedAt String 2018-07-13T03:58:07.253Z

    執行個體最後更新時間。
    instanceId String es-cn-3h4k3axh33th9****

    執行個體ID。
    zoneCount Integer 2

    執行個體的可用性區域個數。
    publicDomain String es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com

    執行個體的公網地址。
    status String active

    執行個體的狀態，取值含義如下：

    • active：正常。
    • activating：生效中。
    • inactive：凍結。
    • invalid：失效，叢集不存在或者訪問不通，此類情況介面返回結果部分欄位可能缺失，如domain，kibanaDomain等等。
    • unknown：未知，叢集不存在或者訪問不通，此類情況介面返回結果部分欄位可能缺失，如domain，kibanaDomain等等。
    serviceVpc Boolean true

    是否為服務vpc。
    publicPort Integer 9200

    執行個體的公網訪問連接埠。
    haveClientNode Boolean true

    是否包含協調節點。取值含義如下：

    • true：包含。
    • false：不包含。
    domain String es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com

    執行個體的內網地址。
    description String es-cn-abc

    執行個體名稱。
    kibanaDomain String es-cn-3h4k3axh33th9****.kibana.elasticsearch.aliyuncs.com

    Kibana地址。
    dictList Array of DictList

    IK詞典配置。
    fileSize Long 2782602

    詞典檔案大小，單位：Byte。
    sourceType String ORIGIN

    詞典檔案來源類型，取值含義如下：

    • OSS：OSS開放儲存（需要確保OSS儲存空間為公用可讀）。
    • ORIGIN：開源Elasticsearch。
    • UPLOAD：上傳的檔案。
    name String SYSTEM_MAIN.dic

    詞典檔案名稱。
    type String MAIN

    詞典檔案類型，取值含義如下：

    • STOP：停用詞。
    • MAIN：主詞典。
    • SYNONYMS：同義字詞典。
    • ALI_WS：阿里詞典。
    synonymsDicts Array of SynonymsDicts

    同義字詞典配置。
    fileSize Long 2782602

    詞典檔案大小，單位：位元組。
    sourceType String ORIGIN

    來源類型。
    name String SYSTEM_MAIN.dic

    詞典檔案名稱。
    type String STOP

    詞典類型。取值含義如下：

    • STOP：停用詞。
    • MAIN：主詞典。
    • SYNONYMS：同義字詞典。
    • ALI_WS：阿里詞典。
    zoneInfos Array of ZoneInfo

    可用性區域資訊。
    status String NORMAL

    可用性區域狀態。支援：

    • ISOLATION：下線
    • NORMAL：正常
    zoneId String cn-hangzhou-b

    可用性區域ID。
    aliwsDicts Array of Dict

    阿里分詞詞典配置。
    fileSize Long 2782602

    詞典檔案大小，單位：位元組。
    sourceType String OSS

    詞典檔案來源類型，取值含義如下：

    • OSS：OSS開放儲存（需要確保OSS儲存空間為公用可讀）。
    • ORIGIN：開源Elasticsearch。
    • UPLOAD：上傳的檔案。
    name String aliws_ext_dict.txt

    詞典檔案名稱。
    type String ALI_WS

    詞典檔案類型，取值含義如下：

    • STOP：停用詞。
    • MAIN：主詞典。
    • SYNONYMS：同義字詞典。
    • ALI_WS：阿里詞典。
    tags Array of Tag

    執行個體標籤。
    tagKey String env

    標籤鍵。
    tagValue String dev

    標籤值。
    esIPWhitelist Array of String [ "0.0.0.0/0" ]

    私網訪問白名單（已廢棄）。
    extendConfigs Array of Object [{ "configType": "aliVersion","aliVersion": "ali1.3.0" }]

    執行個體的擴充配置。
    privateNetworkIpWhiteList Array of String 0.0.0.0/0

    執行個體的私網地址訪問白名單列表。
    publicIpWhitelist Array of String [ "0.0.0.0/0" ]

    執行個體的公網地址訪問白名單。
    kibanaPrivateIPWhitelist Array of String ["192.168.XX.XX"]

    Kibana私網地址訪問白名單列表。
    esIPBlacklist Array of String [ "0.0.0.0/0" ]

    私網訪問黑名單（已廢棄）。
    kibanaIPWhitelist Array of String [ "0.0.0.0/0" ]

    Kibana公網地址訪問白名單列表。
    nodeSpec Object

    資料節點配置資訊。
    spec String elasticsearch.n4.small

    節點規格。規格資訊可通過產品規格查看。
    disk Integer 0

    節點儲存空間大小，單位：GB。
    diskEncryption Boolean true

    是否開啟雲端硬碟加密：

    • true：開啟。
    • false：不開啟。
    diskType String cloud_ssd

    節點磁碟類型。支援：

    • cloud_ssd：SSD雲端硬碟
    • cloud_efficiency：高效雲端硬碟
    performanceLevel String PL1

    ESSD雲端硬碟的效能層級。當diskType為cloud_essd時，該參數必選，支援PL1、PL2、PL3。
    specInfo String 1C 2G

    節點規格描述
    networkConfig Object

    網路設定。
    vpcId String vpc-abc

    VPC網路ID。
    vsArea String cn-hangzhou-b

    執行個體所在的可用性區域。
    type String vpc

    網路類型，只支援Virtual Private Cloud（Virtual Private Cloud）。
    vswitchId String vsw-abc

    虛擬交換器ID。
    whiteIpGroupList Array of whiteIpGroupList

    白名單組列表。
    whiteIpType String PRIVATE_ES

    白名單類型。取值含義如下：

    • PRIVATE_ES：Elasticsearch私網。
    • PUBLIC_ES：Elasticsearch公網。
    • PRIVATE_KIBANA：Kibana私網。
    • PUBLIC_KIBANA：Kibana公網。
    groupName String default

    白名單組的組名。預設包含default分組。
    ips Array of String ["0.0.0.0", "127.0.XX.XX"]

    白名單組中的IP列表。
    kibanaConfiguration Object

    Kibana節點的配置資訊。
    amount Integer 1

    節點數量。
    spec String elasticsearch.n4.small

    節點規格。規格資訊可通過產品規格查看。
    disk Integer 20

    單節點儲存空間大小。，單位：GB。
    specInfo String 1C 2G

    節點規格描述
    masterConfiguration Object

    Master節點配置。
    spec String elasticsearch.n4.small

    節點規格。規格資訊可通過產品規格查看。
    amount Integer 3

    節點數量。
    disk Integer 40

    節點儲存空間大小，單位：GB。
    diskType String cloud_ssd

    節點儲存類型。只支援cloud_ssd（SSD雲端硬碟）。
    specInfo String 1C 2G

    節點規格描述
    clientNodeConfiguration Object

    協調節點配置資訊。
    spec String elasticsearch.n4.small

    節點規格。規格資訊可通過產品規格查看。
    amount Integer 3

    節點數量。
    disk Integer 40

    節點儲存空間大小，單位：GB。
    diskType String cloud_efficiency

    節點儲存類型，只支援高效雲端硬碟（cloud_efficiency）。
    specInfo String 1C 2G

    節點規格描述
    warmNodeConfiguration Object

    冷資料節點配置資訊。
    amount Integer 6

    節點數量。
    spec String elasticsearch.n4.small

    節點規格。規格資訊可通過產品規格查看。
    disk Integer 500

    節點儲存空間大小，單位：GB。
    diskEncryption Boolean true

    是否開啟雲端硬碟加密。取值含義如下：

    • true：開啟。
    • false：不開啟。
    diskType String cloud_efficiency

    節點儲存空間類型。只支援cloud_efficiency（高效雲端硬碟）。
    specInfo String 1C 2G

    節點規格描述
    advancedSetting Object

    進階配置。
    gcName String CMS

    GC記憶體回收行程名稱。支援CMS、G1。
    elasticDataNodeConfiguration Object

    彈性資料節點配置。
    amount Integer 3

    節點數量。
    spec String elasticsearch.sn2ne.large

    節點規格。規格資訊可通過產品規格查看。
    disk Integer 20

    節點儲存空間大小，單位：GB。
    diskEncryption Boolean true

    是否為節點開啟雲端硬碟加密，取值含義如下：

    • true：開啟。
    • false：不開啟。
    diskType String cloud_ssd

    節點儲存類型。支援：

    • cloud_ssd：SSD雲端硬碟。
    • cloud_essd：ESSD雲端硬碟。
    • cloud_efficiency：高效雲端硬碟。
    specInfo String 1C 2G

    節點規格描述。
    ikHotDicts Array of ikHotDicts

    IK詞典熱更新配置。
    type String MAIN

    要更新的詞典類型。支援：

    • MAIN：IK主分詞詞庫
    • STOP：IK停用詞庫
    sourceType String OSS

    詞典檔案來源類型，支援：

    • OSS：使用OSS開放儲存
    • ORIGIN：保留之前已經上傳的詞典
    fileSize Integer 6

    詞典檔案大小，單位：Byte。
    name String deploy_0.dic

    詞典檔案名稱。
    instanceCategory String advanced

    執行個體版本類型。傳回值含義如下：

    • x-pack：商業版
    • advanced/IS：增強版
    • community：基礎版
    endtime Long 1715826092044

    執行個體到期時間。
    archType String public

    部署模式，架構類型：

    exclusive：基礎管控

    public：雲原生新管控
    kibanaPrivateDomain String es-cn-x0r3*********.elasticsearch.aliyuncs.com

    kibana私網地址
    kibanaPrivatePort String 5601

    kibana私網連接埠

    說明 以下返回樣本中，本文只保證包含返回資料列表中的參數，而未提到的參數僅供參考，程式中不能強制依賴擷取這些參數。

    樣本

    請求樣本

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

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。