请求说明

请求方式：POST
请求地址：/?Action=DescribeInstance&Version=2023-01-01 HTTP/1.1

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeInstance	要执行的操作，取值：DescribeInstance。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
InstanceId	String	是	o-0080**iu98	需要查询配置详情的实例 ID。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
InstanceInfo	Object	--	实例配置详情信息。

请求示例

POST /?Action=DescribeInstance&Version=2023-01-01
Content-Type: application/json
X-Date: 20231003T104027Z
Authorization: HMAC-SHA256 
Credential=AKLTMjI2ODVlYzI3ZGY1NGU4ZjhjYWRjMTlmNTM5OTZ****/20231003/cn-beijing/ESCloud/request, SignedHeaders=content-type;host;x-date, Signature=88dd0a9ea555d8609ec83eb46054b52f6cd4f79b8d5094fa784c66fa3f2b****
{
    "InstanceId": "o-0080**iu98"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250331144330084200142021F05475",
    "Action": "DescribeInstance",
    "Version": "2023-01-01",
    "Service": "ESCloud",
    "Region": "cn-beijing"
  },
  "Result": {
    "InstanceInfo": {
      "ESEip": "180.*.*.*",
      "Status": "Running",
      "UserId": "210***34",
      "ESEipId": "eip-mij5ztefl98**",
      "ClusterId": "16a119e0d***41ae2627b0",
      "KibanaEip": "180.*.*.*",
      "CreateTime": "2024-03-21T10:32:24+08:00",
      "ExpireDate": "2023-11-11T15:59:59.000+00:00",
      "InstanceId": "o-00k***o718",
      "MainZoneId": "cn-beijing-a",
      "TotalNodes": 12,
      "KibanaEipId": "eip-mij5ztefl98**",
      "KibanaConfig": {
        "SessionTTL": 3600000,
        "RequestTimeout": 30000,
        "SessionKeepAlive": true
      },
      "ResourceTags": [
        {
          "Type": "CUSTOM",
          "TagKvs": {},
          "TagKeys": [
            "tom"
          ]
        }
      ],
      "SubInstances": [
        {
          "SubInstanceId": "k-00g0oh**",
          "SubInstanceType": "sql",
          "SubInstanceStatus": "AVAILABLE"
        }
      ],
      "TransferInfo": {
        "ForbidStop": true,
        "TransferStatus": "FINISH",
        "TransferTaskId": "88dbdf2431b44f36**",
        "ReduceSpecConfig": {
          "ColdNodeNum": 0,
          "DataNodeNum": 3,
          "WarmNodeNum": 3,
          "MasterNodeNum": 3,
          "EnablePureMaster": true
        },
        "TransferProgress": 100
      },
      "ChargeEnabled": true,
      "CerebroEnabled": true,
      "MaintenanceDay": [
        "[\"MONDAY\",\"TUESDAY\",\"WEDNESDAY\",\"THURSDAY\",\"FRIDAY\",\"SATURDAY\",\"SUNDAY\"]"
      ],
      "MaintenanceTime": "03:00-06:00",
      "SupportColdNode": true,
      "ESPublicEndpoint": "https://elasticsearch-o-00k***o718..escloud.volces.com:9200",
      "ESPrivateEndpoint": "https://elasticsearch-o-00k***o718.escloud.ivolces.com:9200",
      "DeletionProtection": true,
      "KibanaPublicDomain": "https://visual-o-00**.escloud.volces.com:5601",
      "CerebroPublicDomain": "https://visual-o-00g**.escloud.volces.com:9000/",
      "ESPublicIpWhitelist": "182.*.*.*",
      "KibanaPrivateDomain": "https://visual-o-00**.escloud.ivolces.com:5601",
      "CerebroPrivateDomain": "https://visual-o-**.escloud.ivolces.com:5601",
      "ESPrivateIpWhitelist": "192.168.1.1,192.168.1.2",
      "EnableESPublicNetwork": true,
      "InstanceConfiguration": {
        "VPC": {
          "VpcId": "vpc-274uhjap8u72****",
          "VpcName": "vpc_nameA"
        },
        "Subnet": {
          "SubnetId": "subnet-1323sdda****",
          "SubnetName": "subnet_nameA"
        },
        "ZoneId": "cn-beijing-a",
        "Version": "V7_10",
        "RegionId": "cn-beijing",
        "ChargeType": "PostPaid",
        "ZoneNumber": 1,
        "EnableHttps": true,
        "ProjectName": "default",
        "InstanceName": "doc-test",
        "AdminUserName": "admin",
        "HotNodeNumber": 3,
        "ColdNodeNumber": 3,
        "WarmNodeNumber": 3,
        "EnablePureMaster": true,
        "KibanaNodeNumber": 1,
        "MasterNodeNumber": 3,
        "HotNodeStorageSpec": {
          "Name": "es.volume.essd.pl0",
          "Size": 0,
          "MaxSize": 10000,
          "MinSize": 20,
          "Description": "标准版-高性能云盘-pl0",
          "DisplayName": "ESSD-PL0"
        },
        "ColdNodeStorageSpec": {
          "Name": "es.volume.essd.pl0",
          "Size": 20,
          "MaxSize": 10000,
          "MinSize": 20,
          "Description": "标准版-高性能云盘-pl0",
          "DisplayName": "ESSD-PL0"
        },
        "HotNodeResourceSpec": {
          "CPU": 2,
          "Name": "es.x2.medium",
          "Memory": 4,
          "Description": "标准版-2C4G节点",
          "DisplayName": "2核4GiB"
        },
        "WarmNodeStorageSpec": {
          "Name": "es.volume.essd.pl0",
          "Size": 20,
          "MaxSize": 10000,
          "MinSize": 20,
          "Description": "标准版-高性能云盘-pl0",
          "DisplayName": "ESSD-PL0"
        },
        "ColdNodeResourceSpec": {
          "CPU": 2,
          "Name": "es.x2.medium",
          "Memory": 4,
          "Description": "标准版-2C4G节点",
          "DisplayName": "2核4GiB"
        },
        "WarmNodeResourceSpec": {
          "CPU": 2,
          "Name": "es.x2.medium",
          "Memory": 4,
          "Description": "标准版-2C4G节点",
          "DisplayName": "2核4GiB"
        },
        "CoordinatorNodeNumber": 3,
        "MasterNodeStorageSpec": {
          "Name": "es.volume.essd.pl0",
          "Size": 20,
          "MaxSize": 10000,
          "MinSize": 20,
          "Description": "标准版-高性能云盘-pl0",
          "DisplayName": "ESSD-PL0"
        },
        "KibanaNodeResourceSpec": {
          "CPU": 2,
          "Name": "es.x2.medium",
          "Memory": 4,
          "Description": "标准版-2C4G节点",
          "DisplayName": "2核4GiB"
        },
        "MasterNodeResourceSpec": {
          "CPU": 2,
          "Name": "es.x2.medium",
          "Memory": 4,
          "Description": "标准版-2C4G节点",
          "DisplayName": "2核4GiB"
        },
        "CoordinatorNodeStorageSpec": {
          "Name": "es.volume.essd.pl0",
          "Size": 20,
          "MaxSize": 10000,
          "MinSize": 20,
          "Description": "标准版-高性能云盘-pl0",
          "DisplayName": "ESSD-PL0"
        },
        "CoordinatorNodeResourceSpec": {
          "CPU": 2,
          "Name": "es.x2.medium",
          "Memory": 4,
          "Description": "标准版-2C4G节点",
          "DisplayName": "2核4GiB"
        }
      },
      "EnableESPrivateNetwork": true,
      "KibanaPublicIpWhitelist": "182.*.*.*",
      "KibanaPrivateIpWhitelist": "192.168.1.1,192.168.1.2",
      "EnableKibanaPublicNetwork": true,
      "EnableKibanaPrivateNetwork": true,
      "EnableESPrivateDomainPublic": true,
      "EnableKibanaPrivateDomainPublic": true,
      "SubInstanceEnable": "None",
      "EsPubBandwidth": 5,
      "KibanaPubBandwidth": 5
    }
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
200	InternalServerError	服务器内部异常	服务由于异常退出，无法完成接口请求操作
200	Unauthorized	unauthorized error	用户无权限调用接口
200	IllegalParameter	illegal parameter	非法参数。可能是参数缺失，也可能是参数不符合接口要求

最近更新时间：2025.05.28 20:32:41

这个页面对您有帮助吗？

有用

无用

云搜索服务

请求说明 #

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

请求说明

调试

请求参数

返回参数

请求示例

返回示例

错误码