GetLindormV2InstanceDetails API Reference - Lindorm - Alibaba Cloud - Lindorm

Queries the details of a Lindorm V2 instance.

Operation description

If the underlying storage version of the Lindorm cluster is 4.1.9 or later, refer to the list values returned by LStorageUsageList 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

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID. This operation supports only Lindorm V2 instances whose ServiceType is lindorm_v2, lindorm_v2_multizone, or lindorm_v2_multizone_ha. For V1 instances, use the GetLindormInstance operation. You can use the ServiceType field returned by GetLindormInstanceList to determine the instance architecture.	ld-bp1mq0tdzbx1m****

Response elements

Element	Type	Description	Example
	object
VpcId	string	The ID of the virtual private cloud (VPC) to which the instance belongs.	vpc-bp1xxxxxxxxxxxxxxxxxx
VswitchId	string	The vSwitch 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 type. Valid values: StandardStorage: standard cloud storage. PerformanceStorage: performance cloud storage.	PerformanceStorage
RequestId	string	The request ID.	1556DCB0-043A-4444-8BD9-CF4A68E7EE64
ColdStorage	integer	The storage-optimized cloud storage capacity.	800
ExpiredMilliseconds	integer	The number of milliseconds between the instance expires time and 1970-01-01 00:00:00.	1629993600000
AutoRenew	boolean	Indicates whether auto-renewal is enabled. Valid values: true: enable auto-renewal. false: shutdown. Note This parameter is returned only when the billing method of the instance is subscription.	true
DeletionProtection	string	Indicates whether deletion protection is enabled. Valid values: true: Enabled. false: Disabled.	false
AliUid	integer	The 16-digit AliUid of the Alibaba Cloud account.	164901546557****
InstanceId	string	The instance ID.	ld-bp1mq0tdzbx1m****
InstanceType	string	The instance type. Valid values: basic: production	basic
RegionId	string	The region ID.	cn-hangzhou
CreateMilliseconds	integer	The number of milliseconds between the instance creation time and 1970-01-01 00:00:00.	1627290664000
InstanceAlias	string	The instance name.	lindorm-test
ZoneId	string	The zone ID.	cn-hangzhou-h
InstanceStatus	string	The instance status. Valid values: CREATING: being created. ACTIVATION: running. COLD_EXPANDING: expanding storage-optimized cloud storage. MINOR_VERSION_TRANSING: performing a minor version upgrade. RESIZING: scaling out nodes. SHRINKING: scaling in nodes. CLASS_CHANGING: performing an upgrade or decrease the quota of specifications. SSL_SWITCHING: changing SSL settings. CDC_OPENING: enabling the data subscribe feature. TRANSFER: performing data migration. DATABASE_TRANSFER: performing data migration to a database. GUARD_CREATING: creating a disaster recovery instance. BACKUP_RECOVERING: restoring from a backup. DATABASE_IMPORTING: performing data import. NET_MODIFYING: changing the network. NET_SWITCHING: switching between internal network and public network. NET_CREATING: creating a network connection. NET_DELETING: deleting a network connection. DELETING: being deleted. RESTARTING: restarting. LOCKED: locked because the instance has expired.	ACTIVATION
PrimaryZoneId	string	The zone ID of the primary zone for a multi-zone instance.	cn-shanghai-e
PrimaryVSwitchId	string	The vSwitch ID of the primary zone for a multi-zone instance. The vSwitch must be in the zone specified by PrimaryZoneId.	vsw-uf6fdqa7c0pipnqzq****
StandbyZoneId	string	The zone ID of the secondary zone for a multi-zone instance.	cn-shanghai-f
StandbyVSwitchId	string	The vSwitch ID of the secondary zone for a multi-zone instance. The vSwitch must be in the zone specified by StandbyZoneId.	vsw-2zec0kcn08cgdtr6****
ArbiterZoneId	string	The zone ID of the arbiter zone for a multi-zone instance.	cn-shanghai-g
ArbiterVSwitchId	string	The vSwitch ID of the arbiter zone for a multi-zone instance. 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 engine.	TABLE
IsLastVersion	boolean	Indicates whether the engine type 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 of the engine type.	2.2.19.2
ConnectAddressList	array<object>	The list of engine connection addresses.
	object	The list of engine connection addresses.
Address	string	The connection address.	ld-mxj9asg***-proxy-lindorm-vpc.lindorm.aliyuncs.com:33060
Type	string	The connection address type. Valid values: INTRANET: private network private endpoint. INTERNET: public address.	INTRANET
Port	string	The port number of the database connection address.	33060
NodeGroup	array<object>	The list of engine node groups.
	object	The list of engine node groups.
