# 获取域名记录 - DescribeUDNSRecord

## 简介

获取域名记录





## 定义

### 公共参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Action**     | string  | 对应的 API 指令名称，当前 API 为 `DescribeUDNSRecord`                        | **Yes** |
| **PublicKey**  | string  | 用户公钥，可从 [控制台](https://console.nubexcloud.com/uaccount/api_manage) 获取                                             | **Yes** |
| **Signature**  | string  | 根据公钥及 API 指令生成的用户签名，参见 [签名算法](/docs/api/summary/signature.md)  | **Yes** |

### 请求参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Region** | string | 地域。 参见 [地域和可用区列表](/docs/api/summary/regionlist) |**Yes**|
| **ProjectId** | string | 项目ID。不填写为默认项目，子帐号必须填写。 请参考[GetProjectList接口](/docs/api/summary/get_project_list) |No|
| **DNSZoneId** | string | 域名资源ID |**Yes**|
| **RecordIds.N** | string | 域名记录资源ID |No|
| **Limit** | int | 数据分页值, 默认为20 |No|
| **Offset** | int | 数据偏移量, 默认为0 |No|
| **Query** | string | 模糊查询记录 |No|
| **SortKey** | string | 排序字段，只支持host update_time |No|
| **SortDir** | string | 排序方式，支持asc desc |No|

### 响应字段

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **RetCode** | int | 返回状态码，为 0 则为成功返回，非 0 为失败 |**Yes**|
| **Action** | string | 操作指令名称 |**Yes**|
| **Message** | string | 返回错误消息，当 `RetCode` 非 0 时提供详细的描述信息 |No|
| **TotalCount** | int | 资源数量 |**Yes**|
| **RecordInfos** | array[[*RecordInfo*](#RecordInfo)] | 域名记录详细信息 |No|

#### 数据模型


#### RecordInfo

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **RecordId** | string | 域名记录资源ID |**Yes**|
| **Name** | string | 主机记录 |**Yes**|
| **Type** | string | 记录类型 |**Yes**|
| **ValueSet** | array[[*ValueSet*](#ValueSet)] | 数值组 |**Yes**|
| **ValueType** | string | 记录策略，标准或随机应答 |**Yes**|
| **TTL** | int | TTL值，单位为秒 |**Yes**|
| **Remark** | string | 记录备注信息 |**Yes**|

#### ValueSet

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Data** | string | 主机记录 |**Yes**|
| **Weight** | int | 权重 |**Yes**|
| **IsEnabled** | int | 是否启用 |**Yes**|

## 示例

### 请求示例
    
```
https://api.nubexcloud.com/?Action=DescribeUDNSRecord
&Region=cn-zj
&ProjectId=torSzOaN
&DNSZoneId=fiKbocKl
&RecordIds.n=uOTGqytm
&Limit=4
&Offset=2
&Query=EfESmWxu
&SortKey=cDsGuJpe
&SortDir=bQEtRYsz
```

### 响应示例
    
```json
{
  "Action": "DescribeUDNSRecordResponse",
  "RecordInfos": [
    {
      "Name": "TYnDJcuL",
      "RecordId": "PguQqgHJ",
      "Remark": "lfvTkeVr",
      "TTL": 2,
      "Type": "UntNZFYV",
      "ValueSet": [
        {
          "Data": "brLlcbYu",
          "IsEnabled": 4,
          "Weight": 7
        }
      ],
      "ValueType": "OcQtDdXd"
    }
  ],
  "RetCode": 0,
  "TotalCount": 3
}
```