GetInstance
Retrieves the details of an instance.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
hologram:GetInstance |
get |
*Instance
|
None | None |
Request syntax
GET /api/v1/instances/{instanceId} HTTP/1.1
Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| instanceId |
string |
No |
The instance ID. This parameter is required. |
hgprecn-cn-i7m2v08uu00a |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
No parameters required.
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The request ID. |
865A02C2-B374-5DD4-9B34-0CA15DA1AEBD |
| Instance |
object |
The instance information. |
|
| InstanceChargeType |
string |
The billing method of the instance. Valid values:
|
PrePaid |
| CommodityCode |
string |
The commodity code. Valid values:
|
hologram_combo_public_cn |
| Cpu |
integer |
The number of CPU cores. |
32 |
| CreationTime |
string |
The creation time. The time is displayed in UTC and formatted in accordance with the ISO 8601 standard. |
2021-02-03T13:06:06Z |
| Disk |
string |
The standard storage size. Unit: GB. |
500 |
| Endpoints |
array<object> |
The list of endpoints. |
|
|
object |
The endpoint details. |
||
| Endpoint |
string |
The endpoint. |
hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80 |
| Type |
string |
The network type. Valid values:
|
Internet |
| Enabled |
boolean |
Indicates whether the network is enabled. Valid values:
|
true |
| VSwitchId |
string |
The vSwitch ID. |
vsw-bp1jqwp2ys6kp7tc9t983 |
| VpcId |
string |
The VPC ID. |
vpc-uf66jjber3hgvwhki3wna |
| VpcInstanceId |
string |
The VPC instance ID. |
hgprecn-cn-uqm362o1b001-frontend-st |
| AlternativeEndpoints |
string |
Some legacy instances have both AnyTunnel and SingleTunnel enabled. When switching from AnyTunnel to SingleTunnel, the endpoints for both are retained. Therefore, an additional field is required to store the endpoints. |
hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80 |
| ExpirationTime |
string |
The expiration time. The time is displayed in UTC and formatted in accordance with the ISO 8601 standard. Pay-as-you-go instances do not have an expiration time. |
2021-02-03T13:06:06Z |
| InstanceId |
string |
The instance ID. |
hgpostcn-cn-tl32s6cgw00b |
| InstanceName |
string |
The instance name. The name must be 2 to 64 characters in length. |
test |
| InstanceType |
string |
The instance type. Valid values:
|
Standard |
| Memory |
integer |
The memory size. Unit: GB. |
128 |
| InstanceOwner |
string |
The instance owner. |
12345678900000 |
| InstanceStatus |
string |
The instance status. Valid values:
|
Running |
| Version |
string |
The instance version. |
r1.3.37 |
| SuspendReason |
string |
The reason for suspension. Valid values:
|
Manual |
| Tags |
array<object> |
The instance tags. |
|
|
object |
The tag details. |
||
| Key |
string |
The tag key. |
tag |
| Value |
string |
The tag value. |
value |
| LeaderInstanceId |
string |
The primary instance ID. |
hgpostcn-cn-i7m2ncd6w002 |
| EnableHiveAccess |
string |
Indicates whether data lake acceleration is enabled. |
true |
| ResourceGroupId |
string |
The resource group ID. |
rg-aekzuq7hpybze2i |
| ComputeNodeCount |
integer |
The number of compute nodes. A typical configuration for a node is 16 vCPUs and 32 GB of memory. |
2 |
| ZoneId |
string |
The zone ID. |
cn-hangzhou-h |
| ColdStorage |
integer |
The cold storage capacity. Unit: GB. SSD is equivalent to hot storage, which is also standard storage. HDD is equivalent to cold storage. |
800 |
| AutoRenewal |
string |
Indicates whether auto-renewal is enabled. Valid values:
|
true |
| GatewayCount |
integer |
The number of gateway nodes. |
2 |
| GatewayCpu |
integer |
The CPU resources of the gateway. Unit: Cores. |
4 |
| GatewayMemory |
integer |
The memory resources of the gateway. Unit: GB. |
16 |
| RegionId |
string |
The region ID. |
cn-hangzhou |
| ReplicaRole |
string |
The role of the disaster recovery instance. Active: The primary disaster recovery instance. Passive: The secondary disaster recovery instance. PreActive: The primary disaster recovery instance that has not reached the desired state. |
Active |
| EnableServerless |
boolean |
Indicates whether Serverless Computing is enabled. Valid values:
|
true |
| StorageType |
string |
The storage type. Valid values:
|
redundant |
| EnableSSL |
boolean |
Indicates whether SSL is enabled. |
true |
| EnableSandbox |
boolean |
Indicates whether the instance sandbox feature is enabled. |
|
| Success |
boolean |
The request result. This parameter indicates whether an exception occurred during the request and is independent of the business logic. |
true |
| ErrorCode |
string |
The error code. |
null |
| ErrorMessage |
string |
The error message. |
null |
| HttpStatusCode |
string |
The HTTP status code. |
200 |
Examples
Success response
JSON format
{
"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",
"ReplicaRole": "Active",
"EnableServerless": true,
"StorageType": "redundant",
"EnableSSL": true,
"EnableSandbox": false
},
"Success": true,
"ErrorCode": "null",
"ErrorMessage": "null",
"HttpStatusCode": "200"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.