Modify GlobalSSH Port - ModifyGlobalSSHPort

Overview

Modify GlobalSSH Port

ℹ️ The free version of globalssh does not support port modification; the basic and enterprise versions support port modification; the beta free version retains the port modification feature.

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `ModifyGlobalSSHPort`.	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 identifier for the resource. Currently, only the paid version of GlobalSSH instances can modify the port.	Yes
Port	int	The SSH port number that the origin server listens to. The port range for the paid version is [1,65535] and cannot be 80, 443, 65123 ports. The free version does not support port modification.	Yes

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

Example

Request Example

https://api.surfercloud.com/?Action=ModifyGlobalSSHPort
&InstanceId=uga-xxxx
&Port=22
&ProjectId=org-xxx

Response Example

{
  "Action": "ModifyGlobalSSHPortResponse",
  "Message": "bhTSuqGO",
  "RetCode": 0
}

ModifyGlobalSSHOriginInfo ModifyGlobalSSHRemark