Console API
  1. Instances
Console API
  • User
    • User Info
      GET
  • Tenant / Regions
    • Get Regions & Tenant info
      GET
    • Get Tenant Info
      GET
  • VPC
    • Get VPC List
      GET
    • Rename VPC
      PUT
  • Images
    • Get images
      GET
  • Flavors
    • Get flavors
      GET
  • Storage Policy
    • List
      GET
  • Instances
    • List
      GET
    • Detail
      GET
    • Security Group
      GET
    • Create instance
      POST
    • Power off
      POST
    • Reboot
      POST
    • Power on
      POST
    • Terminate
      POST
    • Resize
      POST
    • Lock Termination
      POST
    • Rename
      POST
    • Manage tag
      POST
  • Subnet
    • List
      GET
    • Create
      POST
    • Rename
      PUT
    • Delete
      DELETE
    • Manage tags
      POST
  • Security group
    • Security Group List
    • Security Group Detail
    • Rule Types
    • Create Security Group
    • Create Rule
    • Apply to private ip
    • Delete Rule
    • Delete security group
    • Manage tag
  • Floating IP
    • List
    • Allocate
    • Connect to instance
    • Disconnect
    • Release
    • Manage tag
  • Activity Logs
    • List
  • Tags
    • Lists
  • Iam
    • Add user to user group
    • Get all user groups
    • Create user group
    • Update user group
    • Get roles
    • Get user vpcs
  • Billing
    • Bill
      • Get bills by date
      • Get Bills by paging
      • Bill Info
      • Bill service types
  • Project
    • Get projects
  • S3
    • Get bucket policy
    • List buckets
    • Get s3 service enabled
  1. Instances

Detail

GET
/api/v1/vmware/vpc/{vpc_id}/compute/instance/{instance_id}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
vpc_id
string 
required
instance_id
string 
required
Header Params
Accept
string 
required
Example:
application/json, text/plain, */*
OrgId
string 
required

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v1/vmware/vpc//compute/instance/' \
--header 'Accept: application/json, text/plain, */*' \
--header 'OrgId;'

Responses

🟢200Success
application/json
Body
id
string 
required
vpc_id
string 
required
created_at
string 
required
updated_at
null 
required
infra_created_at
string 
required
name
string 
required
status
string 
required
guest_os
string 
required
host_name
string 
required
ip_address
string 
required
number_of_cpus
integer 
required
memory_mb
integer 
required
network_name
string 
required
celery_task_id
null 
required
vmw_id
null 
required
log_iaas_vmw
null 
required
kubernetes_cluster_id
null 
required
kubernetes_role
null 
required
database_cluster_id
null 
required
database_role
null 
required
is_deployed
boolean 
required
is_locked
null 
required
display_name
string 
required
platform
null 
required
osp_id
string 
required
meta_data
object 
required
hidden
boolean 
required
resource_template_id
null 
required
zone_id
string 
required
contract_type
string 
required
status_action
null 
required
vm_group_id
null 
required
vGpuIds
array[string]
required
ip_address_external
null 
required
enabled_allocate_ip
boolean 
required
is_xplat_instance
boolean 
required
vm_group
null 
required
Example
{
    "id": "9d5b5f9a-9d8b-495b-992b-70e32ae23f85",
    "vpc_id": "aa0e66e0-3486-4724-a670-b5a4a758484e",
    "created_at": "2024-01-10T07:55:07",
    "updated_at": null,
    "infra_created_at": "2024-01-10T07:55:09",
    "name": "vm-24011025449-202411",
    "status": "POWERED_ON",
    "guest_os": "UBUNTU-16.04-10072023",
    "host_name": "vm-24011025449",
    "ip_address": "10.155.194.147",
    "number_of_cpus": 1,
    "memory_mb": 2048,
    "network_name": "subnet-7472",
    "celery_task_id": null,
    "vmw_id": null,
    "log_iaas_vmw": null,
    "kubernetes_cluster_id": null,
    "kubernetes_role": null,
    "database_cluster_id": null,
    "database_role": null,
    "is_deployed": true,
    "is_locked": null,
    "display_name": "vm-24011025449-202411",
    "platform": null,
    "osp_id": "32b2de34-13b5-4714-a6d5-f7d3d92dcf4c",
    "meta_data": {},
    "hidden": false,
    "resource_template_id": null,
    "zone_id": "2880d5b3-0383-45b5-b0ba-24863b7f00fd",
    "contract_type": "RESERVED",
    "status_action": null,
    "vm_group_id": null,
    "vGpuIds": [],
    "ip_address_external": null,
    "enabled_allocate_ip": true,
    "is_xplat_instance": false,
    "vm_group": null
}
Modified at 2024-01-15 19:00:34
Previous
List
Next
Security Group
Built with