All Products
Search

This Product

    Lindorm:GetLindormV2InstanceDetails

    Document Center

    Lindorm:GetLindormV2InstanceDetails

    Last Updated:Dec 15, 2025

    Queries the details of a new architecture instance.

    Operation description

    For Lindorm clusters with an underlying storage version of 4.1.9 or later, refer to the LStorageUsageList parameter for storage usage details.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    lindorm:GetLindormV2InstanceDetails

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The instance ID.

    ld-bp1mq0tdzbx1m****

    Response elements

    Element

    Type

    Description

    Example

    object

    VpcId

    string

    The ID of the virtual private cloud (VPC) where the instance resides.

    vpc-bp1xxxxxxxxxxxxxxxxxx
    VswitchId

    string

    The virtual switch ID.

    vsw-bp1xxxxxxxxxxxxxxxxxx
    PayType

    string

    The billing method of the instance. Valid values:

    • PREPAY: subscription.

    • POSTPAY: pay-as-you-go.

    POSTPAY
    NetworkType

    string

    The network type of the instance.

    VPC
    DiskUsage

    string

    The disk space usage.

    0.0%
    DiskCategory

    string

    The storage class. Valid values:

    • StandardStorage: Standard cloud storage.

    • PerformanceStorage: Performance cloud storage.

    PerformanceStorage
    RequestId

    string

    The request ID.

    1556DCB0-043A-4444-8BD9-CF4A68E7EE64
    ColdStorage

    integer

    The capacity of the storage-optimized cloud storage.

    800
    ExpiredMilliseconds

    integer

    The number of milliseconds between the instance expiration time and 00:00:00 on January 1, 1970.

    1629993600000
    AutoRenew

    boolean

    Indicates whether auto-renewal is enabled. Valid values:

    • true: enabled.

    • false: disabled.

    Note

    This parameter is returned only for subscription instances.

    true
    DeletionProtection

    string

    Indicates whether deletion protection is enabled. Valid values:

    • true: enabled.

    • false: disabled.

    false
    AliUid

    integer

    The 16-digit ID of the Alibaba Cloud account.

    164901546557****
    InstanceId

    string

    The instance ID.

    ld-bp1mq0tdzbx1m****
    InstanceType

    string

    The instance type. Valid value:

    • basic: Production.

    basic
    RegionId

    string

    The region ID.

    cn-hangzhou
    CreateMilliseconds

    integer

    The number of milliseconds between the instance creation time and 00:00:00 on January 1, 1970.

    1627290664000
    InstanceAlias

    string

    The instance name.

    lindorm-test
    ZoneId

    string

    The zone ID.

    cn-hangzhou-h
    InstanceStatus

    string

    The instance status. Valid values:

    • CREATING: The instance is being created.

    • ACTIVATION: The instance is running.

    • COLD_EXPANDING: The storage-optimized cloud storage is being scaled out.

    • MINOR_VERSION_TRANSING: The minor version is being upgraded.

    • RESIZING: The nodes are being scaled out.

    • SHRINKING: The nodes are being scaled in.

    • CLASS_CHANGING: The instance specifications are being upgraded or downgraded.

    • SSL_SWITCHING: The SSL certificate is being changed.

    • CDC_OPENING: The change tracking feature is being enabled.

    • TRANSFER: Data is being migrated.

    • DATABASE_TRANSFER: Data is being migrated to the database.

    • GUARD_CREATING: A disaster recovery instance is being created.

    • BACKUP_RECOVERING: Data is being restored from a backup.

    • DATABASE_IMPORTING: Data is being imported.

    • NET_MODIFYING: The network is being modified.

    • NET_SWITCHING: The network is being switched between the private network and the public network.

    • NET_CREATING: A network connection is being created.

    • NET_DELETING: A network connection is being deleted.

    • DELETING: The instance is being deleted.

    • RESTARTING: The instance is being restarted.

    • LOCKED: The instance has expired and is locked.

    ACTIVATION
    PrimaryZoneId

    string

    For a multi-zone instance, this is the ID of the primary zone.

    cn-shanghai-e
    PrimaryVSwitchId

    string

    For a multi-zone instance, this is the ID of the virtual switch in the primary zone. The vSwitch must be in the zone specified by `PrimaryZoneId`.

    vsw-uf6fdqa7c0pipnqzq****
    StandbyZoneId

    string

    For a multi-zone instance, this is the ID of the secondary zone.

    cn-shanghai-f
    StandbyVSwitchId

    string

    For a multi-zone instance, this is the ID of the virtual switch in the secondary zone. The vSwitch must be in the zone specified by `StandbyZoneId`.

    vsw-2zec0kcn08cgdtr6****
    ArbiterZoneId

    string

    For a multi-zone instance, this is the ID of the arbiter zone.

    cn-shanghai-g
    ArbiterVSwitchId

    string

    For a multi-zone instance, this is the ID of the virtual switch in the arbiter zone. The vSwitch must be in the zone specified by `ArbiterZoneId`.

    vsw-uf6664pqjawb87k36****
    EngineList

    array<object>

    The list of engine information.

    array<object>

    The list of engine information.

    Version

    string

    The version number of the engine type.

    2.2.3
    Engine

    string

    The engine type. Valid values:

    • TABLE: LindormTable.

    • TSDB: LindormTSDB.

    • LSEARCH: Search engine.

    • LTS: LTS engine.

    • LVECTOR: Vector engine.

    • LCOLUMN: Column store.

    TABLE
    IsLastVersion

    boolean

    Indicates whether the engine is the latest version. Valid values:

    • true: The engine is the latest version.

    • false: The engine is not the latest version.

    false
    LatestVersion

    string

    The latest version number for the engine type.

    2.2.19.2
    ConnectAddressList

    array<object>

    A list of engine endpoints.

    object

    A list of engine endpoints.

    Address

    string

    The endpoint.

    ld-mxj9asg***-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060
    Type

    string

    The endpoint type.

    • INTRANET: VPC private endpoint.

    • INTERNET: Public endpoint.

    INTRANET
    Port

    string

    The port number of the database endpoint.

    33060
    NodeGroup

    array<object>

    A list of engine node groups.

    object

    A list of engine node groups.

    NodeSpec

    string

    The node specifications.

    If you select Performance cloud storage or Standard cloud storage, this parameter can be set to one of the following values:

    • lindorm.c.2xlarge: 8 vCPUs, 16 GB memory.

    • lindorm.g.2xlarge: 8 vCPUs, 32 GB memory.

    • lindorm.c.4xlarge: 16 vCPUs, 32 GB memory.

    • lindorm.g.4xlarge: 16 vCPUs, 64 GB memory.

    • lindorm.c.8xlarge: 32 vCPUs, 64 GB memory.

    • lindorm.g.8xlarge: 32 vCPUs, 128 GB memory.

    • lindorm.r.2xlarge: 8 vCPUs, 64 GB memory.

    • lindorm.r.4xlarge: 16 vCPUs, 128 GB memory.

    • lindorm.r.8xlarge: 32 vCPUs, 256 GB memory.

    If you select Local SSD, this parameter can be set to one of the following values:

    • lindorm.i4.xlarge: 4 vCPUs, 32 GB memory (I4).

    • lindorm.i4.2xlarge: 8 vCPUs, 64 GB memory (I4).

    • lindorm.i4.4xlarge: 16 vCPUs, 128 GB memory (I4).

    • lindorm.i4.8xlarge: 32 vCPUs, 256 GB memory (I4).

    • lindorm.i3.xlarge: 4 vCPUs, 32 GB memory (I3).

    • lindorm.i3.2xlarge: 8 vCPUs, 64 GB memory (I3).

    • lindorm.i3.4xlarge: 16 vCPUs, 128 GB memory (I3).

    • lindorm.i3.8xlarge: 32 vCPUs, 256 GB memory (I3).

    • lindorm.i2.xlarge: 4 vCPUs, 32 GB memory (I2).

    • lindorm.i2.2xlarge: 8 vCPUs, 64 GB memory (I2).

    • lindorm.i2.4xlarge: 16 vCPUs, 128 GB memory (I2).

    • lindorm.i2.8xlarge: 32 vCPUs, 256 GB memory (I2).

    If you select Big Data, this parameter can be set to one of the following values:

    • lindorm.sd3c.3xlarge: 14 vCPUs, 56 GB memory (D3C PRO).

    • lindorm.sd3c.7xlarge: 28 vCPUs, 112 GB memory (D3C PRO).

    • lindorm.sd3c.14xlarge: 56 vCPUs, 224 GB memory (D3C PRO).

    • lindorm.d2c.6xlarge: 24 vCPUs, 88 GB memory (D2C).

    • lindorm.d2c.12xlarge: 48 vCPUs, 176 GB memory (D2C).

    • lindorm.d2c.24xlarge: 96 vCPUs, 352 GB memory (D2C).

    • lindorm.d2s.5xlarge: 20 vCPUs, 88 GB memory (D2S).

    • lindorm.d2s.10xlarge: 40 vCPUs, 176 GB memory (D2S).

    • lindorm.d1.2xlarge: 8 vCPUs, 32 GB memory (D1NE).

    • lindorm.d1.4xlarge: 16 vCPUs, 64 GB memory (D1NE).

    • lindorm.d1.6xlarge: 24 vCPUs, 96 GB memory (D1NE).

    lindorm.g.2xlarge
    EnableAttachLocalDisk

    boolean

    Indicates whether a local disk is attached to the node.

    false
    LocalDiskCategory

    string

    The type of the local disk.

    • cloud_essd: performance disk.

    • cloud_efficiency: standard disk.

    cloud_essd
    LocalDiskCapacity

    integer

    The capacity of the local disk in GB.

    100
    CpuCoreCount

    integer

    The number of vCPUs for the node.

    32
    MemorySizeGiB

    integer

    The memory size of the node.

    64
    Quantity

    integer

    The number of nodes.

    10
    Category

    string

    Deprecated.

    caculated
    ResourceGroupName

    string

    The name of the node group. Required. This must be the same as the name used during creation.

    job_debug
    SpecId

    string

    The unique ID that corresponds to the delivery group ID.

    ecs.c6.large
    Status

    string

    The node status.

    ACTIVATION
    ResourceGroupId

    string

    The resource group ID.

    rg-aek2i6weeb4nfii
    ServiceType

    string

    The instance type. Valid values:

    • lindorm_v2: Lindorm V2 single-zone instance.

    • lindorm_v2_multizone: Lindorm V2 multi-zone Basic Edition instance.

    • lindorm_v2_multizone_ha: Lindorm V2 multi-zone High-availability Edition instance.

    lindorm_v2
    WhiteIpList

    array<object>

    The instance access whitelist.

    object

    The instance access whitelist.

    GroupName

    string

    The group name. The name can contain only letters, digits, and underscores (_).

    swhy
    IpList

    string

    The IP addresses in the whitelist.

    ['10.2.0.0/18', '10.0.0.0/24', '119.23.188.139/32']
    StorageUsage

    object

    The instance storage usage.

    CapacityByDiskCategory

    array<object>

    The instance storage usage.

    object

    The instance storage usage.

    Capacity
    EngineUsage

    object

    The storage usage of each engine.

    16
    ZoneEngineInfoMap

    object

    The deployment details of the engine in the zone.

    ZoneEngineInfoMap
    InitialRootPassword

    string

    The default initial password.

    *****
    DiskThreshold

    string

    The disk space threshold.

    80%
    EnableCompute

    boolean

    Indicates whether the compute engine is enabled for the instance. Valid values:

    • true: enabled.

    • false: disabled.

    true
    MaintainStartTime

    string

    The start time of the maintenance window.

    00:00Z
    MaintainEndTime

    string

    The end time of the maintenance window.

    20:00Z
    CloudStorageSize

    integer

    The cloud storage capacity in GB.

    480

    Examples

    Success response

    JSON format

    {
  "VpcId": "vpc-bp1xxxxxxxxxxxxxxxxxx",
  "VswitchId": "vsw-bp1xxxxxxxxxxxxxxxxxx",
  "PayType": "POSTPAY",
  "NetworkType": "VPC",
  "DiskUsage": "0.0%",
  "DiskCategory": "PerformanceStorage",
  "RequestId": "1556DCB0-043A-4444-8BD9-CF4A68E7EE64",
  "ColdStorage": 800,
  "ExpiredMilliseconds": 1629993600000,
  "AutoRenew": true,
  "DeletionProtection": "false",
  "AliUid": 0,
  "InstanceId": "ld-bp1mq0tdzbx1m****",
  "InstanceType": "basic",
  "RegionId": "cn-hangzhou",
  "CreateMilliseconds": 1627290664000,
  "InstanceAlias": "lindorm-test",
  "ZoneId": "cn-hangzhou-h",
  "InstanceStatus": "ACTIVATION",
  "PrimaryZoneId": "cn-shanghai-e",
  "PrimaryVSwitchId": "vsw-uf6fdqa7c0pipnqzq****",
  "StandbyZoneId": "cn-shanghai-f",
  "StandbyVSwitchId": "vsw-2zec0kcn08cgdtr6****",
  "ArbiterZoneId": "cn-shanghai-g",
  "ArbiterVSwitchId": "vsw-uf6664pqjawb87k36****",
  "EngineList": [
    {
      "Version": "2.2.3",
      "Engine": "TABLE",
      "IsLastVersion": false,
      "LatestVersion": "2.2.19.2",
      "ConnectAddressList": [
        {
          "Address": "ld-mxj9asg***-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060",
          "Type": "INTRANET",
          "Port": "33060"
        }
      ],
      "NodeGroup": [
        {
          "NodeSpec": "lindorm.g.2xlarge",
          "EnableAttachLocalDisk": false,
          "LocalDiskCategory": "cloud_essd",
          "LocalDiskCapacity": 100,
          "CpuCoreCount": 32,
          "MemorySizeGiB": 64,
          "Quantity": 10,
          "Category": "caculated",
          "ResourceGroupName": "job_debug",
          "SpecId": "ecs.c6.large",
          "Status": "ACTIVATION"
        }
      ]
    }
  ],
  "ResourceGroupId": "rg-aek2i6weeb4nfii",
  "ServiceType": "lindorm_v2",
  "WhiteIpList": [
    {
      "GroupName": "swhy",
      "IpList": "['10.2.0.0/18', '10.0.0.0/24', '119.23.188.139/32']"
    }
  ],
  "StorageUsage": {
    "CapacityByDiskCategory": [
      {
        "test": "test",
        "test2": 1
      }
    ],
    "EngineUsage": 16
  },
  "ZoneEngineInfoMap": {
    "test": "test",
    "test2": 1
  },
  "InitialRootPassword": "*****",
  "DiskThreshold": "80%",
  "EnableCompute": true,
  "MaintainStartTime": "00:00Z",
  "MaintainEndTime": "20:00Z",
  "CloudStorageSize": 480
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 Lindorm.Errorcode.ParameterInvaild The parameter is invalid.
    400 Instance.IsDeleted The instance is deleted.
    400 Instance.IsNotValid The instance is invalid. The specified instance is invalid.
    400 LindormErrorCode.%s %s. %s.
    403 Lindorm.Errorcode.OperationDenied You are not authorized to operate on the specified resource.
    403 API.Forbidden The API operation is forbidden in this environment. This operation is not supported in the current environment.
    403 Lindorm.Errorcode.ServiceLinkedRoleNoPermission No permission to create service linked role. You are not authorized to create the service-linked role.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.