阳光互联域名和主机API接口.docx
《阳光互联域名和主机API接口.docx》由会员分享，可在线阅读，更多相关《阳光互联域名和主机API接口.docx（27页珍藏版）》请在冰豆网上搜索。
阳光互联域名和主机API接口
上海有孚
域名API接口说明文档
作者:
sundns
发行日期：
2010/05/10
前言
本文档描述了上海有孚域名注册API接口协议。
本文档描述了基本的数据交换标准，其中包括数据格式，数据定义，以及一些相关约定。
目录
1．API接口地址3
2．参数说明3
2．1公共参数3
2．2行为参数（action）4
2.2.1域名类4
2.2.1.1域名注册4
2.2.1.2修改联系人7
2.2.1.3域名续费8
2.2.1.4注册主机（创建域名服务器）9
2.2.1.5修改解析服务器（域名DNS修改）9
2.2.1.6修改域名密码9
2.2.1.7修改主机IP（修改域名服务器IP）10
2.2.1.8域名转入10
2.2.1.9域名解析10
2.2.1.9.1显示域名当前解析记录10
2.2.1.9.2增加域名解析记录11
2.2.1.9.3删除域名解析记录12
2.2.1.9.4修改域名解析记录13
2.2.1.9.5购买解析记录条数13
2.2.1.10显示域名信息13
2.2.1.11参数限制15
2.2.1.11.1Cn域名以及国内中文域名15
2.2.2虚拟主机类15
2.2.2.1虚拟主机购买15
2.2.2.2虚拟主机续费16
2.2.2.4.3修改主机管理密码（FTP密码）17
1．API接口地址
接口采用HTTP，POST协议：
正式URL：
管理域名的URL:
调用说明：
接口使用阳光互联分销商级别的数字ID（以下本文档简称为数字ID），即可调用。
测试URL：
注意：
使用测试URL时请使用如下参数：
数字ID，即userid：
1
用户密码：
111111
email：
test@
2．参数说明
2．1公共参数
注：
所有各参数字符集为gb2312
以下参数是在访问接口时必须提供的，否则服务器直接返回错误信息。
序号
名称
说明
类型（长度）
备注
1
Userid
阳光互联数字ID
常量（6位数字）
阳光互联数字ID
2
Userstr
md5（
数字ID
用户密码
email
vtime
）
常量（32位字符）
md5，API认证函数
数字ID（阳光互联数字ID）
用户密码（ID密码）
邮箱（ID下邮箱）
vtime为12位字符
例如当前时间是：
2006年8月30日8点15分
vtime=200608300815
四项值依顺序连接,通过md5函数处理后，userstr值为32位的字符串。
3
Category
domain
常量
产品类别为域名
host
产品类别为主机
mail
产品类别为邮箱
all
业务操作类，不具体产品类别
4
Action
操作行为
常量
根据不同功能，提供不同的数值，下面有详细说明。
5
Vtime
vtime为12位字符
例如当前时间是：
2006年8月30日8点15分
vtime=200608300815
注:
服务器时间与北京时间相同
6
Sourceid
业务请求序号
字符（16位）
业务请求序号，用于标识每次业务请求的序号，此值必须唯一。
2．2行为参数（action）
根据不同功能，选择不同的行为数值，每次调用只能选择一种行为。
2.2.1域名类
2.2.1.1域名注册
action=activate
详细参数列表：
注：
所有参数名称中英文字母都是小写
另注:
国内域名请按下列红字提醒添加购买后提示!
“您的域名刚提交成功，只有通过域名注册管理机构CNNIC的审核才表时您的域名正式注册成功。
请您确保域名正式注册成功后再提交续费，否则因为CNNIC审核不通过而删除域名，将不退还续费的费用。
我们建议您在新域名成功15日后再提交续费。
给您带来不便之处，敬请谅解。
”
（此操作是收费的）
参数名
说明
类型（长度）
备注
domain
标准域名。
字符串（3－60）
例：
domainpwd
域名口令
字符串（3－16）
数字及英文字母
vyear
注册年数
数字
dns1
第一个解析服务器
服务器地址
默认为阳光互联：
dns2
第二个解析服务器
服务器地址
默认为阳光互联：
productid
cn
com
cnch
comch
name
mobi
biz
info
cc
tv
ccch
tvch
bizch
asia
me
tel
常量
CN英文域名（国内英文域名）
国际英文域名
国内中文域名
国际中文域名
name域名
.mobi域名
.biz域名
.info域名
.cc域名
.tv域名
中文.cc域名
中文.tv域名
中文.biz域名
国际asia域名
注：
域名后缀请见附件1
注册人信息开始
address_en
英文地址
字符串（1－255）
英文类域名需要，包括：
国际英文域名
国际中文域名
.name域名
.mobi域名
.biz域名
.info域名
.cc域名
.tv域名
非此八类域名，即中文域名不需要
firstname
英文名
字符串（1－50）
lastname
英文姓
字符串（1－50）
organization_en
英文单位名称（域名所有人）
字符串（1－255）
city
英文城市
字符串（1－255）
state
英文省份
字符串（1－255）
address_zh
地址（中文）
字符串（1－255）
中文类域名需要，包括：
CN英文域名
国内中文域名
非此两类域名，即英文类域名时此5个参数为可选参数。
name
联系人姓名（中文）
字符串（1－16）
organization_zh
单位名称（中文）（域名所有人）
字符串（1－255）
ccity
城市（中文）
字符串（1－255）
cstate
省份（中文）
字符串（1－255）
manager
单位法人（注册人需要）
字符串（1－16）
中文类域名需要，包括：
CN英文域名
国内中文域名
organization_type
单位所属行业（只有注册人需要）
详细代码见附3
注：
必须按附3格式传值
字符串（1－16）
postcode
邮政编码
数字（6）
country
国家代码
字符串
（2）
中国为CN,更多请见附2
phone
国家代码-区号电话号-分机
数字以-分隔（30）
-010********
分机可选
注：
必须按此格式传值
4位-12位-6位
fax
国家代码-区号传真号-分机
数字以-分隔（30）
email
邮件地址
字符串
标准邮件地址
注册人信息结束
以下三种联系人，重复注册人各参数名称即可
管理人:
注册人各参数前加"a_"
缴费人:
注册人各参数前加"b_"
技术人:
注册人各参数前加"t_"
也可以使用下面的共享模式。
注:
asia域名注册时,技术人信息必须且只能为阳光互联相同信息,信息录入选择技术人共享模式输入,tech_same_as=1
admin_same_as
管理人共享模式
1或者2
1:
与阳光互联相同
2:
与注册人相同
tech_same_as
技术人共享模式
1或者2或者3
1:
与阳光互联相同
2:
与注册人相同
3:
与管理人相同
bill_same_as
缴费人共享模式
1或者2或者3或者4
1:
与阳光互联相同
2:
与注册人相同
3:
与管理人相同
4:
与技术人相同
文字说明：
a.其中联系人包括以下四种，
注册人、管理人、缴费人、技术人
注册人的信息是必须的，其他联系人，可以和前面相同，也可以单独提供。
例如单独提供管理人信息，在注册人相应参数前面加“a_”。
如：
a_address_zh=上海市浦东新区金茂大厦3层
a_name=韦小宝
…等。
如果和注册人相同，设置admin_same_as参数的值为2。
如：
admin_same_as=2
b如果admin_same_as,tech_same_as,bill_same_as赋值，则无需提供各自对应的联系人信息的每个参数的值。
c.注册asia域名,技术人信息是必须的,而且只能为阳光互联信息,不能单独提供,使用与阳光互联相同的技术人共享模式,设置参数tech_same_as的值为1.
如:
tech_same_as=1
…
2.2.1.2修改联系人
action=chgcontact
（此操作是免费的）
详细参数列表：
参数名
说明
类型（长度）
备注
domain
标准域名
字符串（3－60）
changetype
0:
注册人
注：
每次只能修改一种联系人
Asia域名不能修改技术联系人.
1:
管理联系人
2:
缴费联系人
3:
技术联系人
4:
过户
organization
单位名称
字符串（1－255）
即为：
域名所有人
address
地址
字符串（1－255）
city
所在城市
字符串（1－255）
state
所在省份
字符串（1－255）
postcode
邮政编码
数字
country
所在国家缩写
字符串
（2）
中国为CN,更多请见附2
phone
国家代码-区号电话号-分机
数字以-分隔（30）
-010********
分机可选
fax
国家代码-区号传真号-分机
数字以-分隔（30）
-010********
分机可选
email
邮件地址
标准邮件地址
firstname
联系人名
英文字母（1－50）
英文类域名需要，包括：
国际英文域名
国际中文域名
.name域名
.mobi域名
.biz域名
.info域名
.cc域名
.tv域名
非此八类域名不需要
lastname
联系人姓
英文字母（1－50）
organization_zh
单位名称（中文）
字符串（1－255）
state_zh
省份（中文）
字符串（1－255）
city_zh
城市（中文）
字符串（1－255）
address_zh
地址（中文）
字符串（1－255）
name
联系人姓名
字符串（1－16）
中文类域名需要，包括：
CN英文域名
国内中文域名
非此两类域名不需要
manager
单位法人（修改注册人/过户需要）
字符串（3－16）
organization_type
所属行业（修改注册人/过户需要）
字符串（1－16）
注：
中文类域名上述信息为中文内容，包括：
CN英文域名（国内英文域名）
国内中文域名
英文类域名上述信息为英文内容，包括：
国际英文域名
国际中文域名
Name域名
.mobi域名
.biz域名
2.2.1.3域名续费
action=renew
（此操作是收费的）
详细参数列表：
参数名
说明
类型（长度）
备注
domain
域名
标准域名，例如：
sundns.name,也可以为通用网址，例：
阳光互联
deaddate
续费后到期日
（请特别注意）
日期类型
例如：
当前域名到期日为2007-10-10，如要续费一年，
则deaddate=2008-10-10
vyear
续费年数
数字
2.2.1.4注册主机（创建域名服务器）
action=regdns
（此操作是收费的）
详细参数列表：
参数名
说明
类型（长度）
备注
regtype
0
数字
（1）
国内英文（解析国内英文域名）
1
数字
（1）
国外（解析国际域名）
2
数字
（1）
name域名（解析name顶级域名）
3
数字
（1）
国内中文（解析国内中文域名）
4
数字
（1）
.org/.biz/.cc/.tv/.info/域名
（解析.org/.biz/.cc/.tv/.info/域名）
dnshost01
主机名
主机域名
域名服务器名称例:
dnshost01_ip
主机对应IP
标准IP
标准IP
注：
一个IP只能注册一个主机
2.2.1.5修改解析服务器（域名DNS修改）
action=chgdns
（此操作是免费的）
详细参数列表：
参数名
说明
类型（长度）
备注
domain
域名
标准域名
dnshost01
解析服务器1
主机域名
例:
dnshost02
解析服务器2
主机域名
例:
2.2.1.6修改域名密码
action=chgpwd
（此操作是免费的）
详细参数列表：
参数名
说明
类型（长度）
备注
domain
域名
标准域名
domainpwd
域名密码
字符串（3－16）
2.2.1.7修改主机IP（修改域名服务器IP）
action=chgdnshost
（此操作是免费的,一天只能提交一次）
详细参数列表：
参数名
说明
类型（长度）
备注
dnshost01
主机名
主机域名
域名服务器名称例：
dnshost01_ip
主机对应IP
标准IP
例：
218.30.102.231
2.2.1.8域名转入
action=transfer
（此操作是收费的）
详细参数列表：
参数名
说明
类型（长度）
备注
productid
cn
com
cnch
comch
biz
常量
CN英文域名（国内英文域名）
国际英文域名
国内中文域名
国际中文域名
.biz域名
domain
域名
标准域名
domainpwd
域名口令
字符串（3－16）
2.2.1.9域名解析
域名解析包括：
显示域名的当前解析记录，新增解析记录，修改，删除。
只读的记录类型有：
SOA记录，id=0的NS记录，此两类记录不能进行删改操作
可供增删改操作的记录类型有：
A记录、NS记录、MX记录、CNAME记录、URL转发记录
2.2.1.9.1显示域名当前解析记录
action=query_rr
（此操作是免费的）
参数名
说明
类型（长度）
备注
domain
域名
标准域名
2.2.1.9.2增加域名解析记录
action=add_rr
（此操作10条内是免费的）
（一个域名超过10条解析记录时，需要另外购买，购买请参见：
2.2.1.9.5购买解析记录条数）
参数名
说明
类型（宽度）
备注
domain
域名
标准域名
rr
资源记录值
字符（20）
例如：
ftp,www,mx等,可以为空,泛域名解析该此为*
type
记录类型,可为：
a
ns
mx
cname
url
常量
记录类型，分别为：
A记录
NS记录
MX记录
CNAME记录
URL转发记录
value
记录值
字符
例：
218.30.103.28
pri
例如：
5
数字
（2）
只有type=mx或type=url时此参数才有值
type=mx时意为优先级,为数字，值越小优先级越高。
type=url时意为转发形式，为0至1级，
0隐含转发，1为不隐含转发
显示域名解析记录返回代码说明：
xmlversion="1.0"?
>
200表示命令请求正确
20060904表示请求日期
SOA
1157726
NS
0
注：
上面返回xml节点当中
……
record为遍历的每条解析记录，各节点名称及值如下：
type值表示不同的记录类型：
SOA表示SOA记录
A表示A记录
NS表示NS记录
MX表示MX记录,即邮件交换记录
CNAME表示CNAME记录
URL表示URL转发
id值表示：
记录ID
name值表示：
RR值，并域名，例如：
，等
values表示：
对应资源地址，如IP，域名等。
ttl表示：
DNS服务器上缓存时间
prio表示：
优先级
如返回如下信息需要另外购买解析条数：
xmlversion="1.0"?
>
300
需要购买解析条数
2.2.1.9.3删除域名解析记录
action=del_rr
（此操作是免费的）
参数名
说明
类型（长度）
备注
domain
域名
标准域名
rr_id
资源记录ID
数字（1-10）
此值通过query返回的XML得到
例：
7276826
……
即rr_id=7276826
2.2.1.9.4修改域名解析记录
action=modify_rr
（此操作是免费的）
参数名
说明
类型（长度）
备注
domain
域名
标准域名
rr_id
资源记录ID
数字（1-10）
同上
type
记录类型
常量
同上
value
记录值
字符
同上
pri
级别值
数字（1-2）
同上
ttl
按原值传送
2.2.1.9.5购买解析记录条数
action=activate_rr
（此操作是收费的）
参数名
说明
类型（长度）
备注
domain
域名
标准域名
productid
11321
常量
11321
2.2.1.10显示域名信息
action=getdomaininfo
（此操作是免费的）
参数名
说明
类型（长度）
备注
domain
域名
字符
标准域名，例：
域名显示结果说明：
xmlversion="1.0"?
>
200
域名
2006-05-16域名成功日
2011-05-16域名到期日
q1w2e3r5域名口令
主域名解析服务器
辅域名解析服务器
Beijingchina地址（英文）
liang名（英文）
xiao姓（英文）
yovole单位名称（英文）
beijing城市（英文）
beijing省份（英文）
中国北京地址（中文）
梁晓姓名（中文）
阳光互联单位名称（中文）
北京城市（中文）
北京省份（中文）
梁晓单位法人（注册人显示）
S1单位所属行业代码
100011邮政编码
CN国家代码
86-01064242299-0000电话
86-01064242299-0000传真
liangxiao@邮件地址
填写管理人共享模式
Beijingchina地址（英文）
liang名（英文）
xiao姓（英文）
yovole单位名称（英文）
beijing城市（英文）
beijing
升级会员 