Get GlobalSSH Instance List - DescribeGlobalSSHInstance

Overview

Retrieve GlobalSSH instance list (pass instance ID to get individual instance information, no pass to get all instances under the project)

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeGlobalSSHInstance`.	Yes
PublicKey	string	The user's public key can be obtained from Console (opens in a new tab)	Yes
Signature	string	User signature generated based on public key and API command, see Signature Algorithm	Yes

Request Parameters

Parameter Name	Type	Description Information	Required
ProjectId	string	Project ID, such as org-xxxx. Please refer to GetProjectList interface	Yes
InstanceId	string	Instance ID, Unique Resource Identifier	No

Response Field

Field Name	Type	Description Information	Required
RetCode	int	Return status code. If it is 0, it means successful return. If it is not 0, it means failure.	Yes
Action	string	Operation command name.	Yes
Message	string	Returns an error message, providing detailed description when `RetCode` is non-zero.	No
InstanceSet	array[GlobalSSHInfo]	List of GlobalSSH instances, refer to the GlobalSSHInfo model for instance attributes.	No

Data Model

GlobalSSHInfo

Field Name	Type	Description Information	Required
InstanceId	string	Instance ID, Unique Resource Identifier	Yes
InstanceType	string	Enumeration values: ["Enterprise","Basic","Free","Welfare"], representing Enterprise Edition, Basic Version, Free Version, and earlier public beta free version respectively.	Yes
AcceleratingDomain	string	The acceleration domain name assigned by GlobalSSH.	Yes
Area	string	Region of the IP being accessed by SSH	Yes
TargetIP	string	The origin IPv4 address accessed by SSH.	Yes
Remark	string	Note Information	Yes
Port	int	The SSH port monitored by the origin server, RDP port for Windows system	Yes
GlobalSSHPort	int	When InstanceType equals to Free, it is automatically assigned by the system and does not equal to the value of the source station Port. When InstanceType does not equal to Free, it is the same as the value of the source station Port.	Yes
ChargeType	string	Payment cycle, such as Month, Year, Dynamic, etc.	Yes
CreateTime	int	Resource Creation Timestamp	Yes
ExpireTime	int	Resource Expiration Timestamp	Yes
Expire	boolean	Is it expired?	Yes
IPV6Access	boolean	Is EIP IPV6 access enabled, Flase: not enabled	No
ExtraDomain	array[string]	List of other available acceleration domain names assigned by GlobalSSH	No
BandwidthPackage	int	globalssh Ultimate Bandwidth Package Size	No
ForwardRegion	string	When the InstanceType is the Basic version, the specific assigned forwarding data center needs to be displayed.	No
DomainStatus	object	Acceleration domain current availability detection result HashMap structure 0 indicates available, 1 indicates contamination.	No

Example

Request Example

https://api.surfercloud.com/?Action=DescribeGlobalSSHInstance
&ProjectId=UjsPseDf
&InstanceId=djsjuLQU

Response Example

{
  "Action": "DescribeGlobalSSHInstanceResponse",
  "InstanceSet": [
    {
      "AcceleratingDomain": "muLRknRb",
      "Area": "rojJRrWD",
      "BandwidthPackage": 5,
      "ChargeType": "Year",
      "CreateTime": 4,
      "DomainStatus": {},
      "Expire": true,
      "ExpireTime": 7,
      "ExtraDomain": [
        "JSweMMIB"
      ],
      "ForwardRegion": "yBKumXLK",
      "GlobalSSHPort": 5,
      "IPV6Access": false,
      "InstanceId": "jUtFMSnm",
      "InstanceType": "ZpSbjafD",
      "Port": 2,
      "Remark": "mtRmapTE",
      "TargetIP": "OhMnFNvq"
    }
  ],
  "RetCode": 0
}

DeleteUPath DescribePathXLineConfig