阿里云域名API接口说明文档.docx
《阿里云域名API接口说明文档.docx》由会员分享，可在线阅读，更多相关《阿里云域名API接口说明文档.docx（103页珍藏版）》请在冰豆网上搜索。
阿里云域名API接口说明文档
阿里云
域名、虚拟主机、企业邮局
API接口说明文档
前言
本文档描述了阿里云域名注册，虚拟主机，企业邮局API接口协议。
本文档描述了基本的数据交换标准，其中包括数据格式，数据定义，以及一些相关约定。
目录
版本更新说明4
1．API接口地址8
2．参数说明8
2．1公共参数8
2．2行为参数（action）9
2.2.1域名类9
2.2.1.1域名注册9
2.2.1.2修改联系人12
2.2.1.3域名续费13
2.2.1.4注册主机（创建域名服务器）14
2.2.1.5修改解析服务器（域名DNS修改）14
2.2.1.6修改域名密码15
2.2.1.7修改主机IP（修改域名服务器IP）15
2.2.1.9域名解析15
2.2.1.9.1显示域名当前解析记录15
2.2.1.9.2增加域名解析记录15
2.2.1.9.3删除域名解析记录17
2.2.1.9.4修改域名解析记录18
2.2.1.10显示域名信息18
2.2.1.11参数限制20
2.2.1.11.1Cn域名以及国内中文域名20
2.2.2虚拟主机类21
2.2.2.1虚拟主机购买21
2.2.2.2虚拟主机续费30
2.2.2.3虚拟主机升级31
2.2.2.4虚拟主机管理32
2.2.2.4.1主机增加空间32
2.2.2.4.2修改操作系统32
2.2.2.4.3修改主机管理密码33
2.2.2.4.4修改机房34
2.2.2.4.5修改主机域名34
2.2.2.4.6显示主机信息34
2.2.2.4.7绑定主机域名35
2.2.2.4.8重置FTP密码36
2.2.2.4.9重置数据库密码36
2.2.2.4.10修改主机备注37
2.2.2.4.11主机增加流量包37
2.2.2.4.12主机增加带宽38
2.2.2.5翔云主机购买（新购已下线，只能续费）38
2.2.3邮箱类42
2.2.3.1企业邮局购买42
2.2.3.2企业邮局续费43
2.2.3.3企业邮局管理44
2.2.3.3.1邮局增加邮箱个数及空间44
2.2.3.3.2修改邮局机房（此服务已下线）45
2.2.3.3.3修改邮局管理员密码45
2.2.3.3.4修改邮局域名45
2.2.3.3.5显示邮局信息46
2.2.3.3.6DIY-G邮局试用业务转为正式业务46
2.2.3.3.7查询邮箱当前已使用的帐号数47
2.2.3.4企业邮局升级47
2.2.4业务操作类48
2.2.4.1业务状态读取48
2.2.4.2业务记录批量读取48
2.2.4.3财务流水记录批量读取49
2.2.4.3账户余额显示50
2.2.4.4提取产品价格51
3.应答代码51
3.1.成功返回51
3.2.处理中返回，等待成功52
3.3.失败返回，不可能成功52
4.应用示例52
4．1CN英文域名注册52
4．2国际英文域名注册53
4．3国际中文域名注册54
4．4国内中文域名注册56
4．5国际英文域名续费57
4．6国内中文域名过户58
5．错误代码58
6.附件一：
域名后缀60
6.1CN英文域名（国内英文域名）60
6.2国内中文域名（CNNIC中文通用域名）61
6.3国际英文域名61
6.4国际中文域名61
6.5Name域名62
6.6Mobi域名62
6.7Biz域名62
6.8Info域名62
6.9cc域名62
6.10tv域名62
6.11asia域名62
6.12me域名62
6.13tel域名62
7.附件二：
国家列表62
8.附件三：
单位行业68
9.附件四:
域名whois接口68
9.1域名check68
9.2域名info70
10.附件五:
虚拟主机，企业邮局配置及功能表71
10.1虚拟主机71
10.2虚拟主机升级关系71
10.3企业邮箱71
版本更新说明
序号
更新时间
更新内容
增加人
备注
1
20150115
1、增加虚拟主机及轻云新产品的新购、续费、升级功能，增加支持轻云产品的按月售卖
host_x2_cloud虚拟主机渠道版（青岛机房）
host_x6_cloud虚拟主机基础版（青岛机房）
host_x8_cloud虚拟主机高级版（青岛机房）
qy_eco轻云服务器经济版
qy_elt轻云服务器菁英版
qy_cla轻云服务器经典版
qy_pow轻云服务器全能版
qy_ult轻云服务器尊享版
张倩
V2.0.3
2
20150211
2.2.1.9域名解析部分做了变更
1）增加域名解析记录中，此操作免费，
因此删除（一个域名超过10条解析记录时，需要另外购买，购买请参见：
2.2.1.9.5购买解析记录条数）
2）type类型删除url转发记录，并增加如下类型值：
AAAA
SRV
REDIRECT_URL
FORWORD_URL
TXT
3）增加line参数及对应的参数值说明
4）删除2.2.1.9.5购买解析记录条数
赵洪涛
V2.0.3
3
20150421
2.2.2.4.7,增加一个错误结果，用于在主机新购及绑定域名时候，针对绑定的域名进行黑名单核查：
绑定的域名多次违规，已加入阿里云黑名单。
张倩
主机默认开通绿网功能，可在会员中心-云盾-绿网下查看主机违规信息
4
20150721
增加.TOP域名
5
20151228
增加独享虚拟主机产品
取消虚拟主机明文密码返回
增加修改虚拟主机FTP密码重置接口、数据库密码重置接口
下线部分虚拟主机产品
6
20160427
增加共享虚拟主机经济版等8款产品
下线虚拟主机基础版，虚拟主机高级版，独享高级版，独享尊享版，独享至尊版，轻云服务器（4款）产品，G享主机-G1（云），G享主机-G5（云）。
张倩
V2.0.4
7
20160427
增加3款企业邮箱产品：
mail_cloud_1t企业邮箱标准版1T不可新购，可续费
mail_group_1t企业邮箱集团版1T不可新购，可续费
mail_cloud_ssg 企业邮箱尊享版新增
mail_group_sgt 企业邮箱集团版-无限容量新增
mail_cloud_cpl 企业邮箱标准版-无限容量新增
武通
V2.0.4
8
20160601
四款共享虚拟主机的机房切换到北京
sharing_host_economic共享虚拟主机经济版（北京）
sharing_host_standard共享虚拟主机标准版（北京）
sharing_host_enhanced共享虚拟主机增强版（北京）
sharing_host_deluxe共享虚拟主机豪华版（北京）
张倩
V2.0.5
9
20160630
域名修改联系人接口调整
1.下线过户功能（changetype=4）
2.下线修改域名所有人功能（修改organization）
以上调用方式，接口返回失败，并提示错误信息“域名所有者变更（过户）功能不可用，请登陆PC，在阿里云-域名控制台使用相关功能”
陈文杰
V2.0.6
10
20160712
增加四款独享虚拟主机的售卖
exclusive_host_preferential_standard独享虚拟主机普惠版（标准）
exclusive_host_professional_standard独享虚拟主机专业版（标准）
exclusive_host_exalted_standard独享虚拟主机尊贵版（标准）
exclusive_host_flagship_standard独享虚拟主机旗舰版（标准）
张倩
V2.0.7
11
20170615
增加3款独享虚拟主机的售卖
host_channel_bsc虚拟主机渠道基础版
host_channel_pro虚拟主机渠道专业版
host_channel_adv虚拟主机渠道高级版
陈文杰
V2.0.8
12
20170622
新增四款海外版独享虚机的售卖
exclusive_host_eco_us独享虚拟主机经济版（美国）
exclusive_host_eco_hk独享虚拟主机经济版（香港）
许家玮
V2.0.9
13
20170927
新增虚机备注信息，涉及到改动点：
1.虚机新购activate，新增备注字段hostcomment
2.显示主机信息，新增备注字段返回hostcomment
3.新增虚机备注更新接口，changecomment
许家玮
V2.0.10
14
20171010
1.新增exclusive_host_eco独享虚拟主机经济版（北京，杭州，深圳）
2．新增API
a>主机增加流量包
b>主机增加带宽
3.新增香港、美国机房
许家玮
V2.0.11
1．API接口地址
接口采用HTTP，POST协议：
正式URL：
http:
//
调用说明：
接口使用万网分销商级别的数字ID（以下本文档简称为数字ID），即可调用。
2．参数说明
2．1公共参数
注：
所有各参数字符集为gb2312
以下参数是在访问接口时必须提供的，否则服务器直接返回错误信息。
序号
名称
说明
类型（长度）
备注
1
userid
万网数字ID
常量（8位数字）
万网8位数字ID
2
userstr
md5（
数字ID
用户密码
email
vtime
）
常量（32位字符）
md5，API认证函数
数字ID（万网8位数字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
so
co
top
常量
CN英文域名（国内英文域名）
国际英文域名
国内中文域名
国际中文域名
name域名
.mobi域名
.biz域名
.info域名
.cc域名
.tv域名
中文.cc域名
中文.tv域名
中文.biz域名
国际asia域名
注：
域名后缀请见附件1
So域名
Co域名
regtype
域名所有者类型
1或者2
1:
个人
2:
企业
注册人信息开始
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********
分机可选
注：
必须按此格式传值
2位-11位-4位
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=北京市东城区鼓楼外大街27号万网大厦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
域名
标准域名，例如：
hichina.name,也可以为通用网址，例：
中国万网，买麦网,hichina
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.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
（此操作是免费的）
参数名
说明
类型（宽度）
备注
domain
域名
标准域名
rr
资源记录值
字符（20）
例如：
ftp,www,mx等,可以为空,泛域名解析该此为*
type
记录类型,可为：
A
NS
MX
CNAME
AAAA
SRV
REDIRECT_URL
FORWORD_URL
TXT
常量
记录类型，分别为：
A记录
NS记录
MX记录
CNAME记录
AAAA记录
SRV记录
显性URL转发
隐形URL转发
TXT记录
value
记录值
字符
例：
218.30.103
升级会员 