# Create GlobalSSH Instance - CreateGlobalSSHInstance

## Overview

Create GlobalSSH Instance



 > ℹ️ There is a quota limit for the entry-level GlobalSSH instances under a single project.


## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `CreateGlobalSSHInstance`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.scloudsg.com/uaccount/api_manage)                                             | **Yes** |
| **Signature**  | string  | User signature generated based on public key and API command, see [Signature Algorithm](/docs/api/summary/signature.md)  | **Yes** |

### Request Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **ProjectId** | string | Project ID, such as org-xxxx. Please refer to [GetProjectList interface](/docs/api/summary/get_project_list) |**Yes**|
| **Area** | string | Enter the name of the region that supports SSH access, such as "Los Angeles", "Singapore", "Hong Kong", "Tokyo", "Washington", "Frankfurt", "Seoul". Either Area or AreaCode must be filled in. |**Yes**|
| **TargetIP** | string | The origin IP accessed by SSH, only supports IPv4 address. |**Yes**|
| **Port** | int | The SSH port that the source server listens to, can be in the range [1-65535], cannot use ports 80, 443, 65123. If InstanceType=Free, the range narrows to [22,3389], choose 22 for Linux systems, and Windows systems automatically select 3389. |**Yes**|
| **AreaCode** | string | AreaCode, the universal international code for regional airports. Either Area or AreaCode must be filled in. |**Yes**|
| **Remark** | string | Note Information |No|
| **ChargeType** | string | Payment methods, such as Monthly: Month, Yearly: Year, Hourly: Dynamic |No|
| **Quantity** | int | Purchase Quantity<br />For purchases until the end of the month, please pass 0 |No|
| **InstanceType** | string | Enumeration values: ["Ultimate","Enterprise","Basic","Primary"], representing Flagship Edition, Enterprise Edition, Basic Edition, and Starter Edition respectively. |No|
| **BandwidthPackage** | int | Bandwidth package size for the Ultimate version, enumeration values: [0,20,40]. Unit MB |No|
| **ForwardRegion** | string | When InstanceType equals to Basic, you can choose one from ["cn-bj2","cn-sh2","cn-gd"] as the forwarding data center, other paid versions are configured with three default forwarding data centers. |No|
| **CouponId** | string | Using vouchers can offset part of the cost. |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|
| **InstanceId** | string | Instance ID, Unique Resource Identifier |**Yes**|
| **AcceleratingDomain** | string | Accelerated domain name, accessing this domain name allows for nearby access. |No|




## Example

### Request Example
    
```
https://api.scloudsg.com/?Action=CreateGlobalSSHInstance
&ProjectId=org-xxxx
&Remark=备注
&Area=洛杉矶
&TargetIP=1.1.2.2
&Port=22
&CouponId=coupon-123
&ChargeType=Year
&Quantity=1
&AreaCode=LAX
&InstanceType=Basic
&BandwidthPackage=5
&ForwardRegion=UKclgoRu
```

### Response Example
    
```json
{
  "AcceleratingDomain": "1.1.2.2.ipssh.net",
  "Action": "CreateGlobalSSHInstanceResponse",
  "InstanceId": "uga-xxxx",
  "Message": "",
  "RetCode": 0
}
```