# Obtain DDoS Protection Service Information - DescribeNapServiceInfo

## Overview

Obtain DDoS Protection Service Information






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `DescribeNapServiceInfo`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.sigcalcloud.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. Please refer to the [GetProjectList interface](/docs/api/summary/get_project_list). |No|
| **ResourceId** | string | Resource ID |No|
| **Offset** | int | List start position offset, default is 0 |No|
| **Limit** | int | Return data length, default is 10 |No|
| **NapType** | int | DDoS Protection Type; 0: All, 1: Mainland DDoS Protection, 2: Overseas DDoS Protection |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|
| **ServiceInfo** | array[[*ServiceInfo*](#serviceinfo)] | UDH Information |No|
| **TotalCount** | int | Total |No|

#### Data Model


#### ServiceInfo

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **ProjectId** | string | Project ID |No|
| **ResourceId** | string | Resource ID |No|
| **CreateTime** | int | Creation Time |No|
| **ExpiredTime** | int | Expiration Time |No|
| **DefenceDDosMaxFlowArr** | array[int] | Maximum Protection Group Package |No|
| **DefenceDDosBaseFlowArr** | array[int] | Basic Protection Group Package |No|
| **AutoRenew** | string | Is auto-renewal enabled? |No|
| **RegionId** | int | Region ID |No|
| **DefenceType** | string | Protection Type |No|
| **ChargeType** | string | Payment Type |No|
| **DefenceStatus** | string | Protection Status, Started: Normal, Stopped: Closed, Expired: Expired |No|
| **Name** | string | Package Name |No|
| **LineType** | string | Line Type |No|
| **EngineRoom** | array[string] | Protection Room Name |No|
| **AreaLine** | string | Protection Room Location |No|
| **SrcBandwidth** | int | Business Bandwidth |No|
| **GameId** | int | Package ID |No|
| **Vendor** | int | Vendor ID |No|
| **AccessMode** | string | Access mode, Domain: Website access, IP: Non-website access |No|
| **ForwardType** | string | Forwarding Type, Proxy: Proxy, Passthrough: Direct Connection |No|
| **NapType** | int | High Defense Type, 1: Mainland High Defense, 2: Overseas High Defense |No|

## Example

### Request Example
    
```
https://api.sigcalcloud.com/?Action=DescribeNapServiceInfo
&ResourceId=XaOcJuwP
&Offset=2
&Limit=5
&NapType=9
&ProjectId=RuuWyHRU
```

### Response Example
    
```json
{
  "Action": "DescribeNapServiceInfoResponse",
  "RetCode": 0,
  "ServiceInfo": "hQBZmVBD",
  "TotalCount": 6
}
```