# Bind CPE - BindCPE

## Overview

Bind CPE






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `BindCPE`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.an-link.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. Leave it blank for the default project. Sub-accounts must fill in. Please refer to the [GetProjectList API](/docs/api/summary/get_project_list) |**Yes**|
| **CPEId** | string | cpe id |**Yes**|
| **Sn** | string | sn id |**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.an-link.com/?Action=BindCPE
&ProjectId=GwDIiuya
&RequestID=dYIOkbzl
&Name=xZBuUZms
&Remark=HvvRkrSg
&Sn=KbenKTsC
```

### Response Example
    
```json
{
  "Action": "BindCPEResponse",
  "CPEId": "vZchfUHK",
  "Message": "GNkRuWCk",
  "RetCode": 0
}
```