# Obtain Domain Information - DescribeUDNSZone

## Overview

Obtain Domain Information






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `DescribeUDNSZone`.                      | **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 |
|:---|:---|:---|:---|
| **Region** | string | Region. See [List of Regions and Availability Zones](/docs/api/summary/regionlist) |**Yes**|
| **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). |No|
| **DNSZoneIds.N** | string | Domain Resource ID |No|
| **Limit** | int | Data pagination value, default is 20 |No|
| **Offset** | int | Data offset, default is 0 |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 | The number of domain names that meet the search criteria |**Yes**|
| **DNSZoneInfos** | array[[*ZoneInfo*](#zoneinfo)] | Domain Resource Information |No|

#### Data Model


#### ZoneInfo

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **DNSZoneName** | string | Domain Name |**Yes**|
| **DNSZoneId** | string | UDNS Zone ID |**Yes**|
| **Tag** | string | Business Group |**Yes**|
| **Remark** | string | Note |**Yes**|
| **IsRecursionEnabled** | string | Does it support iteration. Enumeration value, "enable", supports iteration; "disable", does not support iteration. |**Yes**|
| **CreateTime** | int | Creation Time |**Yes**|
| **ExpireTime** | int | Expiration Time |**Yes**|
| **ChargeType** | string | Billing Type (Dynamic, Month, Year) |**Yes**|
| **IsAutoRenew** | string | Enable automatic renewal (Yes No) |**Yes**|
| **RecordInfos** | array[string] | Record Related ID |No|
| **VPCInfos** | array[[*VPCInfo*](#vpcinfo)] | Bound VPC Information |No|

#### VPCInfo

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **VPCId** | string | VPC ID |No|
| **VPCProjectId** | string | Project ID to which VPC belongs |No|
| **Name** | string | VPC Name |No|
| **Network** | array[string] | VPC Address Space |No|
| **VPCType** | string | VPC Type: Normal Public Cloud Hybrid Managed Cloud |No|

## Example

### Request Example
    
```
https://api.sigcalcloud.com/?Action=DescribeUDNSZone
&Region=cn-zj
&ProjectId=ZTJsiwYH
&DNSZoneIds.n=ZquihhVy
&Limit=8
&Offset=2
```

### Response Example
    
```json
{
  "Action": "DescribeUDNSZoneResponse",
  "DNSZoneInfos": [
    {
      "ChargeType": "oURoNXte",
      "CreateTime": 2,
      "DNSZoneName": "uOEUdzku",
      "ExpireTime": 5,
      "IsAutoRenew": "VhFoLqxZ",
      "IsRecursionEnabled": "yhBRgEYF",
      "RecordInfos": [
        "KFJzEyvd"
      ],
      "Remark": "pKmgGIuE",
      "Tag": "EukQTqZJ",
      "VPCInfos": [
        {
          "Name": "cRAQsXAx",
          "Network": [
            "bISdvCpi"
          ],
          "VPCId": "NQaNNAyK",
          "VPCProjectId": "eITXvWzB",
          "VPCType": "YRTvvfEZ"
        }
      ]
    }
  ],
  "RetCode": 0,
  "TotalCount": 5
}
```