# dnspod.client 库模块帮助文档

## dnspod 成员列表 <a id="dnspod" href="#dnspod">&#x23;</a>

### dnspod.client <a id="dnspod.client" href="#dnspod.client">&#x23;</a>
DNSPOD API客户端

### dnspod.client("DDNS Client/1.0.0") <a id="dnspod.client" href="#dnspod.client">&#x23;</a>
创建DNSPOD客户端

### dnspod.client() <a id="dnspod.client" href="#dnspod.client">&#x23;</a>
[返回对象:dnspoddclientObject](#dnspoddclientObject)

## dnspoddclientObject 成员列表 <a id="dnspoddclientObject" href="#dnspoddclientObject">&#x23;</a>

### dnspoddclientObject.domain <a id="dnspoddclientObject.domain" href="#dnspoddclientObject.domain">&#x23;</a>
域名操作接口

### dnspoddclientObject.domain.List <a id="dnspoddclientObject.domain.List" href="#dnspoddclientObject.domain.List">&#x23;</a>

```aardio
dnspoddclientObject.domain.List(  
	type = "all";  
	offset = 0;  
	group_id = 分组ID;  
	keyword = 搜索关键字;  
)
```

### dnspoddclientObject.domain.List() <a id="dnspoddclientObject.domain.List" href="#dnspoddclientObject.domain.List">&#x23;</a>
[返回对象:dnspoddomainlistObject](#dnspoddomainlistObject)

### dnspoddclientObject.domaingroup <a id="dnspoddclientObject.domaingroup" href="#dnspoddclientObject.domaingroup">&#x23;</a>
域名分组操作接口

### dnspoddclientObject.errorOnEmpty <a id="dnspoddclientObject.errorOnEmpty" href="#dnspoddclientObject.errorOnEmpty">&#x23;</a>
没有数据是否返回错误

### dnspoddclientObject.info <a id="dnspoddclientObject.info" href="#dnspoddclientObject.info">&#x23;</a>
信息接口

### dnspoddclientObject.info.Version() <a id="dnspoddclientObject.info.Version" href="#dnspoddclientObject.info.Version">&#x23;</a>
返回版本  

[返回对象:dnspodinfoversionObject](#dnspodinfoversionObject)

### dnspoddclientObject.lastResponse() <a id="dnspoddclientObject.lastResponse" href="#dnspoddclientObject.lastResponse">&#x23;</a>
获取最后一次服务器返回的原始数据,  
如果控制台已打开或在开发环境中导入console库则在控制台输出数据  
下载文件时该值为空

### dnspoddclientObject.monitor <a id="dnspoddclientObject.monitor" href="#dnspoddclientObject.monitor">&#x23;</a>
D监控操作接口

### dnspoddclientObject.record <a id="dnspoddclientObject.record" href="#dnspoddclientObject.record">&#x23;</a>
域名记录操作接口

### dnspoddclientObject.record.Ddns <a id="dnspoddclientObject.record.Ddns" href="#dnspoddclientObject.record.Ddns">&#x23;</a>

```aardio
dnspoddclientObject.record.Ddns(  
	domain_id = "域名ID";  
	record_id  = "记录ID";   
	record_line = "默认")
```

### dnspoddclientObject.record.Info <a id="dnspoddclientObject.record.Info" href="#dnspoddclientObject.record.Info">&#x23;</a>

```aardio
dnspoddclientObject.record.Info(  
	domain_id = "域名ID";  
	record_id  = "记录ID" )
```

### dnspoddclientObject.record.List <a id="dnspoddclientObject.record.List" href="#dnspoddclientObject.record.List">&#x23;</a>

```aardio
dnspoddclientObject.record.List(  
	domain_id = "域名ID";  
	offset = 0  
)
```

### dnspoddclientObject.restClient <a id="dnspoddclientObject.restClient" href="#dnspoddclientObject.restClient">&#x23;</a>
[返回对象:webRestClientObject](https://www.aardio.com/zh-cn/doc/library-reference/web/rest/client.html#webRestClientObject)

### dnspoddclientObject.telephoneverify <a id="dnspoddclientObject.telephoneverify" href="#dnspoddclientObject.telephoneverify">&#x23;</a>
手机验证接口

### dnspoddclientObject.telephoneverify.code <a id="dnspoddclientObject.telephoneverify.code" href="#dnspoddclientObject.telephoneverify.code">&#x23;</a>

```aardio
code(  
	telephone = "用户手机号码";)
```

### dnspoddclientObject.user <a id="dnspoddclientObject.user" href="#dnspoddclientObject.user">&#x23;</a>
用户账户接口

### dnspoddclientObject.user.Detail() <a id="dnspoddclientObject.user.Detail" href="#dnspoddclientObject.user.Detail">&#x23;</a>
返回用户信息  

[返回对象:dnspoduserdetailObject](#dnspoduserdetailObject)

### dnspoddclientObject.user.Log() <a id="dnspoddclientObject.user.Log" href="#dnspoddclientObject.user.Log">&#x23;</a>
返回用户日志  

[返回对象:dnspoduserlogObject](#dnspoduserlogObject)

### dnspoddclientObject.user.Modify <a id="dnspoddclientObject.user.Modify" href="#dnspoddclientObject.user.Modify">&#x23;</a>

```aardio
dnspoddclientObject.user.modify(  
	real_name = "真实姓名";  
	nick = "用户称呼";  
	telephone = "用户手机号码";  
	im = "用户qq";  
)
```

### dnspoddclientObject.userEmail <a id="dnspoddclientObject.userEmail" href="#dnspoddclientObject.userEmail">&#x23;</a>
登录邮箱

### dnspoddclientObject.userId <a id="dnspoddclientObject.userId" href="#dnspoddclientObject.userId">&#x23;</a>
代理ID

### dnspoddclientObject.userPassword <a id="dnspoddclientObject.userPassword" href="#dnspoddclientObject.userPassword">&#x23;</a>
登录密码

### dnspoddclientObject.userToken <a id="dnspoddclientObject.userToken" href="#dnspoddclientObject.userToken">&#x23;</a>
登录令牌  
https://support.dnspod.cn/Kb/showarticle/tsid/227/

### dnspoddclientObject.useremail <a id="dnspoddclientObject.useremail" href="#dnspoddclientObject.useremail">&#x23;</a>
用户邮箱接口

### dnspoddclientObject.useremail.Modify <a id="dnspoddclientObject.useremail.Modify" href="#dnspoddclientObject.useremail.Modify">&#x23;</a>

```aardio
dnspoddclientObject.useremail.modify(  
	old_email = "旧邮箱";  
	new_email = "新邮箱";  
	password = "当前密码";)
```

### dnspoddclientObject.userpasswd <a id="dnspoddclientObject.userpasswd" href="#dnspoddclientObject.userpasswd">&#x23;</a>
用户密码接口

### dnspoddclientObject.userpasswd.Modify <a id="dnspoddclientObject.userpasswd.Modify" href="#dnspoddclientObject.userpasswd.Modify">&#x23;</a>

```aardio
dnspoddclientObject.userpasswd.modify(  
	old_password = "旧密码";  
	new_password = "新密码";)
```

## dnspoddomainlistObject 成员列表 <a id="dnspoddomainlistObject" href="#dnspoddomainlistObject">&#x23;</a>

### dnspoddomainlistObject.domains <a id="dnspoddomainlistObject.domains" href="#dnspoddomainlistObject.domains">&#x23;</a>
域名列表,数组

### dnspoddomainlistObject.info <a id="dnspoddomainlistObject.info" href="#dnspoddomainlistObject.info">&#x23;</a>
域名统计信息

### dnspoddomainlistObject.status <a id="dnspoddomainlistObject.status" href="#dnspoddomainlistObject.status">&#x23;</a>
状态  

[返回对象:dnspodstatusObject](#dnspodstatusObject)

## dnspodinfoversionObject 成员列表 <a id="dnspodinfoversionObject" href="#dnspodinfoversionObject">&#x23;</a>

### dnspodinfoversionObject.status <a id="dnspodinfoversionObject.status" href="#dnspodinfoversionObject.status">&#x23;</a>
状态  

[返回对象:dnspodstatusObject](#dnspodstatusObject)

## dnspodstatusObject 成员列表 <a id="dnspodstatusObject" href="#dnspodstatusObject">&#x23;</a>

### dnspodstatusObject.code <a id="dnspodstatusObject.code" href="#dnspodstatusObject.code">&#x23;</a>
1为成功

### dnspodstatusObject.created_at <a id="dnspodstatusObject.created_at" href="#dnspodstatusObject.created_at">&#x23;</a>
创建时间

### dnspodstatusObject.message <a id="dnspodstatusObject.message" href="#dnspodstatusObject.message">&#x23;</a>
消息

## dnspoduserdetailObject 成员列表 <a id="dnspoduserdetailObject" href="#dnspoduserdetailObject">&#x23;</a>

### dnspoduserdetailObject.info.user <a id="dnspoduserdetailObject.info.user" href="#dnspoduserdetailObject.info.user">&#x23;</a>
用户信息  

[返回对象:dnspoduserinfoObject](#dnspoduserinfoObject)

### dnspoduserdetailObject.status <a id="dnspoduserdetailObject.status" href="#dnspoduserdetailObject.status">&#x23;</a>
状态  

[返回对象:dnspodstatusObject](#dnspodstatusObject)

## dnspoduserinfoObject 成员列表 <a id="dnspoduserinfoObject" href="#dnspoduserinfoObject">&#x23;</a>

### dnspoduserinfoObject.agent_pending <a id="dnspoduserinfoObject.agent_pending" href="#dnspoduserinfoObject.agent_pending">&#x23;</a>
是否正在申请成为代理

### dnspoduserinfoObject.balance <a id="dnspoduserinfoObject.balance" href="#dnspoduserinfoObject.balance">&#x23;</a>
账号余额

### dnspoduserinfoObject.email <a id="dnspoduserinfoObject.email" href="#dnspoduserinfoObject.email">&#x23;</a>
用户账号, 邮箱格式

### dnspoduserinfoObject.email_verified <a id="dnspoduserinfoObject.email_verified" href="#dnspoduserinfoObject.email_verified">&#x23;</a>
邮箱是否通过验证  
"yes" 通过  
"no" 未通过

### dnspoduserinfoObject.id <a id="dnspoduserinfoObject.id" href="#dnspoduserinfoObject.id">&#x23;</a>
用户 ID, 即为 user_id

### dnspoduserinfoObject.nick <a id="dnspoduserinfoObject.nick" href="#dnspoduserinfoObject.nick">&#x23;</a>
用户昵称

### dnspoduserinfoObject.real_name <a id="dnspoduserinfoObject.real_name" href="#dnspoduserinfoObject.real_name">&#x23;</a>
用户名称, 企业用户对应为公司名称

### dnspoduserinfoObject.smsbalance <a id="dnspoduserinfoObject.smsbalance" href="#dnspoduserinfoObject.smsbalance">&#x23;</a>
剩余短信条数

### dnspoduserinfoObject.status <a id="dnspoduserinfoObject.status" href="#dnspoduserinfoObject.status">&#x23;</a>
账号状态  
"enabled" 正常  
"disabled" 被封禁

### dnspoduserinfoObject.telephone <a id="dnspoduserinfoObject.telephone" href="#dnspoduserinfoObject.telephone">&#x23;</a>
电话号码

### dnspoduserinfoObject.telephone_verified <a id="dnspoduserinfoObject.telephone_verified" href="#dnspoduserinfoObject.telephone_verified">&#x23;</a>
手机是否通过验证  
"yes" 通过  
"no" 未通过

手机是否通过验证  
"yes" 通过  
"no" 未通过

### dnspoduserinfoObject.user_grade <a id="dnspoduserinfoObject.user_grade" href="#dnspoduserinfoObject.user_grade">&#x23;</a>
账号等级

### dnspoduserinfoObject.user_type <a id="dnspoduserinfoObject.user_type" href="#dnspoduserinfoObject.user_type">&#x23;</a>
账号类型  
"personal" 个人用户  
"enterprise" 企业用户

### dnspoduserinfoObject.weixin_binded <a id="dnspoduserinfoObject.weixin_binded" href="#dnspoduserinfoObject.weixin_binded">&#x23;</a>
是否绑定微信  
"yes" 已绑定  
"no" 未绑定

## dnspoduserlogObject 成员列表 <a id="dnspoduserlogObject" href="#dnspoduserlogObject">&#x23;</a>

### dnspoduserlogObject.log <a id="dnspoduserlogObject.log" href="#dnspoduserlogObject.log">&#x23;</a>
日志,数组值

### dnspoduserlogObject.status <a id="dnspoduserlogObject.status" href="#dnspoduserlogObject.status">&#x23;</a>
状态  

[返回对象:dnspodstatusObject](#dnspodstatusObject)
