# Join Instance to UGN - AttachUGNInstance

## Overview

Join Instance to UGN






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `AttachUGNInstance`.                      | **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. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the [GetProjectList interface](/docs/api/summary/get_project_list). |**Yes**|
| **UGNId** | string | UGN Id |**Yes**|
| **InstanceId** | string | Instance Id |**Yes**|
| **InstanceType** | string | Instance Type |**Yes**|
| **InstanceRegion** | string | Instance Region |**Yes**|
| **InstanceProjectId** | string | Instance belongs to ProjectId |**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.scloudsg.com/?Action=AttachUGNInstance
&ProjectId=BaWJrGAB
&UGNId=OxUOKFwy
&InstanceId=jgBAcojQ
&InstanceType=vpc
&InstanceRegion=PIAwXWul
&InstanceProjectId=ldBNTCAs
```

### Response Example
    
```json
{
  "Action": "AttachUGNInstanceResponse",
  "Message": "success",
  "RetCode": 0
}
```