ListInstance

Request header

This operation uses common request parameters only. For more information, see Common parameters.

Request syntax

GET /openapi/instances HTTPS|HTTP

Request parameters

Response parameters

Examples

Sample requests

GET /openapi/instances? description=abc&page=1&size=10

Sample success responses

XML format

<Result>
    <instanceId>es-cn-n6w1ptcb30009****</instanceId>
    <version>5.5.3_with_X-Pack</version>
    <description>es-cn-n6w1ptcb30009****</description>
    <nodeAmount>3</nodeAmount>
    <paymentType>postpaid</paymentType>
    <status>active</status>
    <enablePublic>false</enablePublic>
    <nodeSpec>
        <spec>elasticsearch.n4.small</spec>
        <disk>20</disk>
        <diskType>cloud_ssd</diskType>
        <diskEncryption>false</diskEncryption>
    </nodeSpec>
    <networkConfig>
        <vpcId>vpc-bp16k1dvzxtmagcva****</vpcId>
        <vswitchId>vsw-bp1k4ec6s7sjdbudw****</vswitchId>
        <vsArea>cn-hangzhou-i</vsArea>
        <type>vpc</type>
    </networkConfig>
    <createdAt>2020-06-28T08:25:52.895Z</createdAt>
    <updatedAt>2020-06-28T08:25:52.895Z</updatedAt>
    <commodityCode>elasticsearch</commodityCode>
    <extendConfigs>
        <configType>usageScenario</configType>
        <value>general</value>
    </extendConfigs>
    <extendConfigs>
        <configType>maintainTime</configType>
        <maintainStartTime>02:00Z</maintainStartTime>
        <maintainEndTime>06:00Z</maintainEndTime>
    </extendConfigs>
    <endTime>4749033600000</endTime>
    <resourceGroupId>rg-acfm2h5vbzd****</resourceGroupId>
    <zoneCount>1</zoneCount>
    <protocol>HTTP</protocol>
    <zoneInfos>
        <zoneId>cn-hangzhou-i</zoneId>
        <status>NORMAL</status>
    </zoneInfos>
    <instanceType>elasticsearch</instanceType>
    <inited>true</inited>
    <esVersion>5.5.3_with_X-Pack</esVersion>
    <haveKibana>true</haveKibana>
    <instanceCategory>x-pack</instanceCategory>
    <dedicateMaster>false</dedicateMaster>
    <advancedDedicateMaster>false</advancedDedicateMaster>
    <masterConfiguration/>
    <haveClientNode>false</haveClientNode>
    <warmNode>false</warmNode>
    <warmNodeConfiguration/>
    <clientNodeConfiguration/>
    <kibanaConfiguration>
        <spec>elasticsearch.n4.small</spec>
        <amount>1</amount>
        <disk>0</disk>
    </kibanaConfiguration>
    <haveGrafana>false</haveGrafana>
    <haveCerebro>false</haveCerebro>
    <enableKibanaPublicNetwork>false</enableKibanaPublicNetwork>
    <enableKibanaPrivateNetwork>false</enableKibanaPrivateNetwork>
    <advancedSetting>
        <gcName>CMS
    </advancedSetting>
</Result>
<RequestId>83EC620F-70A2-4497-A6A3-B1DF359D****</RequestId>
<Headers>
    <X-Total-Count>1</X-Total-Count>
</Headers>

JSON format

{
    "Result": [
        {
            "instanceId": "es-cn-n6w1ptcb30009****",
            "version": "5.5.3_with_X-Pack",
            "description": "es-cn-n6w1ptcb30009****",
            "nodeAmount": 3,
            "paymentType": "postpaid",
            "status": "active",
            "privateNetworkIpWhiteList": [],
            "enablePublic": false,
            "nodeSpec": {
                "spec": "elasticsearch.n4.small",
                "disk": 20,
                "diskType": "cloud_ssd",
                "diskEncryption": false
            },
            "networkConfig": {
                "vpcId": "vpc-bp16k1dvzxtmagcva****",
                "vswitchId": "vsw-bp1k4ec6s7sjdbudw****",
                "vsArea": "cn-hangzhou-i",
                "type": "vpc"
            },
            "createdAt": "2020-06-28T08:25:52.895Z",
            "updatedAt": "2020-06-28T08:25:52.895Z",
            "commodityCode": "elasticsearch",
            "extendConfigs": [
                {
                    "configType": "usageScenario",
                    "value": "general"
                },
                {
                    "configType": "maintainTime",
                    "maintainStartTime": "02:00Z",
                    "maintainEndTime": "06:00Z"
                }
            ],
            "endTime": 4749033600000,
            "clusterTasks": [],
            "resourceGroupId": "rg-acfm2h5vbzd****",
            "zoneCount": 1,
            "protocol": "HTTP",
            "zoneInfos": [
                {
                    "zoneId": "cn-hangzhou-i",
                    "status": "NORMAL"
                }
            ],
            "instanceType": "elasticsearch",
            "inited": true,
            "tags": [],
            "esVersion": "5.5.3_with_X-Pack",
            "esIPWhitelist": [],
            "esIPBlacklist": [],
            "kibanaIPWhitelist": [],
            "kibanaPrivateIPWhitelist": [],
            "publicIpWhitelist": [],
            "haveKibana": true,
            "instanceCategory": "x-pack",
            "dedicateMaster": false,
            "advancedDedicateMaster": false,
            "masterConfiguration": {},
            "haveClientNode": false,
            "warmNode": false,
            "warmNodeConfiguration": {},
            "clientNodeConfiguration": {},
            "kibanaConfiguration": {
                "spec": "elasticsearch.n4.small",
                "amount": 1,
                "disk": 0
            },
            "dictList": [],
            "synonymsDicts": [],
            "ikHotDicts": [],
            "aliwsDicts": [],
            "haveGrafana": false,
            "haveCerebro": false,
            "enableKibanaPublicNetwork": false,
            "enableKibanaPrivateNetwork": false,
            "advancedSetting": {
                "gcName": "CMS"
            }
        }
    ],
    "RequestId": "83EC620F-70A2-4497-A6A3-B1DF359D****",
    "Headers": {
        "X-Total-Count": 1
    }
}

Error codes

For a list of error codes, visit the API Error Center.