阿里云域名API接口说明文档.docx

1、阿里云域名API接口说明文档阿里云域名、虚拟主机、企业邮局API接口说明文档 前言本文档描述了阿里云域名注册，虚拟主机，企业邮局API接口协议。本文档描述了基本的数据交换标准，其中包括数据格式，数据定义，以及一些相关约定。目录版本更新说明 41API接口地址 82参数说明 821公共参数 822行为参数（action） 92.2.1域名类 92.2.1.1域名注册 92.2.1.2修改联系人 122.2.1.3域名续费 132.2.1.4注册主机(创建域名服务器) 142.2.1.5修改解析服务器(域名DNS修改) 142.2.1.6修改域名密码 152.2.1.7修改主机IP(修改域名服务器

2、IP) 152.2.1.9域名解析 152.2.1.9.1 显示域名当前解析记录 152.2.1.9.2 增加域名解析记录 152.2.1.9.3 删除域名解析记录 172.2.1.9.4 修改域名解析记录 182.2.1.10 显示域名信息 182.2.1.11 参数限制 202.2.1.11.1 Cn域名以及国内中文域名 202.2.2 虚拟主机类 212.2.2.1 虚拟主机购买 212.2.2.2 虚拟主机续费 302.2.2.3 虚拟主机升级 312.2.2.4 虚拟主机管理 322.2.2.4.1主机增加空间 322.2.2.4.2修改操作系统 322.2.2.4.3修改主机管理密

3、码 332.2.2.4.4修改机房 342.2.2.4.5修改主机域名 342.2.2.4.6显示主机信息 342.2.2.4.7 绑定主机域名 352.2.2.4.8 重置FTP密码 362.2.2.4.9 重置数据库密码 362.2.2.4.10 修改主机备注 372.2.2.4.11 主机增加流量包 372.2.2.4.12 主机增加带宽 382.2.2.5 翔云主机购买(新购已下线，只能续费) 382.2.3邮箱类 422.2.3.1 企业邮局购买 422.2.3.2 企业邮局续费 432.2.3.3 企业邮局管理 442.2.3.3.1邮局增加邮箱个数及空间 442.2.3.3.2修

4、改邮局机房(此服务已下线) 452.2.3.3.3修改邮局管理员密码 452.2.3.3.4修改邮局域名 452.2.3.3.5显示邮局信息 462.2.3.3.6 DIY-G邮局试用业务转为正式业务 462.2.3.3.7 查询邮箱当前已使用的帐号数 472.2.3.4企业邮局升级 472.2.4业务操作类 482.2.4.1 业务状态读取 482.2.4.2 业务记录批量读取 482.2.4.3 财务流水记录批量读取 492.2.4.3 账户余额显示 502.2.4.4提取产品价格 513.应答代码 513.1. 成功返回 513.2. 处理中返回，等待成功 523.3. 失败返回，不可能

5、成功 524.应用示例 5241 CN英文域名注册 5242国际英文域名注册 5343国际中文域名注册 5444国内中文域名注册 5645国际英文域名续费 5746国内中文域名过户 585错误代码 586.附件一：域名后缀 606.1 CN英文域名(国内英文域名) 606.2 国内中文域名(CNNIC中文通用域名) 616.3 国际英文域名 616.4 国际中文域名 616.5 Name域名 626.6 Mobi域名 626.7 Biz域名 626.8 Info域名 626.9 cc域名 626.10 tv域名 626.11 asia域名 626.12 me域名 626.13 tel域名 62

6、7.附件二：国家列表 628.附件三：单位行业 689.附件四: 域名whois接口 689.1域名check 689.2域名info 7010.附件五: 虚拟主机，企业邮局配置及功能表 7110.1虚拟主机 7110.2 虚拟主机升级关系 7110.3 企业邮箱 71版本更新说明序号更新时间更新内容增加人 备注1201501151、 增加虚拟主机及轻云新产品的新购、续费、升级功能，增加支持轻云产品的按月售卖host_x2_cloud 虚拟主机渠道版(青岛机房)host_x6_cloud 虚拟主机基础版(青岛机房)host_x8_cloud 虚拟主机高级版(青岛机房)qy_eco 轻云服务器经