NodeSpec	string	The node specifications. If you select compute-optimized instance cloud storage or standard cloud storage, this parameter can be set to the following values: lindorm.c.2xlarge: 8 vCPUs and 16 GB memory. lindorm.g.2xlarge: 8 vCPUs and 32 GB memory. lindorm.c.4xlarge: 16 vCPUs and 32 GB memory. lindorm.g.4xlarge: 16 vCPUs and 64 GB memory. lindorm.c.8xlarge: 32 vCPUs and 64 GB memory. lindorm.g.8xlarge: 32 vCPUs and 128 GB memory. lindorm.r.2xlarge: 8 vCPUs and 64 GB memory. lindorm.r.4xlarge: 16 vCPUs and 128 GB memory. lindorm.r.8xlarge: 32 vCPUs and 256 GB memory. If you select the local SSD type, this parameter can be set to the following values: lindorm.i4.xlarge: 4 vCPUs and 32 GB memory (I4). lindorm.i4.2xlarge: 8 vCPUs and 64 GB memory (I4). lindorm.i4.4xlarge: 16 vCPUs and 128 GB memory (I4). lindorm.i4.8xlarge: 32 vCPUs and 256 GB memory (I4). lindorm.i3.xlarge: 4 vCPUs and 32 GB memory (I3). lindorm.i3.2xlarge: 8 vCPUs and 64 GB memory (I3). lindorm.i3.4xlarge: 16 vCPUs and 128 GB memory (I3). lindorm.i3.8xlarge: 32 vCPUs and 256 GB memory (I3). lindorm.i2.xlarge: 4 vCPUs and 32 GB memory (I2). lindorm.i2.2xlarge: 8 vCPUs and 64 GB memory (I2). lindorm.i2.4xlarge: 16 vCPUs and 128 GB memory (I2). lindorm.i2.8xlarge: 32 vCPUs and 256 GB memory (I2). If you select the big data type, this parameter can be set to the following values: lindorm.sd3c.3xlarge: 14 vCPUs and 56 GB memory (D3C PRO). lindorm.sd3c.7xlarge: 28 vCPUs and 112 GB memory (D3C PRO). lindorm.sd3c.14xlarge: 56 vCPUs and 224 GB memory (D3C PRO). lindorm.d2c.6xlarge: 24 vCPUs and 88 GB memory (D2C). lindorm.d2c.12xlarge: 48 vCPUs and 176 GB memory (D2C). lindorm.d2c.24xlarge: 96 vCPUs and 352 GB memory (D2C). lindorm.d2s.5xlarge: 20 vCPUs and 88 GB memory (D2S). lindorm.d2s.10xlarge: 40 vCPUs and 176 GB memory (D2S). lindorm.d1.2xlarge: 8 vCPUs and 32 GB memory (D1NE). lindorm.d1.4xlarge: 16 vCPUs and 64 GB memory (D1NE). lindorm.d1.6xlarge: 24 vCPUs and 96 GB memory (D1NE).	lindorm.g.2xlarge
EnableAttachLocalDisk	boolean	Indicates whether a local cloud disk is attached to the node.	false
LocalDiskCategory	string	The local cloud disk type. Valid values: cloud_essd: performance cloud disk. cloud_efficiency: standard cloud disk.	cloud_essd
LocalDiskCapacity	integer	The local cloud disk capacity, in GB.	100
CpuCoreCount	integer	The number of vCPU cores of 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 node group name. This parameter is required and must be the same as the value specified during creation.	job_debug
SpecId	string	The ID that uniquely 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: a Lindorm V2 single-zone instance. lindorm_v2_multizone: a Lindorm V2 multi-zone Basic Edition instance. lindorm_v2_multizone_ha: a 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. Only letters, digits, and underscores (_) are allowed.	swhy
IpList	string	The whitelist IP addresses.	['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 engine deployment details by zone.	ZoneEngineInfoMap
InitialRootPassword	string	The initial default 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: Not enabled.	true
MaintainStartTime	string	The start time of the maintenance window, in the HH:mmZ format (UTC).	00:00Z
MaintainEndTime	string	The end time of the maintenance window, in the HH:mmZ format (UTC).	20:00Z
CloudStorageSize	integer	The cloud storage capacity, in GB.	480
EnableFs	string	Indicates whether the file engine is enabled.	false
EnableStoreTDE	string	Indicates whether storage Transparent Data Encryption (TDE) is enabled.	false

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,
  "EnableFs": "false",
  "EnableStoreTDE": "false"
}

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.