You need to enable JavaScript to run this app.
导航
DescribeInstance - 查询实例详情
最近更新时间:2024.04.09 15:04:00首次发布时间:2023.11.30 14:19:26

调用 DescribeInstance 接口,查询指定实例的配置详情。

请求说明

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

请求参数

Query

参数类型是否必选示例值描述
ActionStringDescribeInstance接口名称。当前 API 的名称为 DescribeInstance
VersionString2023-01-01接口版本。当前 API 的版本为 2023-01-01

Body

参数类型是否必选示例值描述
InstanceIdStringo-0080**iu98需要查询配置详情的实例 ID。

返回参数

参数类型示例值描述
InstanceInfoObject of ESInstanceInfoDTO实例配置详情信息。

ESInstanceInfoDTO

参数类型示例值描述
ESEipString180.*.*.*实例所绑定的 EIP。

Status

String

Running

实例当前状态。
实例状态详情,请参见实例状态

UserIdString210***34实例所有者的用户 ID。
ESEipIdStringeip-mij5ztefl98**实例所绑定的 EIP 的 ID。
ClusterIdString16a119e0d***41ae2627b0实例所属集群的 ID。
KibanaEipString180.*.*.*Kibana 所绑定的 EIP。
CreateTimeString2024-03-21T10:32:24+08:00实例的创建时间。
ExpireDateString2023-11-11T15:59:59.000+00:00包年包月实例的付费过期时间。
InstanceIdStringo-00k***o718实例 ID。
TotalNodesInteger12实例的总节点数。
KibanaEipIdStringeip-mij5ztefl98**Kibana 所绑定的 EIP 的 ID。
KibanaConfigObject of ESKibanaConfigKibana 参数配置。
ResourceTagsArray of TagInfo实例的标签信息。
SubInstancesArray of ESSubInstanceDTO企业级 SQL 分析实例配置信息。
TransferInfoObject of TransferInfo数据迁移任务信息。
ChargeEnabledBooleantrue实例是否开启了计费。取值说明如下:
  • true:已开启计费
  • false:未开启计费
  • CerebroEnabledBooleantrue是否开启 cerebro。
  • true:开启 cerebro
  • false:不开启 cerebro
  • MaintenanceDayArray of String["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]实例的可维护日期。
    MaintenanceTimeString03:00-06:00实例的可维护时间段。
    ESPublicEndpointStringhttps://elasticsearch-o-00k***o718..escloud.volces.com:9200实例公网访问地址。
    ESPrivateEndpointStringhttps://elasticsearch-o-00k***o718.escloud.ivolces.com:9200实例私网访问地址。

    DeletionProtection

    Boolean

    true

    实例是否开启删除保护功能。

  • true:已开启实例删除保护
  • false:未开启实例删除保护
  • 说明

    开启实例删除保护后,您将无法通过控制台或者 API 删除实例。

    KibanaPublicDomain

    String

    https://visual-o-00**.escloud.volces.com:5601

    Kibana 公网访问地址。

    说明

    如果是历史实例,访问地址有可能是http(s)://kibana-***开头。

    CerebroPublicDomain

    String

    https://visual-o-00g**.escloud.volces.com:9000/

    cerebro 公网访问地址。

    说明

    Cerebro 和 Kibana 共享域名。如果是历史实例,访问地址有可能是http(s)://kibana-***开头。

    ESPublicIpWhitelist

    String

    182.*.*.*

    实例公网地址访问白名单。

    • 支持单个 IP 地址或 IP 网段的形式,格式为 192.168.0.1 或 192.168.0.0/24,多个 IP 地址之间用英文逗号隔开。
    • IP 地址和网段数量最多支持 300 个。

    KibanaPrivateDomain

    String

    https://visual-o-00**.escloud.ivolces.com:5601

    Kibana 私网访问地址。

    说明

    如果是历史实例,访问地址有可能是http(s)://kibana-***开头。

    CerebroPrivateDomain

    String

    https://visual-o-**.escloud.ivolces.com:5601

    cerebro 私网访问地址。

    说明

    Cerebro 和 Kibana 共享域名。如果是历史实例,访问地址有可能是http(s)://kibana-***开头。

    ESPrivateIpWhitelist

    String

    192.168.1.1,192.168.1.2

    实例私网地址访问白名单。

    • 支持单个 IP 地址或 IP 网段的形式,格式为 192.168.0.1 或 192.168.0.0/24,多个 IP 地址之间用英文逗号隔开。
    • IP 地址和网段数量最多支持 300 个。
    EnableESPublicNetworkBooleantrue实例是否开启了公网访问。
  • true:已开启公网访问
  • false:未开启公网访问
  • InstanceConfigurationObject of EsInstanceConfigurationInfoDTO实例配置详情信息。
    EnableESPrivateNetworkBooleantrue实例是否开启了私网访问。
  • true:默认值,开启私网访问
  • false:未开启私网访问
  • KibanaPublicIpWhitelist

    String

    182.*.*.*

    Kibana 公网白名单。只有添加到白名单中的 IP 地址才可以访问可视化工具。

    说明

    Cerebro 和 Kibana 共用一套白名单

    KibanaPrivateIpWhitelist

    String

    192.168.1.1,192.168.1.2

    Kibana 私网白名单。只有添加到白名单中的 IP 地址才可以访问可视化工具。

    说明

    Cerebro 和 Kibana 共用一套白名单。

    EnableKibanaPublicNetworkBooleantrueKibana 是否开启公网访问。
  • true:已开启公网访问
  • false:未开启公网访问
  • EnableKibanaPrivateNetworkBooleantrueKibana 是否开启私网访问。
  • true:默认值,已开启私网访问
  • false:未开启Kibana私网访问
  • EnableESPrivateDomainPublicBooleantrue实例是否开启私网地址公网解析。
  • true:已开启私网地址公网解析
  • false:未开启私网地址公网解析
  • EnableKibanaPrivateDomainPublicBooleantrueKibana 是否开启私网地址公网解析。
  • true:已开启私网地址公网解析
  • false:未开启私网地址公网解析
  • ESKibanaConfig

    参数类型示例值描述

    SessionTTL

    Long

    3600000

    会话有效时长,默认为 3600000 毫秒(1 小时)。
    如果您选择将 Session 活动保持设置为,当登录时长达到 Session 有效时长后,将会自动退出登录。

    RequestTimeout

    Long

    30000

    接口请求超时时长,默认为 30000 毫秒,即后端响应时长超过 30 秒时将出现503 Request timed out报错。
    如果需要正常获得响应、减少 503 报错,您可以选择增加请求超时时长。

    SessionKeepAlive

    Boolean

    true

    是否主动延长会话有效期。

    • true:默认值,表示每次页面请求都会延长会话有效期。
    • false:不会主动延长会话有效期。此种配置下可以实现会话超时过期效果,当登录时长达到 Session 有效时长后,将会自动退出登录。

    TagInfo

    参数类型示例值描述

    Type

    String

    CUSTOM

    节点标签的类型。

    • CUSTOM:自定义设置的标签。
    • SYSTEM:系统标签。
    TagKvsJSON Mapuser标签键。
    TagKeysArray of Stringtom标签值。

    ESSubInstanceDTO

    参数类型示例值描述
    SubInstanceIdStringk-00g0oh**企业级 SQL 分析实例 ID。
    SubInstanceTypeStringsql实例类型。
    SubInstanceStatusStringAVAILABLE实例状态。

    TransferInfo

    参数类型示例值描述
    TransferStatusStringFINISH数据迁移任务状态。
    TransferTaskIdString88dbdf2431b44f36**数据迁移任务 ID。
    ReduceSpecConfigObject of ReduceSpecConfig资源信息。
    TransferProgressDouble100数据迁移任务进度,百分制。

    EsInstanceConfigurationInfoDTO

    参数类型示例值描述
    VPCObject of VpcInfo实例的私有网络 VPC 信息。
    SubnetObject of SubnetInfo实例的子网信息。
    ZoneIdStringcn-beijing-a实例所在可用区。
    VersionStringV7_10实例版本。
  • ES 实例支持的版本包括V6_7V7_10
  • OpenSearch 实例支持的版本OPEN_SEARCH_2_9
  • RegionIdStringcn-beijing实例所在区域。
    ChargeTypeStringPostPaid实例计费类型。
  • PostPaid:按量计费
  • PrePaid:包年包月
  • MainZoneIdStringcn-beijing-a主可用区。
    ZoneNumberInteger1实例的可用区数量。

    EnableHttps

    Boolean

    true

    是否启用 HTTPS 访问协议。

  • true:启用 HTTPS 访问
  • false:不启用 HTTPS,使用 HTTP 访问
  • 说明

    如果使用 HTTP 访问,将无需安全认证即可访问,并使用 HTTP 明文传输数据。您需要确保访问环境的安全性,且不要将访问接口暴露在公网环境上

    ProjectName

    String

    default

    实例所属的项目。
    实例默认属于 default 项目,支持调整实例所属项目。

    InstanceNameStringdoc-test实例名称。
    AdminUserNameStringadmin实例管理员账号,固定为 admin
    HotNodeNumberInteger3数据节点数量。
    ColdNodeNumberInteger3冷节点数量。
    WarmNodeNumberInteger3温节点数量。
    EnablePureMasterBooleantrueMaster 节点是否独立。
  • true:Master 节点独立。
  • false:Master 节点与数据节点重合,即使用 Hot 声明。
  • KibanaNodeNumberInteger1kibana 节点数量。
    MasterNodeNumberInteger3master 节点数量。
    HotNodeStorageSpecObject of StorageSpecs数据节点的存储规格配置详情。
    ColdNodeStorageSpecObject of StorageSpecs冷节点的存储规格配置详情。
    HotNodeResourceSpecObject of ResourceSpecs数据节点的节点规格配置详情。
    WarmNodeStorageSpecObject of StorageSpecs温节点的存储规格配置详情。
    ColdNodeResourceSpecObject of ResourceSpecs冷节点的节点规格配置详情。
    WarmNodeResourceSpecObject of ResourceSpecs温节点的节点规格配置详情。
    CoordinatorNodeNumberInteger3协调节点数量。
    MasterNodeStorageSpecObject of StorageSpecsMaster 节点的存储规格配置详情。
    KibanaNodeResourceSpecObject of ResourceSpecsKibana 节点的节点规格配置详情。
    MasterNodeResourceSpecObject of ResourceSpecsMaster 节点的节点规格配置详情。
    CoordinatorNodeStorageSpecObject of StorageSpecs协调节点的存储规格配置详情。
    CoordinatorNodeResourceSpecObject of ResourceSpecs协调节点的节点规格配置详情。

    ReduceSpecConfig

    参数类型示例值描述
    ColdNodeNumInteger0冷节点数量。
    DataNodeNumInteger3数据节点数量。
    WarmNodeNumInteger3温节点数量。
    MasterNodeNumInteger3Master 节点数量。

    EnablePureMaster

    Boolean

    false

    Master 节点是否独立。

    • true:Master 节点独立。
    • false:Master 节点与数据节点重合,即用 Hot 来声明。

    VpcInfo

    参数类型示例值描述
    VpcIdStringvpc-274uhjap8u72****VPC ID
    VpcNameStringvpc_nameAVPC 名称

    SubnetInfo

    参数类型示例值描述
    SubnetIdStringsubnet-1323sdda****Subnet ID
    SubnetNameStringsubnet_nameASubnet 名称

    StorageSpecs

    参数类型示例值描述
    NameStringes.volume.essd.pl0存储规格,当前的规格如下:
    es.volume.essd.pl0:标准版-高性能云盘-pl0
    SizeInteger20配置的可用磁盘空间大小。
    MaxSizeInteger10000存储规格的最大值,单位为 GiB。
    MinSizeInteger20存储规格最小值,单位为 GiB。
    DescriptionString标准版-高性能云盘-pl0存储规格的描述信息。
    DisplayNameStringESSD-PL0存储规格的显示名称。

    ResourceSpecs

    参数类型示例值描述
    CPUInteger2节点规格的 CPU 资源,单位为核(Core)。
    NameStringes.x2.medium节点规格。如需了解节点规格类型和详情,请参见产品规格
    MemoryInteger4节点规格的内存容量,单位 GiB。
    DescriptionString标准版-2C4G节点节点规格的描述信息。
    DisplayNameString2核4GiB节点规格的显示名称。

    请求示例

    POST https://open.volcengineapi.com?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": "202403211143454EE027B0F2EA4**",
            "Action": "DescribeInstance",
            "Version": "2023-01-01",
            "Service": "escloud",
            "Region": "cn-beijing"
        },
        "Result": {
            "InstanceInfo": {
                "ChargeEnabled": true,
                "CreateTime": "2024-03-21T10:32:24+08:00",
                "DeletionProtection": false,
                "KibanaPrivateIpWhitelist": "",
                "KibanaPublicIpWhitelist": "",
                "EnableESPrivateNetwork": true,
                "EnableESPublicNetwork": false,
                "EnableKibanaPrivateNetwork": true,
                "EnableKibanaPublicNetwork": false,
                "EnableESPrivateDomainPublic": false,
                "EnableKibanaPrivateDomainPublic": false,
                "KibanaEipId": "",
                "KibanaEip": "",
                "ExpireDate": "",
                "InstanceConfiguration": {
                    "AdminUserName": "admin",
                    "ChargeType": "PostPaid",
                    "EnableHttps": true,
                    "EnablePureMaster": true,
                    "ProjectName": "default",
                    "RegionId": "cn-beijing",
                    "ZoneId": "cn-beijing-a",
                    "ZoneNumber": 1,
                    "Subnet": {
                        "SubnetId": "subnet-rrzpagjr7ncw***",
                        "SubnetName": "wuch_A_sub"
                    },
                    "Version": "V7_10",
                    "ColdNodeNumber": 0,
                    "HotNodeNumber": 3,
                    "HotNodeResourceSpec": {
                        "Name": "es.x2.medium",
                        "DisplayName": "2核4GiB",
                        "Description": "标准版-2C4G节点",
                        "Memory": 4,
                        "CPU": 2
                    },
                    "HotNodeStorageSpec": {
                        "Name": "es.volume.essd.pl0",
                        "DisplayName": "ESSD-PL0",
                        "Description": "标准版-高性能云盘-pl0",
                        "MaxSize": 15000,
                        "MinSize": 20,
                        "Size": 20,
                        "Type": ""
                    },
                    "CoordinatorNodeNumber": 2,
                    "CoordinatorNodeResourceSpec": {
                        "Name": "es.x2.medium",
                        "DisplayName": "2核4GiB",
                        "Description": "标准版-2C4G节点",
                        "Memory": 4,
                        "CPU": 2
                    },
                    "CoordinatorNodeStorageSpec": {
                        "Name": "es.volume.essd.pl0",
                        "DisplayName": "ESSD-PL0",
                        "Description": "标准版-高性能云盘-pl0",
                        "MaxSize": 15000,
                        "MinSize": 20,
                        "Size": 20,
                        "Type": ""
                    },
                    "InstanceName": "doc-test",
                    "KibanaNodeNumber": 1,
                    "KibanaNodeResourceSpec": {
                        "Name": "kibana.x2.small",
                        "DisplayName": "1核2GiB",
                        "Description": "Kibana专用-1C2G节点",
                        "Memory": 2,
                        "CPU": 1
                    },
                    "MasterNodeNumber": 3,
                    "MasterNodeResourceSpec": {
                        "Name": "es.x2.medium",
                        "DisplayName": "2核4GiB",
                        "Description": "标准版-2C4G节点",
                        "Memory": 4,
                        "CPU": 2
                    },
                    "MasterNodeStorageSpec": {
                        "Name": "es.volume.essd.pl0",
                        "DisplayName": "ESSD-PL0",
                        "Description": "标准版-高性能云盘-pl0",
                        "MaxSize": 15000,
                        "MinSize": 20,
                        "Size": 20,
                        "Type": ""
                    },
                    "WarmNodeNumber": 3,
                    "WarmNodeResourceSpec": {
                        "Name": "es.x2.medium",
                        "DisplayName": "2核4GiB",
                        "Description": "标准版-2C4G节点",
                        "Memory": 4,
                        "CPU": 2
                    },
                    "WarmNodeStorageSpec": {
                        "Name": "es.volume.essd.pl0",
                        "DisplayName": "ESSD-PL0",
                        "Description": "标准版-高性能云盘-pl0",
                        "MaxSize": 15000,
                        "MinSize": 20,
                        "Size": 20,
                        "Type": ""
                    },
                    "VPC": {
                        "VpcId": "vpc-13fsccvrjxla83n6***",
                        "VpcName": "wuch_vpc0110"
                    }
                },
                "MetricsVersion": "2.0.0",
                "InstanceId": "o-00c00wd***",
                "KibanaPrivateDomain": "https://visual-o-00c00**.escloud.ivolces.com:5601",
                "KibanaPublicDomain": "",
                "MaintenanceDay": [
                    "MONDAY",
                    "TUESDAY",
                    "WEDNESDAY",
                    "THURSDAY",
                    "FRIDAY",
                    "SATURDAY",
                    "SUNDAY"
                ],
                "MaintenanceTime": "02:00-06:00",
                "Status": "Running",
                "TransferInfo": {},
                "ResourceTags": [
                    {
                        "Type": "SYSTEM",
                        "TagKvs": {}
                    },
                    {
                        "Type": "CUSTOM",
                        "TagKvs": {
                            "doc": "test"
                        }
                    }
                ],
                "TotalNodes": 12,
                "UserId": "21001***",
                "SubInstances": [
                    {
                        "SubInstanceId": "k-00g04q**",
                        "SubInstanceType": "Sql",
                        "SubInstanceStatus": "AVAILABLE"
                    }
                ],
                "Encrypted": false,
                "CerebroEnabled": false,
                "CerebroPrivateDomain": "",
                "CerebroPublicDomain": "",
                "ESInnerEndpoint": "",
                "ESPrivateDomain": "",
                "ESPrivateEndpoint": "https://elasticsearch-o-00c00w**.escloud.ivolces.com:9200",
                "ESPublicDomain": "",
                "ESPublicEndpoint": "",
                "ESPrivateIpWhitelist": "",
                "ESPublicIpWhitelist": "",
                "ESEipId": "",
                "ESEip": ""
            }
        }
    }