7、济版qy_elt 轻云服务器菁英版qy_cla 轻云服务器经典版qy_pow 轻云服务器全能版qy_ult 轻云服务器尊享版张倩V2.0.32201502112.2.1.9域名解析部分做了变更1）增加域名解析记录中，此操作免费，因此删除 (一个域名超过10条解析记录时，需要另外购买，购买请参见：2.2.1.9.5 购买解析记录条数)2）type类型删除url转发记录，并增加如下类型值：AAAASRVREDIRECT_URLFORWORD_URLTXT3）增加line参数及对应的参数值说明4）删除2.2.1.9.5购买解析记录条数赵洪涛V2.0.33201504212.2.2.4.7,增加一个错

8、误结果，用于在主机新购及绑定域名时候，针对绑定的域名进行黑名单核查：绑定的域名多次违规，已加入阿里云黑名单。张倩主机默认开通绿网功能，可在会员中心-云盾-绿网下查看主机违规信息420150721增加.TOP域名520151228增加独享虚拟主机产品取消虚拟主机明文密码返回增加修改虚拟主机FTP密码重置接口、数据库密码重置接口下线部分虚拟主机产品620160427增加共享虚拟主机经济版等8款产品下线虚拟主机基础版，虚拟主机高级版，独享高级版，独享尊享版，独享至尊版，轻云服务器（4款）产品，G享主机-G1（云），G享主机-G5（云）。张倩V2.0.4720160427增加3款企业邮箱产品：mail

9、_cloud_1t 企业邮箱标准版1T 不可新购，可续费mail_group_1t 企业邮箱集团版1T 不可新购，可续费mail_cloud_ssg 企业邮箱尊享版 新增mail_group_sgt 企业邮箱集团版-无限容量 新增mail_cloud_cpl 企业邮箱标准版-无限容量 新增武通V2.0.4820160601四款共享虚拟主机的机房切换到北京sharing_host_economic 共享虚拟主机经济版 (北京)sharing_host_standard 共享虚拟主机标准版(北京)sharing_host_enhanced 共享虚拟主机增强版(北京)sharing_host_del

10、uxe 共享虚拟主机豪华版(北京)张倩V2.0.5920160630域名修改联系人接口调整1. 下线过户功能（changetype=4）2. 下线修改域名所有人功能（修改organization）以上调用方式，接口返回失败，并提示错误信息“域名所有者变更（过户）功能不可用，请登陆PC，在阿里云-域名控制台使用相关功能”陈文杰V2.0.61020160712增加四款独享虚拟主机的售卖exclusive_host_preferential_standard 独享虚拟主机普惠版（标准）exclusive_host_professional_standard 独享虚拟主机专业版（标准）exclusiv

11、e_host_exalted_standard 独享虚拟主机尊贵版（标准）exclusive_host_flagship_standard 独享虚拟主机旗舰版（标准）张倩V2.0.71120170615增加3款独享虚拟主机的售卖host_channel_bsc 虚拟主机渠道基础版host_channel_pro 虚拟主机渠道专业版host_channel_adv 虚拟主机渠道高级版陈文杰V2.0.81220170622新增四款海外版独享虚机的售卖exclusive_host_eco_us独享虚拟主机经济版（美国）exclusive_host_eco_hk独享虚拟主机经济版（香港）许家玮V2.0

12、.91320170927新增虚机备注信息，涉及到改动点：1. 虚机新购activate，新增备注字段hostcomment2. 显示主机信息，新增备注字段返回hostcomment3. 新增虚机备注更新接口，changecomment许家玮V2.0.1014201710101.新增exclusive_host_eco 独享虚拟主机经济版（北京，杭州，深圳）2新增APIa主机增加流量包b主机增加带宽3.新增香港、美国机房许家玮V2.0.111API接口地址接口采用HTTP，POST协议：正式URL：http:/ 调用说明：接口使用万网分销商级别的数字ID（以下本文档简称为数字ID），即可调用。2

