Get ULightHost List - DescribeULHostInstance


Get ULightHost List


Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is DescribeULHostInstance.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See List of Regions and Availability ZonesYes
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.No
ULHostIds.Nstring[Array] ULightHost ID.No
OffsetintList start position offset, default is 0No
LimitintReturn data length, default is 20, maximum 100No

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
ULHostInstanceSetsarray[ULHostInstanceSet]Instance ListYes

Data Model


Field NameTypeDescription InformationRequired
ZonestringAvailability Zone.No
ULHostIdstringInstance Id.No
NamestringInstance name. Default package IdNo
TagstringBusiness Group.No
ImageIdstringImage Id.No
ImageNamestringImage Name.No
Appsarray[string][Array] The list of applications included in the image.No
CPUintNumber of CPU cores.No
MemoryintMemory. Unit: MBNo
StatestringInstance status. Enumerated values:

>Initializing: Initializing;

>Starting: Starting;

> Running: Running;

> Stopping: Stopping;

>Stopped: Stopped

>Install Fail: Install Fail;

>Rebooting: Rebooting;

> Unknown (empty string, status acquisition timeout or error):
ChargeTypestringBilling Mode. Enumerated values: Month/YearNo
IPSetarray[UHostIPSet]IP InformationNo
DiskSetarray[ULHostDiskSet]Disk InformationNo
AutoRenewstringWhether to renew automatically. Enumerated values: Yes/NoNo
IsExpirestringIs it expired. Enumeration value: Yes/NoNo
ExpireTimeintExpiration time. Unix timestamp.No
CreateTimeintCreation Time. Unix Timestamp.No


Field NameTypeDescription InformationRequired
DefaultstringUnder the Private type of the internal network, it indicates whether it is the default network card. true: it is the default network card; other values: no.No
MacstringUnder the Private type of Intranet, the current network card's Mac.No
WeightintThe current weight of the EIP. The one with the highest weight is the current exit IP.No
TypestringInternational: International, BGP: Bgp, Private Network: PrivateNo
IPIdstringPublic IP Resource ID. (Internal IP does not have a corresponding Resource ID)No
IPstringIP AddressNo
BandwidthintBandwidth corresponding to the IP, unit: Mb (Bandwidth information is not displayed for internal IP)No
VPCIdstringThe VPC ID corresponding to the IP address. (Not supported in Beijing 1, the field returns empty)No
SubnetIdstringThe subnet ID corresponding to the IP address. (Not supported in Beijing 1, the field will return empty)No
NetworkInterfaceIdstringWhen the elastic network card is the default network card, return the corresponding ID value.No


Field NameTypeDescription InformationRequired
DiskIdstringDisk IdNo
DiskTypestringDisk type. Such as: "CLOUD_RSSD", "CLOUD_SSD".No
TypestringDisk Type. System Disk: "Boot"; Data Disk: "Data".No
SizeintDisk size. Unit: GBNo
IsBootstringIs it a system disk. Yes: "True"; No: "False".No
DrivestringDisk drive letter. System disk: "vda".No


Request Example

Response Example

  "Action": "DescribeULHostInstanceResponse",
  "Message": "GmrflzlM",
  "RetCode": 0,
  "ULHostInstanceSets": [
      "AutoRenew": "PyPNLqBH",
      "CPU": 1,
      "ChargeType": "hauEukUs",
      "CreateTime": 7,
      "DiskSet": [
          "BackupType": "xHWomUhO",
          "DiskId": "MWvyrUwR",
          "DiskType": "IRrEynyl",
          "Drive": "RvmLbdKX",
          "Encrypted": "cNyCMNmT",
          "IsBoot": "tvSzSraj",
          "Name": "vsfpLPyr",
          "Size": 3,
          "Type": "UkyaHXBR"
      "ExpireTime": 5,
      "IPSet": [
          "Bandwidth": 2,
          "Default": "AnzSfoBi",
          "IP": "EOmBPJZd",
          "IPId": "vnrKbtka",
          "IPMode": "pWfqUmBy",
          "Mac": "DggLGvKF",
          "NetworkInterfaceId": "oTgcJktO",
          "SubnetId": "RfEGLEoc",
          "Type": "BVSGfRvP",
          "VPCId": "lrFLnZeF",
          "Weight": 9
      "IsExpire": "dQxEsaLW",
      "Memory": 7,
      "Name": "jsqzqDEj",
      "Remark": "tJoNHAEH",
      "State": "CagCpoZQ",
      "Tag": "zQppWJxb",
      "ULHostId": "hcquybJV"
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved
  • Contact our sales to help your business.
  • Contact our sales to help your business.