# Get Domain Allowlist - GetNapAllowListDomain

## Overview

Get Domain Allowlist






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `GetNapAllowListDomain`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.genesissai.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 |
|:---|:---|:---|:---|
| **ResourceId** | string | Resource ID |**Yes**|
| **Domain** | string | Get specified domain information |No|
| **DomainLike** | string | Domain Name Fuzzy Search |No|
| **Offset** | int | List start position offset, default is 0 |No|
| **Limit** | int | Return data length, default is 1000 |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|
| **TotalCount** | int | Total number of list entries |**Yes**|
| **DomainList** | array[[*BlockAllowDomainEntry*](#blockallowdomainentry)] | Domain Allowlist |**Yes**|

#### Data Model


#### BlockAllowDomainEntry

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Domain** | string | Domain Name |**Yes**|
| **CreateTime** | int | Create timestamp, for example: 1581991500 |**Yes**|
| **Remark** | string | Note |**Yes**|
| **Status** | int | Status; 1: Adding, 2: Success, 3: Deleting, 4: Failed, 5: Deleted |**Yes**|

## Example

### Request Example
    
```
https://api.genesissai.com/?Action=GetNapAllowListDomain
&ResourceId=uUDYRKta
&Domain=ucloud.cn
&Offset=0
&Limit=10
```

### Response Example
    
```json
{
  "Action": "GetNapAllowListDomainResponse",
  "DomainList": [
    {
      "CreateTime": 1597126079,
      "Domain": "ucloud.cn",
      "Remark": "",
      "Status": 2
    }
  ],
  "RetCode": 0,
  "TotalCount": 1
}
```