13、参数说明21公共参数注：所有各参数字符集为gb2312以下参数是在访问接口时必须提供的，否则服务器直接返回错误信息。序号名称说明类型(长度)备注1userid万网数字ID常量(8位数字)万网8位数字ID2userstrmd5(数字ID用户密码emailvtime)常量(32位字符)md5，API认证函数数字ID(万网8位数字ID)用户密码(ID密码) 邮箱(ID下邮箱) vtime为12位字符例如当前时间是：2006年8月30日8点15分vtime=200608300815 四项值依顺序连接,通过md5函数处理后，userstr值为32位的字符串。3categorydomain 常量产品类别为

14、域名host产品类别为主机 mail产品类别为邮箱all业务操作类，不具体产品类别4action操作行为常量根据不同功能，提供不同的数值，下面有详细说明。5vtimevtime为12位字符例如当前时间是：2006年8月30日8点15分vtime=200608300815注:服务器时间与北京时间相同6sourceid业务请求序号字符(16位)业务请求序号，用于标识每次业务请求的序号，此值必须唯一。22行为参数（action）根据不同功能，选择不同的行为数值，每次调用只能选择一种行为。2.2.1域名类2.2.1.1域名注册action=activate详细参数列表：注：所有参数名称中英文字母都是小

15、写另注:国内域名请按下列红字提醒添加购买后提示!“您的域名刚提交成功，只有通过域名注册管理机构CNNIC的审核才表时您的域名正式注册成功。请您确保域名正式注册成功后再提交续费，否则因为CNNIC审核不通过而删除域名，将不退还续费的费用。我们建议您在新域名成功15日后再提交续费。给您带来不便之处，敬请谅解。”(此操作是收费的)参数名说明类型(长度)备注domain标准域名。字符串（360）例：domainpwd域名口令字符串（316）数字及英文字母vyear注册年数数字dns1第一个解析服务器服务器地址默认为万网：dns2第二个解析服务器服务器地址默认为万网：productidcncomcnch

16、comchnamemobibizinfocctvccchtvchbizchasiametelsocotop常量CN英文域名(国内英文域名)国际英文域名国内中文域名国际中文域名name域名.mobi域名.biz域名.info域名.cc域名.tv域名中文.cc域名中文.tv域名中文.biz域名国际asia域名注：域名后缀请见附件1So域名Co域名regtype域名所有者类型1或者21:个人2:企业注册人信息开始address_en英文地址字符串（1255）英文类域名需要，包括： 国际英文域名国际中文域名.name域名.mobi域名.biz域名.info域名.cc域名.tv域名非此八类域名，即中文域

17、名不需要firstname英文名字符串（150）lastname英文姓字符串（150）organization_en英文单位名称(域名所有人)字符串（1255）city英文城市字符串（1255）state英文省份字符串（1255）address_zh地址(中文)字符串（1255）中文类域名需要，包括：CN英文域名国内中文域名非此两类域名，即英文类域名时此5个参数为可选参数。name联系人姓名(中文)字符串（116）organization_zh单位名称(中文) (域名所有人)字符串（1255）ccity城市(中文)字符串（1255）cstate省份(中文)字符串（1255）manager单位法

18、人（注册人需要）字符串（116）中文类域名需要，包括：CN英文域名国内中文域名organization_type单位所属行业（只有注册人需要）详细代码见附3注：必须按附3格式传值字符串（116）postcode邮政编码数字(6)country国家代码字符串（2）中国为CN,更多请见附2phone国家代码-区号电话号-分机数字以-分隔(30)-010*分机可选注：必须按此格式传值2位-11位-4位fax国家代码-区号传真号-分机数字以-分隔(30)email邮件地址字符串标准邮件地址注册人信息结束以下三种联系人，重复注册人各参数名称即可管理人: 注册人各参数前加a_缴费人: 注册人各参数前加b_

19、技术人: 注册人各参数前加t_也可以使用下面的共享模式。注:asia域名注册时,技术人信息必须且只能为万网相同信息,信息录入选择技术人共享模式输入,tech_same_as=1admin_same_as管理人共享模式1或者21:与万网相同2:与注册人相同tech_same_as技术人共享模式1或者2或者31:与万网相同2:与注册人相同3:与管理人相同bill_same_as缴费人共享模式1或者2或者3或者41:与万网相同2:与注册人相同3:与管理人相同4:与技术人相同文字说明：a.其中联系人包括以下四种，注册人、管理人、缴费人、技术人注册人的信息是必须的，其他联系人，可以和前面相同，也可以单独

