GetInstance - Hologres - Alibaba Cloud Documentation Center

Obtains the details of an instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
hologram:GetInstance	Read	All Resources *	none	none

Request syntax

GET /api/v1/instances/{instanceId}

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	No	The ID of the instance. This parameter is required.	hgprecn-cn-i7m2v08uu00a

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	865A02C2-B374-5DD4-9B34-0CA15DA1AEBD
Instance	object	The information about the instance.
InstanceChargeType	string	The billing method of the instance. Valid values: PostPaid : pay-as-you-go . PrePaid : subscription .	PrePaid
CommodityCode	string	The commodity code. Valid values: hologram_maxcomputeAccelerate_public_cn : China site/Lakehouse Acceleration Edition . hologram_combo_public_cn : China site/Subscription . hologram_prepay_public_intl : International site/Subscription . hologram_storage_dp_cn : China site/Storage plan . hologram_postpay_public_cn : China site/Pay-as-you-go . hologram_postpay_public_intl : International site/Pay-as-you-go hologram_maxcomputeAccelerate_public_intl : International site/Lakehouse Acceleration Edition . hologram_cu_dp_cn : China site/Compute plan	hologram_combo_public_cn
Cpu	long	The number of CPU cores.	32
CreationTime	string	The time when the instance was created.	2021-02-03T13:06:06Z
Disk	string	The amount of data that can be stored in the disk of the Standard storage class. Unit: GB.	500
Endpoints	object []	The list of endpoints.
Endpoint	string	The endpoint.	hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80
Type	string	The network type. Valid values: VPCSingleTunnel : virtual private cloud (VPC) . Intranet : internal network . VPCAnyTunnel : not supported by new instances Internet : Internet .	Internet
Enabled	boolean	Indicates whether the network is enabled. Valid values: true false	true
VSwitchId	string	The ID of the vSwitch.	vsw-bp1jqwp2ys6kp7tc9t983
VpcId	string	The ID of the VPC to which the instance belongs.	vpc-uf66jjber3hgvwhki3wna
VpcInstanceId	string	The ID of the instance that is deployed in the VPC.	hgprecn-cn-uqm362o1b001-frontend-st
AlternativeEndpoints	string	The endpoint. This parameter is returned if both the AnyTunnel and SingleTunnel modes are enabled for an instance, and the instance is switched from the AnyTunnel mode to the SingleTunnel mode. In this case, two endpoints are returned.	hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80
ExpirationTime	string	The expiration time. This parameter is invalid for pay-as-you-go instances.	2021-02-03T13:06:06Z
InstanceId	string	The instance ID.	hgpostcn-cn-tl32s6cgw00b
InstanceName	string	The instance name. The instance name must be 2 to 64 characters in length.	test
InstanceType	string	The type of the instance. Valid values: Follower : read-only secondary instance . Standard : normal instance .	Standard
Memory	long	The memory size. Unit: GB.	128
InstanceOwner	string	The owner of the instance.	12345678900000
InstanceStatus	string	The status of the instance. Valid values: Creating Running Suspended Allocating	Running
Version	string	The instance version.	r1.3.37
SuspendReason	string	The reason for the suspension. Valid values: Indebet : The instance has an overdue payment . Manual : The instance is manually suspended . Overdue : The instance has expired .	Manual
Tags	object []	The instance tag.
Key	string	The key of tag N.	tag
Value	string	The value of tag N.	value
LeaderInstanceId	string	The ID of the primary instance.	hgpostcn-cn-i7m2ncd6w002
EnableHiveAccess	string	Indicates whether data lake acceleration is enabled.	true
ResourceGroupId	string	The ID of the resource group.	rg-aekzuq7hpybze2i
ComputeNodeCount	long	The number of compute nodes. In a typical configuration, a node has 16 CPU cores and 32 GB of memory.	2
ZoneId	string	The ID of the zone where the instance resides.	cn-hangzhou-h
ColdStorage	long	The cold storage capacity of the instance. Unit: GB. Standard SSD is used for hot storage, and HDD is used for cold storage.	800
AutoRenewal	string	Indicates whether auto-renewal is enabled. Valid values: true false	true
GatewayCount	long	The number of gateway nodes.	2
GatewayCpu	long	The number of CPU cores of the gateway. Unit: core.	4
GatewayMemory	long	The size of memory resources of the gateway. Unit: GB.	16
RegionId	string	The ID of the region in which the instance resides.	cn-hangzhou
Success	boolean	The request result, which indicates whether the request was successful.	true
ErrorCode	string	The error code that is returned if the request failed.	404
ErrorMessage	string	The error message.	Internal server error.
HttpStatusCode	string	The HTTP status code returned.	200

Examples

Sample success responses

JSONformat

{
  "RequestId": "865A02C2-B374-5DD4-9B34-0CA15DA1AEBD",
  "Instance": {
    "InstanceChargeType": "PrePaid",
    "CommodityCode": "hologram_combo_public_cn",
    "Cpu": 32,
    "CreationTime": "2021-02-03T13:06:06Z",
    "Disk": "500",
    "Endpoints": [
      {
        "Endpoint": "hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80",
        "Type": "Internet",
        "Enabled": true,
        "VSwitchId": "vsw-bp1jqwp2ys6kp7tc9t983",
        "VpcId": "vpc-uf66jjber3hgvwhki3wna",
        "VpcInstanceId": "hgprecn-cn-uqm362o1b001-frontend-st",
        "AlternativeEndpoints": "hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80"
      }
    ],
    "ExpirationTime": "2021-02-03T13:06:06Z",
    "InstanceId": "hgpostcn-cn-tl32s6cgw00b",
    "InstanceName": "test",
    "InstanceType": "Standard",
    "Memory": 128,
    "InstanceOwner": "12345678900000",
    "InstanceStatus": "Running",
    "Version": "r1.3.37",
    "SuspendReason": "Manual",
    "Tags": [
      {
        "Key": "tag",
        "Value": "value"
      }
    ],
    "LeaderInstanceId": "hgpostcn-cn-i7m2ncd6w002",
    "EnableHiveAccess": "true",
    "ResourceGroupId": "rg-aekzuq7hpybze2i",
    "ComputeNodeCount": 2,
    "ZoneId": "cn-hangzhou-h",
    "ColdStorage": 800,
    "AutoRenewal": "true",
    "GatewayCount": 2,
    "GatewayCpu": 4,
    "GatewayMemory": 16,
    "RegionId": "cn-hangzhou"
  },
  "Success": true,
  "ErrorCode": "404",
  "ErrorMessage": "Internal server error.",
  "HttpStatusCode": "200"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2024-01-23

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-07-19

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-05-17

The request parameters of the API has changed. The response structure of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	delete Input Parameters: RegionId
Output Parameters	The response structure of the API has changed.

2023-04-10

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.