20、提供。例如单独提供管理人信息，在注册人相应参数前面加“a_”。如：a_ address_zh=北京市东城区鼓楼外大街27号万网大厦3层a_name=韦小宝等。如果和注册人相同，设置admin_same_as参数的值为2。如：admin_same_as=2b如果admin_same_as,tech_same_as,bill_same_as赋值，则无需提供各自对应的联系人信息的每个参数的值。c.注册asia域名,技术人信息是必须的,而且只能为万网信息,不能单独提供,使用与万网相同的技术人共享模式,设置参数tech_same_as的值为1.如:tech_same_as=12.2.1.2修改联系人ac

21、tion= chgcontact(此操作是免费的)详细参数列表：参数名说明类型(长度)备注domain标准域名字符串（360）changetype0:注册人注：每次只能修改一种联系人Asia域名不能修改技术联系人.过户功能下线1:管理联系人2:缴费联系人3:技术联系人4:过户organization单位名称字符串（1255）修改域名所有人功能下线address地址字符串（1255）city所在城市字符串（1255）state所在省份字符串（1255）postcode邮政编码数字country所在国家缩写字符串(2)中国为CN,更多请见附2phone国家代码-区号电话号-分机数字以-分隔(30)

22、-010*分机可选fax国家代码-区号传真号-分机数字以-分隔(30)-010*分机可选email邮件地址标准邮件地址firstname联系人名英文字母（150）英文类域名需要，包括： 国际英文域名国际中文域名.name域名.mobi域名.biz域名.info域名.cc域名.tv域名非此八类域名不需要lastname联系人姓英文字母（150）organization_zh单位名称(中文) 字符串（1255）state_zh省份(中文)字符串（1255）city_zh城市(中文)字符串（1255）address_zh地址(中文)字符串（1255）name联系人姓名字符串（116）中文类域名需要，

23、包括：CN英文域名国内中文域名非此两类域名不需要manager单位法人（修改注册人/过户需要）字符串（316）organization_type所属行业（修改注册人/过户需要）字符串（116）注：中文类域名上述信息为中文内容，包括：CN英文域名(国内英文域名)国内中文域名英文类域名上述信息为英文内容，包括：国际英文域名国际中文域名Name域名.mobi域名.biz域名2.2.1.3域名续费action= renew(此操作是收费的)详细参数列表：参数名说明类型(长度)备注domain域名标准域名，例如：,hichina.name,也可以为通用网址，例：中国万网，买麦网,hichinadeadd

24、ate续费后到期日(请特别注意)日期类型例如：当前域名到期日为2007-10-10，如要续费一年，则deaddate=2008-10-10vyear续费年数数字2.2.1.4注册主机(创建域名服务器)action= regdns(此操作是收费的)详细参数列表：参数名说明类型(长度)备注regtype0数字（1）国内英文（解析国内英文域名）1数字（1）国外（解析国际域名）2数字（1）name域名（解析name顶级域名）3数字（1）国内中文（解析国内中文域名）4数字（1）.org/.biz/.cc/.tv/.info/域名（解析.org/.biz/.cc/.tv/.info/域名）dnshost0

25、1主机名主机域名域名服务器名称 例: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域名密码字符串（316）2.2.1.7修改主机IP(修改域名服务器IP)action=chgd

26、nshost(此操作是免费的, 一天只能提交一次)详细参数列表：参数名说明类型(长度)备注dnshost01主机名主机域名域名服务器名称 例：dnshost01_ip主机对应IP标准IP例：218.30.102.2312.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记录类型,可为：ANSMXCNAMEAAAASRVREDIRECT_URLFORWORD_URLTXT常量记录类型，分别为：A记录NS记录MX记录CNAME记录AAAA记录SRV记录显性URL转发隐形URL转发TXT记录value记录值字符例：218.30.103