域名服务BCD

    接口说明

    说明

    域名服务API仅对申请的用户开放,使用前请先提交工单申请。

    域名列表

    描述

    本接口用于查询自己账号中的域名

    请求

    请求结构

    GET /v{version}/domain?pageNo={pageNo}&pageSize={pageSize} HTTP/1.1
    Host: bcd.baidubce.com 
    Authorization: authorization String

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    domain String RequestParam参数 域名名称
    domainPunycode String RequestParam参数 域名punyCode
    domainTld String RequestParam参数 域名后缀
    resourceId String RequestParam参数 域名资源name
    tagKey String RequestParam参数 标签名称
    tagValue String RequestParam参数 标签值
    domainStatus String RequestParam参数 域名状态(包含实名状态和过期状态)
    pageNo Integer RequestParam参数 页码
    pageSize Integer RequestParam参数 每页最多显示记录条数

    请求备注

    本接口,如果没有携带分页数据,或者页码每页超过100条,将会报错

    返回

    返回头域

    除公共头域,无其它特殊头域。

    返回参数

    参数名称 类型 描述
    domainName String 查询的域名
    status String 查询的域名状态

    返回错误

    请参考附录

    示例

    请求示例

    GET http://nmg02-bce-test140.nmg02.baidu.com:8417/v2/domain?pageNo=1&pageSize=2
    Authorization: bce-auth-v1/fa68c136bd1f492ebcff98d4a4e28861/2020-01-14T11:28:27Z/3600/host;x-bce-date/8a70e15ff0da26485d5df705d4029ad9803e25352e3ac97330ff52ec30e2f62c
    Host: nmg02-bce-test140.nmg02.baidu.com
    x-bce-console-rpc-id: f0c7e612-1e30-4537-8032-2310449a7a16
    x-bce-date: 2020-01-14T11:28:27Z

    返回示例

    HTTP/1.1 200 OK
    Cache-Control: no-cache
    Content-Length: -1
    Content-Type: application/json;charset=UTF-8
    Date: Tue, 14 Jan 2020 11:28:30 GMT
    Server: BWS
    Transfer-Encoding: chunked
    x-bce-request-id: faaecc64-48c6-4aef-871d-c67fc9454c9b
    {
    "totalCount":1,
    "result":[
        {
            "userId":"75c14a239bb24b9e88b695e8e9e47952",
            "resourceId":"1263c33f-7d2f-4c42-9d5b-960cffaf26d1",
            "contactId":"8fe6d82b49b05da30a52aa7085fd3c87",
            "domainName":"bobr5hk8d4cfq0bjcustomdnstest.com",
            "domain":"bobr5hk8d4cfq0bjcustomdnstest.com",
            "provider":"bizcn",
            "dns":[
                "ns3.baidudns.xyz",
                "ns4.baidudns.xyz"
            ],
            "registerTime":"2019-05-05T16:00:00Z",
            "expireTime":"2021-05-06T13:15:41Z",
            "auditStartTime":"2019-05-06T13:19:16Z",
            "auditStatus":"NONVERIFY",
            "realAuditStatus":"NONVERIFY",
            "expireStatus":"NORMAL",
            "emailVerifyStatus":"PENDING",
            "namingVerifyStatus":"PENDING",
            "privacyProtected":false,
            "beianStatus":"3",
            "domainStatus":"NONVERIFY",
            "privacySupported":true,
            "panelOpened":false,
            "auditEnabled":true,
            "renewEnabled":true,
            "userType":"INDIVIDUAL",
            "email":"zhuzhu01@baidu.com"
        }
    ]

    }

    域名查询

    描述

    本接口用于查询域名是否可注册。

    请求

    请求结构

    GET /v{version}/domain/search?domain={domain} HTTP/1.1
    Host: bcd.baidubce.com 
    Authorization: authorization String

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    domain String Query参数 查询的域名

    请求备注

    domain所注册的顶级域后缀请查看(英文域名默认顶级域后缀中文域名默认顶级域后缀), 域名的长度不能超过64。域名由英文字母(a-z,不区分大小写)、数字(0-9)、中文汉字以及连字符"-"(即中横线)构成,不能使用空格及特殊字符(如!、$、&、?等)。“-” 不能单独注册或连续使用,不能放在开头或结尾。中文域名可以直接使用中文,也可以使用punycode。

    返回

    返回头域

    除公共头域,无其它特殊头域。

    返回参数

    参数名称 类型 描述
    domainName String 查询的域名
    status String 查询的域名状态

    返回错误

    请参考附录

    示例

    请求示例

    GET /v1/domain/search?domain=doubletest.com HTTP/1.1
    Host: bcd.baidubce.com
    x-bce-date: 2016-05-09T03:47:46Z
    Content-Type: application/json; charset=utf-8  
    Authorization: bce-auth-v1/f932edbccdb04cec8e3307b1798f16e6/2016-05-09T03:47:46Z/3600/host;x-bce-date/b55c461424ebe9085a01abe7178c876d77e7b68046589c6519505be2dff2d39a

    返回示例

    HTTP/1.1 200 OK
    x-bce-request-id: 41d355e4-8002-4fdf-bbec-59d454f6a541
    Content-Type: application/json;charset=UTF-8
    Date: Mon, 09 May 2016 03:47:49 GMT
    Server: BWS
    Transfer-Encoding: chunked
    {
      	"domainBasicInfoList":
        [
            {
                "domainName":"doubletest.com",
                "status":"REGISTERED"
            }
        ]
    }

    注册结果状态说明

    状态码 说明
    UNREGISTERED 未被注册
    REGISTERED 已被注册
    RESERVED 注册局保留
    UNKNOWN 状态未知,需要再次查询

    域名询价

    描述

    本接口用于查询域名的购买价格。

    请求

    请求结构

    GET /v{version}/domain/price?domain={domain} HTTP/1.1
    Host: bcd.baidubce.com
    Authorization: authorization String

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    domain String Query参数 查询的域名

    请求备注

    domain所注册的顶级域后缀请查看(英文域名默认顶级域后缀中文域名默认顶级域后缀), 域名的长度不能超过64。域名由英文字母(a-z,不区分大小写)、数字(0-9)、中文汉字以及连字符"-"(即中横线)构成,不能使用空格及特殊字符(如!、$、&、?等)。“-” 不能单独注册或连续使用,不能放在开头或结尾。中文域名可以直接使用中文,也可以使用punycode。

    返回

    返回头域

    除公共头域,无其它特殊头域。

    返回参数

    参数名称 类型 描述
    domain String 查询的域名
    originPrice String 原价,单位人民币
    price String 首年实际价格,单位人民币
    rechargePrice String 续费价格,单位人民币
    transferInPrice String 转入价格,单位人民币

    返回错误

    请参考附录

    示例

    请求示例

    GET /v1/domain/price?domain=doubletest.com HTTP/1.1
    Host: bcd.baidubce.com
    x-bce-date: 2016-05-09T03:47:46Z
    Content-Type: application/json; charset=utf-8  
    Authorization: bce-auth-v1/f932edbccdb04cec8e3307b1798f16e6/2016-05-09T03:47:46Z/3600/host;x-bce-date/b55c461424ebe9085a01abe7178c876d77e7b68046589c6519505be2dff2d39a

    返回示例

    HTTP/1.1 200 OK
    x-bce-request-id: 41d355e4-8002-4fdf-bbec-59d454f6a541
    Content-Type: application/json;charset=UTF-8
    Date: Mon, 09 May 2016 03:47:49 GMT
    Server: BWS
    Transfer-Encoding: chunked
    {
      	
        {
            "domainName":"doubletestxxx.com",
            "price" : "42.00",
            "originPrice" : "80.00",
            "rechargePrice" : "59.00",
            "transferInPrice" : "55.00"
        }
        
    }

    域名注册

    描述

    本接口用于购买一个未被注册的域名。

    请求

    请求结构

    POST /v{version}/domain/register HTTP/1.1
    Host: bcd.baidubce.com
    Authorization: authorization String
    
    {
        "domain" : domain,
        "years" : years,
        "userType" : "userType",
        "ownerChinese" : ownerChinese,
        "ownerEnglish" : ownerEnglish,
        "contactChinese" : contactChinese,
        "contactEnglish" : contactEnglish,
        "email" : email,
        "region" : {
            "province" : province,
            "city" : city
        },
        "addressChinese" : addressChinese,
        "addressEnglish" : addressEnglish,
        "mobilePhone" : mobilePhone,
        "areaCode" : areaCode,
        "phoneNumber" : phoneNumber
        "postalCode" : postalCode,
        "privacy" : privacy,
        "dns" : dns
    }

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    domain String RequestBody参数 注册的域名名称
    years Integer RequestBody参数 域名的购买年限
    userType String RequestBody参数 用户类型
    ownerChinese String RequestBody参数 所有者中文名
    ownerEnglish String RequestBody参数 所有者英文名
    contactChinese String RequestBody参数 联系人中文名
    contactEnglish String RequestBody参数 联系人英文名
    email String RequestBody参数 邮箱地址
    region Region RequestBody参数 所属区域
    addressChinese String RequestBody参数 通讯地址-中文
    addressEnglish String RequestBody参数 通讯地址-英文
    mobilePhone String RequestBody参数 手机
    areaCode String RequestBody参数 区号
    phoneNumber String RequestBody参数 电话号码
    postalCode String RequestBody参数 邮编
    privacy Boolean RequestBody参数 是否开启隐私保护(仅部分域名支持)
    dns List<String> RequestBody参数 自定义DNS

    请求备注

    • domain所注册的顶级域后缀请查看(英文域名默认顶级域后缀中文域名默认顶级域后缀), 域名的长度不能超过64。域名由英文字母(a-z,不区分大小写)、数字(0-9)、中文汉字以及连字符"-"(即中横线)构成,不能使用空格及特殊字符(如!、$、&、?等)。“-” 不能单独注册或连续使用,不能放在开头或结尾。中文域名可以直接使用中文,也可以使用punycode。
    • 域名的注册年限最少为1年,最多为10年。
    • 用户类型可选值为“INDIVIDUAL”,“ENTERPRISE”,分别表示个人用户和企业用户。
    • 如果用户类型为个人,contactChinese必须与ownerChinese值相同,contactEnglish必须与ownerEnglish值相同。
    • 如果用户类型为企业,ownerChinese必须填企业全称,请不要填写法人。
    • 所有者中文名的长度均不能为空,也不能超过127。
    • 所有者英文名的长度均不能为空,也不能超过255。
    • 联系人中文名不能为空,长度不能超过10。
    • 联系人英文名不能为空,长度不能超过20。
    • 邮箱地址需要保证正确的格式。
    • 中文通讯地址的长度不能为空,也不能超过35。
    • 英文通讯地址的长度不能为空,也不能超过64。
    • 邮编为6位数字。
    • 手机号码为11位数字,前两位必须是13、14、15、17、18中的一个。
    • 区号为3位或4位数字,以0开头。
    • 电话号码为7到8位数字,也可加上3位以上的分机号,主号码和分机号要用-隔开。
    • 隐私保护参数为布尔值,true->开启;false->关闭,该参数不强制,默认值为false。
    • 自定义dns参数不强制,默认使用百度提供的DNS,形式如[ "ns1.bdydns.cn", "ns2.bdydns.cn" ],DNS个数最少2个,最多5个。

    返回

    返回头域

    除公共头域,无其它特殊头域。

    返回参数

    参数名称 类型 描述
    domain String 注册的域名名称
    registerResult boolean 注册的结果
    bceOrderId String 注册订单编号

    返回错误

    请参考附录

    示例

    请求示例

    POST /v1/domain/register HTTP/1.1
    Host: bcd.baidubce.com
    x-bce-date: 2016-05-03T09:54:08Z
    Content-Type: application/json; charset=utf-8 
    Authorization: bce-auth-v1/f932edbccdb04cec8e3307b1798f16e6/2016-05-03T09:54:08Z/3600/host;x-bce-date/d13cb40a2f86aeea2d625cceece02bdfe677b765a97da19913db08e9a0ed2efc
    
    {
        "domain" : "test.cn",
        "years" : 1,
        "privacy" : false,
        "userType" : "INDIVIDUAL",
        "ownerChinese" : "测试",
        "ownerEnglish" : "test",
        "contactChinese" : "测试",
        "contactEnglish" : "test",
        "email" : "test@baidu.com",
        "region" : {
            "province" : "110000",
            "city" : "110000"
        },
        "addressChinese" : "科技园",
        "addressEnglish" : "kejiyuan",
        "postalCode" : "100000",
        "mobilePhone" : "13812345678",
        "areaCode" : "010",
        "phoneNumber" : "12345678"
    }

    返回示例

    HTTP/1.1 200 OK
    x-bce-request-id: 254c08ad-e6bb-4298-ae68-96c7d3103e16
    Content-Type: application/json;charset=UTF-8
    Date: Tue, 03 May 2016 09:54:24 GMT
    Server: BWS
    Transfer-Encoding: chunked
    {
        "domain":"test.cn",
        "registerResult":true
        "bceOrderId":"d80063bfdd72436d8252cad46b63f31d"
    }

    域名注册(异步注册)

    描述

    本接口用于异步购买一个未被注册的域名。

    请求

    请求结构

    POST /v{version}/domain/register_async HTTP/1.1
    Host: bcd.baidubce.com
    Authorization: authorization String
    
    {
        "domain" : domain,
        "years" : years,
        "userType" : "userType",
        "ownerChinese" : ownerChinese,
        "ownerEnglish" : ownerEnglish,
        "contactChinese" : contactChinese,
        "contactEnglish" : contactEnglish,
        "email" : email,
        "region" : {
            "province" : province,
            "city" : city
        },
        "addressChinese" : addressChinese,
        "addressEnglish" : addressEnglish,
        "mobilePhone" : mobilePhone,
        "areaCode" : areaCode,
        "phoneNumber" : phoneNumber
        "postalCode" : postalCode,
        "privacy" : privacy,
        "dns" : dns
    }

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    domain String RequestBody参数 注册的域名名称
    years Integer RequestBody参数 域名的购买年限
    userType String RequestBody参数 用户类型
    ownerChinese String RequestBody参数 所有者中文名
    ownerEnglish String RequestBody参数 所有者英文名
    contactChinese String RequestBody参数 联系人中文名
    contactEnglish String RequestBody参数 联系人英文名
    email String RequestBody参数 邮箱地址
    region Region RequestBody参数 所属区域
    addressChinese String RequestBody参数 通讯地址-中文
    addressEnglish String RequestBody参数 通讯地址-英文
    mobilePhone String RequestBody参数 手机
    areaCode String RequestBody参数 区号
    phoneNumber String RequestBody参数 电话号码
    postalCode String RequestBody参数 邮编
    privacy Boolean RequestBody参数 是否开启隐私保护(仅部分域名支持)
    dns List<String> RequestBody参数 自定义DNS

    请求备注

    • domain所注册的顶级域后缀请查看(英文域名默认顶级域后缀中文域名默认顶级域后缀), 域名的长度不能超过64。域名由英文字母(a-z,不区分大小写)、数字(0-9)、中文汉字以及连字符"-"(即中横线)构成,不能使用空格及特殊字符(如!、$、&、?等)。“-” 不能单独注册或连续使用,不能放在开头或结尾。中文域名可以直接使用中文,也可以使用punycode。
    • 域名的注册年限最少为1年,最多为10年。
    • 用户类型可选值为“INDIVIDUAL”,“ENTERPRISE”,分别表示个人用户和企业用户。
    • 如果用户类型为个人,contactChinese必须与ownerChinese值相同,contactEnglish必须与ownerEnglish值相同。
    • 如果用户类型为企业,ownerChinese必须填企业全称,请不要填写法人。
    • 所有者中文名的长度均不能为空,也不能超过127。
    • 所有者英文名的长度均不能为空,也不能超过255。
    • 联系人中文名不能为空,长度不能超过10。
    • 联系人英文名不能为空,长度不能超过20。
    • 邮箱地址需要保证正确的格式。
    • 中文通讯地址的长度不能为空,也不能超过35。
    • 英文通讯地址的长度不能为空,也不能超过64。
    • 邮编为6位数字。
    • 手机号码为11位数字,前两位必须是13、14、15、17、18中的一个。
    • 区号为3位或4位数字,以0开头。
    • 电话号码为7到8位数字,也可加上3位以上的分机号,主号码和分机号要用-隔开。
    • 隐私保护参数为布尔值,true->开启;false->关闭,该参数不强制,默认值为false。
    • 自定义dns参数不强制,默认使用百度提供的DNS,形式如[ "ns1.bdydns.cn", "ns2.bdydns.cn" ],DNS个数最少2个,最多5个。

    返回

    返回头域

    除公共头域,无其它特殊头域。

    返回参数

    参数名称 类型 描述
    bceOrderId String 注册订单编号

    返回错误

    请参考附录

    示例

    请求示例

    POST /v1/domain/register_async HTTP/1.1
    Host: bcd.baidubce.com
    x-bce-date: 2016-05-03T09:54:08Z
    Content-Type: application/json; charset=utf-8 
    Authorization: bce-auth-v1/f932edbccdb04cec8e3307b1798f16e6/2016-05-03T09:54:08Z/3600/host;x-bce-date/d13cb40a2f86aeea2d625cceece02bdfe677b765a97da19913db08e9a0ed2efc
    
    {
        "domain" : "test.cn",
        "years" : 1,
        "privacy" : false,
        "userType" : "INDIVIDUAL",
        "ownerChinese" : "测试",
        "ownerEnglish" : "test",
        "contactChinese" : "测试",
        "contactEnglish" : "test",
        "email" : "test@baidu.com",
        "region" : {
            "province" : "110000",
            "city" : "110000"
        },
        "addressChinese" : "科技园",
        "addressEnglish" : "kejiyuan",
        "postalCode" : "100000",
        "mobilePhone" : "13812345678",
        "areaCode" : "010",
        "phoneNumber" : "12345678"
    }

    返回示例

    HTTP/1.1 200 OK
    x-bce-request-id: 254c08ad-e6bb-4298-ae68-96c7d3103e16
    Content-Type: application/json;charset=UTF-8
    Date: Tue, 03 May 2016 09:54:24 GMT
    Server: BWS
    Transfer-Encoding: chunked
    {
        "bceOrderId":"d80063bfdd72436d8252cad46b63f31d"
    }

    域名注册 (使用信息模板)

    描述

    本接口用于使用信息模板购买一个未被注册的域名。

    关于信息模板请参考查询信息模板列表

    请求

    请求结构

    POST /v{version}/domain/registerByTemplate HTTP/1.1
    Host: bcd.baidubce.com
    Authorization: authorization String
    {
        "domain" : domain,
        "years" : years,
        "privacy" : privacy,
        "templateId" : templateId,
        "dns" : dns
    }

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    domain String RequestBody参数 注册的域名名称
    years Integer RequestBody参数 域名的购买年限
    templateId String RequestBody参数 模板id
    privacy Boolean RequestBody参数 是否开启隐私保护(仅部分域名支持)
    dns List<String> RequestBody参数 自定义DNS

    请求备注

    • domain所注册的顶级域后缀请查看(英文域名默认顶级域后缀中文域名默认顶级域后缀), 域名的长度不能超过64。域名由英文字母(a-z,不区分大小写)、数字(0-9)、中文汉字以及连字符"-"(即中横线)构成,不能使用空格及特殊字符(如!、$、&、?等)。“-” 不能单独注册或连续使用,不能放在开头或结尾。中文域名可以直接使用中文,也可以使用punycode。
    • 域名的注册年限最少为1年,最多为10年。
    • 模板id,如果模板是已实名状态,注册成功的域名也将直接实名
    • 隐私保护参数为布尔值,true->开启;false->关闭,该参数不强制,默认值为false。
    • 自定义dns参数不强制,默认使用百度提供的DNS,形式如[ "ns1.bdydns.cn", "ns2.bdydns.cn" ],DNS个数最少2个,最多5个。

    返回

    返回头域

    除公共头域,无其它特殊头域。

    返回参数

    参数名称 类型 描述
    domain String 注册的域名名称
    registerResult boolean 注册的结果
    bceOrderId boolean 注册订单Id

    返回错误

    请参考附录

    示例

    请求示例

    POST /v1/domain/registerByTemplate HTTP/1.1
    Host: bcd.baidubce.com
    x-bce-date: 2016-05-03T09:54:08Z
    Content-Type: application/json; charset=utf-8 
    Authorization: bce-auth-v1/f932edbccdb04cec8e3307b1798f16e6/2016-05-03T09:54:08Z/3600/host;x-bce-date/d13cb40a2f86aeea2d625cceece02bdfe677b765a97da19913db08e9a0ed2efc
    
    {
        "domain" : "test.cn",
        "years" : 1,
        "privacy" : false,
        "templateId" : "5918793f4de057645b30738cb829894c",
    }

    返回示例

    HTTP/1.1 200 OK
    x-bce-request-id: 254c08ad-e6bb-4298-ae68-96c7d3103e16
    Content-Type: application/json;charset=UTF-8
    Date: Tue, 03 May 2016 09:54:24 GMT
    Server: BWS
    Transfer-Encoding: chunked
    {
        "domain":"test.cn",
        "registerResult":true
        "bceOrderId":"dcf728861d1e4cce8e346fcfcc765aac"
    }

    域名注册 (使用信息模板)(异步)

    描述

    本接口用于使用信息模板异步购买一个未被注册的域名。

    本接口返回速度远高于同步方法,但第一时间无法获取注册结果

    关于信息模板请参考查询信息模板列表

    请求

    请求结构

    POST /v{version}/domain/register_asyncByTemplate HTTP/1.1
    Host: bcd.baidubce.com
    Authorization: authorization String
    {
        "domain" : domain,
        "years" : years,
        "privacy" : privacy,
        "templateId" : templateId,
        "dns" : dns
    }

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    domain String RequestBody参数 注册的域名名称
    years Integer RequestBody参数 域名的购买年限
    templateId String RequestBody参数 模板id
    privacy Boolean RequestBody参数 是否开启隐私保护(仅部分域名支持)
    dns List<String> RequestBody参数 自定义DNS

    请求备注

    • domain所注册的顶级域后缀请查看(英文域名默认顶级域后缀中文域名默认顶级域后缀), 域名的长度不能超过64。域名由英文字母(a-z,不区分大小写)、数字(0-9)、中文汉字以及连字符"-"(即中横线)构成,不能使用空格及特殊字符(如!、$、&、?等)。“-” 不能单独注册或连续使用,不能放在开头或结尾。中文域名可以直接使用中文,也可以使用punycode。
    • 域名的注册年限最少为1年,最多为10年。
    • 模板id,如果模板是已实名状态,注册成功的域名也将直接实名
    • 隐私保护参数为布尔值,true->开启;false->关闭,该参数不强制,默认值为false。
    • 自定义dns参数不强制,默认使用百度提供的DNS,形式如[ "ns1.bdydns.cn", "ns2.bdydns.cn" ],DNS个数最少2个,最多5个。

    返回

    返回头域

    除公共头域,无其它特殊头域。

    返回参数

    参数名称 类型 描述
    bceOrderId String 异步注册生成的订单id

    返回错误

    请参考附录

    示例

    请求示例

    POST /v1/domain/register_asyncByTemplate HTTP/1.1
    Host: bcd.baidubce.com
    x-bce-date: 2016-05-03T09:54:08Z
    Content-Type: application/json; charset=utf-8 
    Authorization: bce-auth-v1/f932edbccdb04cec8e3307b1798f16e6/2016-05-03T09:54:08Z/3600/host;x-bce-date/d13cb40a2f86aeea2d625cceece02bdfe677b765a97da19913db08e9a0ed2efc
    
    {
        "domain" : "test.cn",
        "years" : 1,
        "privacy" : false,
        "templateId" : "5918793f4de057645b30738cb829894c",
    }

    返回示例

    HTTP/1.1 200 OK
    x-bce-request-id: 254c08ad-e6bb-4298-ae68-96c7d3103e16
    Content-Type: application/json;charset=UTF-8
    Date: Tue, 03 May 2016 09:54:24 GMT
    Server: BWS
    Transfer-Encoding: chunked
    {
        "bceOrderId":"891a617b00b64e0c978b921a2a76e7d2"
    }

    域名续费

    描述

    本接口用于对已购买的域名进行续费。

    请求

    请求结构

    POST /v{version}/domain/renew HTTP/1.1
    Host: bcd.baidubce.com
    Authorization: authorization string
    {
        "domain" : domain,
        "years" : years
    }

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    domain String RequestBody参数 域名名称
    years String RequestBody参数 续费年数

    请求备注

    • domain所注册的顶级域后缀请查看(英文域名默认顶级域后缀中文域名默认顶级域后缀), 域名的长度不能超过64。域名由英文字母(a-z,不区分大小写)、数字(0-9)、中文汉字以及连字符"-"(即中横线)构成,不能使用空格及特殊字符(如!、$、&、?等)。“-” 不能单独注册或连续使用,不能放在开头或结尾。中文域名可以直接使用中文,也可以使用punycode。
    • 域名的续费年限最少为1年,最多为9年。

    返回

    返回头域

    除公共头域,无其它特殊头域。

    返回参数

    参数名称 类型 描述
    renewResult boolean 续费的结果

    返回错误

    请参考附录

    示例

    请求示例

    POST /v1/domain/renew HTTP/1.1
    Host: bcd.baidubce.com
    x-bce-date: 2016-05-09T03:59:31Z
    Content-Type: application/json; charset=utf-8  
    Authorization: bce-auth-v1/f932edbccdb04cec8e3307b1798f16e6/2016-05-09T03:59:31Z/3600/host;x-bce-date/63916c6e4133de4352a2d43c046810b9a82a92bf325bec67da7d7eed9abb1169
    {
        "domain" : "doubletest3.cn",
        "years" : 3
    }

    返回示例

    HTTP/1.1 200 OK
    x-bce-request-id: 0305bf9a-bd8a-4d7e-b847-6893198fffba
    Content-Type: application/json;charset=UTF-8
    Date: Mon, 09 May 2016 03:59:38 GMT
    Server: BWS
    Transfer-Encoding: chunked
    
    {
        "renewResult":true
    }

    域名续费(异步)

    描述

    本接口用于对已购买的域名进行异步续费。

    请求

    请求结构

    POST /v{version}/domain/renew_async HTTP/1.1
    Host: bcd.baidubce.com
    Authorization: authorization string
    {
        "domain" : domain,
        "years" : years
    }

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    domain String RequestBody参数 域名名称
    years String RequestBody参数 续费年数

    请求备注

    • domain所注册的顶级域后缀请查看(英文域名默认顶级域后缀中文域名默认顶级域后缀), 域名的长度不能超过64。域名由英文字母(a-z,不区分大小写)、数字(0-9)、中文汉字以及连字符"-"(即中横线)构成,不能使用空格及特殊字符(如!、$、&、?等)。“-” 不能单独注册或连续使用,不能放在开头或结尾。中文域名可以直接使用中文,也可以使用punycode。
    • 域名的续费年限最少为1年,最多为9年。

    返回

    返回头域

    除公共头域,无其它特殊头域。

    返回参数

    参数名称 类型 描述
    bceOrderId String 续费订单Id

    返回错误

    请参考附录

    示例

    请求示例

    POST /v1/domain/renew_async HTTP/1.1
    Host: bcd.baidubce.com
    x-bce-date: 2016-05-09T03:59:31Z
    Content-Type: application/json; charset=utf-8  
    Authorization: bce-auth-v1/f932edbccdb04cec8e3307b1798f16e6/2016-05-09T03:59:31Z/3600/host;x-bce-date/63916c6e4133de4352a2d43c046810b9a82a92bf325bec67da7d7eed9abb1169
    {
        "domain" : "doubletest3.cn",
        "years" : 3
    }

    返回示例

    HTTP/1.1 200 OK
    x-bce-request-id: 0305bf9a-bd8a-4d7e-b847-6893198fffba
    Content-Type: application/json;charset=UTF-8
    Date: Mon, 09 May 2016 03:59:38 GMT
    Server: BWS
    Transfer-Encoding: chunked
    
    {
        "bceOrderId":"ebc26bbe159c43f7bb6ce779ceae9740"
    }

    订单状态查询

    描述

    本接口用于对注册、续费域名的订单状态进行查询。

    请求

    请求结构

    GET /v{version}/order/check HTTP/1.1
    Host: bcd.baidubce.com
    Authorization: authorization string
    {
        "bceOrderId" : bceOrderId,
    }

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    bceOrderId String RequestParam参数 域名订单Id

    请求备注

    返回

    返回头域

    除公共头域,无其它特殊头域。

    返回参数

    参数名称 类型 描述
    resourceId String 域名资源Id
    status OrderStatus 订单状态(INIT/RUNNING/SUCCESS/FAILED)
    createTime Date 订单创建时间
    updateTime Date 订单更新时间
    failReason String 订单失败原因

    返回错误

    请参考附录

    示例

    请求示例

    GET /v{version}/order/check HTTP/1.1
    Host: bcd.baidubce.com
    Authorization: authorization string
    {
        "bceOrderId" : "d80063bfdd72436d8252cad46b63f31d",
    }

    返回示例

    HTTP/1.1 200 OK
    x-bce-request-id: 0305bf9a-bd8a-4d7e-b847-6893198fffba
    Content-Type: application/json;charset=UTF-8
    Date: Mon, 09 May 2016 03:59:38 GMT
    Server: BWS
    Transfer-Encoding: chunked
    
    {
        {
            "list":
                [
                    {
                        "resourceId":"356fe99d-586d-472a-83c6-0a3fa95de364",
                        "status":"SUCCESS",
                        "createTime":"2019-08-12T05:57:38Z",
                        "updateTime":"2019-08-12T05:57:52Z"
                    }
                ]
        }
    }

    域名过户

    描述

    本接口用于对已购买的域名进行过户

    请求

    请求结构

    POST /v{version}/domain/owner/edit HTTP/1.1
    Host: bcd.baidubce.com
    Authorization: authorization string
    {
        "domain" : domain,
        "userType" : userType,
        "ownerChinese" : ownerChinese,
        "ownerEnglish" : ownerEnglish,
        "contactChinese" : contactChinese,
    	"contactEnglish" : contactEnglish,
    	"email" : email
    }

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    domain String RequestBody参数 域名名称
    userType String RequestBody参数 用户类型
    ownerChinese String RequestBody参数 所有者中文名
    ownerEnglish String RequestBody参数 所有者英文名
    contactChinese String RequestBody参数 联系人中文名
    contactEnglish String RequestBody参数 联系人英文名
    email String RequestBody参数 邮箱地址

    请求备注

    • domain所注册的顶级域后缀请查看(英文域名默认顶级域后缀中文域名默认顶级域后缀), 域名的长度不能超过64。域名由英文字母(a-z,不区分大小写)、数字(0-9)、中文汉字以及连字符"-"(即中横线)构成,不能使用空格及特殊字符(如!、$、&、?等)。“-” 不能单独注册或连续使用,不能放在开头或结尾。中文域名可以直接使用中文,也可以使用punycode。
    • 用户类型可选值为“INDIVIDUAL”,“ENTERPRISE”,分别表示个人用户和企业用户。
    • 如果用户类型为个人,contactChinese必须与ownerChinese值相同,contactEnglish必须与ownerEnglish值相同。
    • 如果用户类型为企业,ownerChinese必须填企业全称,请不要填写法人。
    • 所有者中文名不能为空,长度不能超过127。
    • 所有者英文名不能为空,长度不能超过255。
    • 联系人中文名不能为空,长度不能超过10。
    • 联系人英文名不能为空,长度不能超过20。
    • 邮箱地址需要保证正确的格式。

    返回

    返回头域

    除公共头域,无其它特殊头域。

    返回参数

    无,返回200状态码则代表成功。

    返回错误

    请参考附录

    示例

    请求示例

    POST /v1/domain/owner/edit HTTP/1.1
    Host: bcd.baidubce.com
    x-bce-date: 2016-05-09T03:59:31Z
    Content-Type: application/json; charset=utf-8  
    Authorization: bce-auth-v1/f932edbccdb04cec8e3307b1798f16e6/2016-05-09T03:59:31Z/3600/host;x-bce-date/63916c6e4133de4352a2d43c046810b9a82a92bf325bec67da7d7eed9abb1169
    {
        "domain" : "owneredittest.cn",
        "userType" : "INDIVIDUAL",
        "ownerChinese" : "测试",
        "ownerEnglish" : "test",
        "contactChinese" : "测试",
    	"contactEnglish" : "test",
    	"email" : "test@baidu.com"
    }

    返回示例

    HTTP/1.1 200 OK
    x-bce-request-id: 0305bf9a-bd8a-4d7e-b847-6893198fffba
    Content-Type: application/json;charset=UTF-8
    Date: Mon, 09 May 2016 03:59:38 GMT
    Server: BWS
    Transfer-Encoding: chunked

    域名过户(使用信息模板)

    描述

    本接口用于对已购买的域名进行过户,使用已经通过实名认证的模板。

    关于信息模板请参考查询信息模板列表

    请求

    请求结构

    PUT /v{version}/domain/{domainName}/contact?update&templateId={templateId} HTTP/1.1
    Host: bcd.baidubce.com
    Authorization: authorization string

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    domainName String PathVariable参数 域名名称
    templateId String RequestParam参数 信息模板ID,只能使用通过实名认证的模板

    请求备注

    • templateId只能使用通过实名认证的模板

    返回

    返回头域

    除公共头域,无其它特殊头域

    返回参数

    无,返回200状态码则代表成功

    返回错误请参考附录

    示例

    请求示例

    PUT /v2/domain/baidu.com/contact?update&templateId=c8381f465bb9300a07d2867f0e6ee9a9 HTTP/1.1
    Authorization: bce-auth-v1/2647e9da8eab431cbe58eaa6c1d46cdc/2017-08-09T04:03:10Z/3600/host;x-bce-date/466ea0c6f8baf4dddf0c9eae8a46a94002efbc6669020166b93eeae341e16c60
    Content-Type: application/json
    Host: bcd.baidubce.com
    x-bce-console-rpc-id: c396cef6-0ffe-4453-87ee-ffc2064bac75
    x-bce-date: 2017-08-09T04:03:10Z

    返回示例

    HTTP/1.1 200 OK
    Cache-Control: no-cache
    Content-Length: 0
    Date: Wed, 09 Aug 2017 04:03:15 GMT
    Server: BWS
    x-bce-request-id: 8c665f96-1d49-493c-8a4c-5f697bea7c5e

    修改域名联系人

    描述

    本接口用于对已购买的域名修改联系人信息。

    请求

    请求结构

    POST /v{version}/domain/contact/edit HTTP/1.1
    Host: bcd.baidubce.com
    Authorization: authorization string
    {
        "domain" : domain,
        "region" : {
            "province" : province,
            "city" : city
        },
        "addressChinese" : addressChinese,
        "addressEnglish" : addressEnglish,
        "postalCode" : postalCode,
        "mobilePhone" : mobilePhone,
        "areaCode" : areaCode,
        "phoneNumber" : phoneNumber
    }

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    domain String RequestBody参数 域名名称
    region Region RequestBody参数 所属区域
    addressChinese String RequestBody参数 通讯地址-中文
    addressEnglish String RequestBody参数 通讯地址-英文
    postalCode String RequestBody参数 邮编
    mobilePhone String RequestBody参数 手机
    areaCode String RequestBody参数 区号
    phoneNumber String RequestBody参数 电话号码

    请求备注

    • domain所注册的顶级域后缀请查看(英文域名默认顶级域后缀中文域名默认顶级域后缀), 域名的长度不能超过64。域名由英文字母(a-z,不区分大小写)、数字(0-9)、中文汉字以及连字符"-"(即中横线)构成,不能使用空格及特殊字符(如!、$、&、?等)。“-” 不能单独注册或连续使用,不能放在开头或结尾。中文域名可以直接使用中文,也可以使用punycode。
    • 中文通讯地址不能为空,长度不能超过35。
    • 英文通讯地址不能为空,长度不能超过128。
    • 邮编为6位数字。
    • 手机号码为11位数字,前两位必须是13、14、15、17、18中的一个。
    • 区号为3位或4位数字,以0开头。
    • 电话号码为7到8位数字,也可加上3位以上的分机号,主号码和分机号要用-隔开。

    返回

    返回头域

    除公共头域,无其它特殊头域。

    返回参数

    无,返回200状态码则代表成功。

    返回错误

    请参考附录

    示例

    请求示例

    POST /v1/domain/contact/edit HTTP/1.1
    Host: bcd.baidubce.com
    x-bce-date: 2016-05-09T03:59:31Z
    Content-Type: application/json; charset=utf-8  
    Authorization: bce-auth-v1/f932edbccdb04cec8e3307b1798f16e6/2016-05-09T03:59:31Z/3600/host;x-bce-date/63916c6e4133de4352a2d43c046810b9a82a92bf325bec67da7d7eed9abb1169
    
    {
        "domain" : "contactedittest.cn",
        "region" : {
            "province" : "110000",
            "city" : "110000"
        },
        "addressChinese" : "科技园",
        "addressEnglish" : "Ke Ji Yuan",
        "postalCode" : "100000",
        "mobilePhone" : "13812345678",
        "areaCode" : "010",
        "phoneNumber" : "12345678"
    }

    返回示例

    HTTP/1.1 200 OK
    x-bce-request-id: 0305bf9a-bd8a-4d7e-b847-6893198fffba
    Content-Type: application/json;charset=UTF-8
    Date: Mon, 09 May 2016 03:59:38 GMT
    Server: BWS
    Transfer-Encoding: chunked

    设置隐私保护开关(由于欧盟隐私保护法,当前接口不生效)

    描述

    本接口用于对已购买的域名设置是否需要启用隐私保护

    请求

    请求结构

    POST /v{version}/domain/privacy/edit HTTP/1.1
    Host: bcd.baidubce.com
    Authorization: authorization string
    {
        "domain" : domain,
        "privacy" : privacy
    }

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    domain String RequestBody参数 域名名称
    privacy Boolean RequestBody参数 是否开启隐私保护(仅部分域名支持)

    请求备注

    • domain所注册的顶级域后缀请查看(英文域名默认顶级域后缀中文域名默认顶级域后缀), 域名的长度不能超过64。域名由英文字母(a-z,不区分大小写)、数字(0-9)、中文汉字以及连字符"-"(即中横线)构成,不能使用空格及特殊字符(如!、$、&、?等)。“-” 不能单独注册或连续使用,不能放在开头或结尾。中文域名可以直接使用中文,也可以使用punycode。
    • 隐私保护参数为布尔值,true->开启;false->关闭

    返回

    返回头域

    除公共头域,无其它特殊头域。

    返回参数

    无,返回200状态码则代表成功。

    返回错误

    请参考附录

    示例

    请求示例

    POST /v1/domain/privacy/edit HTTP/1.1
    Host: bcd.baidubce.com
    x-bce-date: 2016-05-09T03:59:31Z
    Content-Type: application/json; charset=utf-8  
    Authorization: bce-auth-v1/f932edbccdb04cec8e3307b1798f16e6/2016-05-09T03:59:31Z/3600/host;x-bce-date/63916c6e4133de4352a2d43c046810b9a82a92bf325bec67da7d7eed9abb1169
    
    {
        "domain" : "privacyedittest.cn",
        "privacy" : "true"
    }

    返回示例

    HTTP/1.1 200 OK
    x-bce-request-id: 0305bf9a-bd8a-4d7e-b847-6893198fffba
    Content-Type: application/json;charset=UTF-8
    Date: Mon, 09 May 2016 03:59:38 GMT
    Server: BWS
    Transfer-Encoding: chunked

    设置自定义DNS

    描述

    本接口用于修改已购买的域名的dns服务器地址。

    请求

    请求结构

    POST /v{version}/domain/changeDns HTTP/1.1
    Host: bcd.baidubce.com
    Authorization: authorization string
    {
      "dns" : dns,
      "domain" : domain
    }

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    domain String RequestBody参数 域名名称
    dns List<String> RequestBody参数 自定义DNS

    请求备注

    • domain所注册的顶级域后缀请查看(英文域名默认顶级域后缀中文域名默认顶级域后缀), 域名的长度不能超过64。域名由英文字母(a-z,不区分大小写)、数字(0-9)、中文汉字以及连字符"-"(即中横线)构成,不能使用空格及特殊字符(如!、$、&、?等)。“-” 不能单独注册或连续使用,不能放在开头或结尾。中文域名可以直接使用中文,也可以使用punycode。
    • 自定义dns参数不强制,默认使用百度提供的DNS,形式如[ "ns1.bdydns.cn", "ns2.bdydns.cn" ],DNS个数最少2个,最多5个。

    返回

    返回头域

    除公共头域,无其它特殊头域。

    返回参数

    无,返回200状态码则代表成功。

    返回错误

    请参考附录

    示例

    请求示例

    POST /v1/domain/changeDns HTTP/1.1
    Host: bcd.baidubce.com
    x-bce-date: 2016-05-09T03:59:31Z
    Content-Type: application/json; charset=utf-8  
    Authorization: bce-auth-v1/f932edbccdb04cec8e3307b1798f16e6/2016-05-09T03:59:31Z/3600/host;x-bce-date/63916c6e4133de4352a2d43c046810b9a82a92bf325bec67da7d7eed9abb1169
    
    {
      "dns" : [ "ns1.bdydns.cn", "ns2.bdydns.cn" ],
      "domain" : "iq6dq8it9s3.com"
    }

    返回示例

    HTTP/1.1 200 OK
    x-bce-request-id: 0305bf9a-bd8a-4d7e-b847-6893198fffba
    Content-Type: application/json;charset=UTF-8
    Date: Mon, 09 May 2016 03:59:38 GMT
    Server: BWS
    Transfer-Encoding: chunked

    上传实名认证资料

    描述

    本接口用于对未实名认证的域名上传实名认证资料。

    请求

    请求结构

    PUT /v{version}/domain/{domainName}/contact?audit HTTP/1.1
    Host: bcd.baidubce.com
    Authorization: authorization string
    {
      "ownerCode" : ownerCode,
      "auditFile" : auditFile,
      "certType" : certType
    }

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    domainName String PathVariable参数 域名名称
    ownerCode String RequestBody参数 证件号码
    auditFile String RequestBody参数 证件图片的byte数组所转成的Base64字符串
    certType String RequestBody参数 证件类型,具体取值参考证件类型列表

    请求备注

    • domainName所注册的顶级域后缀请查看(英文域名默认顶级域后缀中文域名默认顶级域后缀), 域名的长度不能超过64。域名由英文字母(a-z,不区分大小写)、数字(0-9)、中文汉字以及连字符"-"(即中横线)构成,不能使用空格及特殊字符(如!、$、&、?等)。“-” 不能单独注册或连续使用,不能放在开头或结尾。中文域名可以直接使用中文,也可以使用punycode。
    • ownerCode是证件号码,如域名所有者为个人,则填写身份证号;如域名所有者为企业,则填写企业营业执照注册号或组织机构代码证代码。
    • auditFile参数是证件图片的byte数组所转成的Base64字符串。如域名所有者为个人,则提供身份证正面的扫描件;如域名所有者为企业,则提供与所有者证件号码一致的营业执照或组织机构代码证副本扫描件或数码照片。以java为例,可使用Base64.encodeBase64String(IOUtils.toByteArray(new FileInputStream(filePath)))方法获得图像文件的Base64字符串。

    返回

    返回头域

    除公共头域,无其它特殊头域。

    返回参数

    无,返回200状态码则代表成功。

    返回错误

    请参考附录

    示例

    请求示例

    PUT /v2/domain/test.com/contact?audit HTTP/1.1
    Host: bcd.baidubce.com
    x-bce-date: 2016-05-09T03:59:31Z
    Content-Type: application/json; charset=utf-8  
    Authorization: bce-auth-v1/f932edbccdb04cec8e3307b1798f16e6/2016-05-09T03:59:31Z/3600/host;x-bce-date/63916c6e4133de4352a2d43c046810b9a82a92bf325bec67da7d7eed9abb1169
    
    {
      "ownerCode" : "320911199006250320",
      "auditFile" : "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDh............",
      "certType" : "SFZ"
    }

    返回示例

    HTTP/1.1 200 OK
    x-bce-request-id: 0305bf9a-bd8a-4d7e-b847-6893198fffba
    Content-Type: application/json;charset=UTF-8
    Date: Mon, 09 May 2016 03:59:38 GMT
    Server: BWS
    Transfer-Encoding: chunked

    查询实名认证状态

    描述

    本接口用于查询域名的实名认证状态,如果认证失败则返回失败原因。

    请求

    请求结构

    GET /v{version}/domain/audit?domain={domain} HTTP/1.1
    Host: bcd.baidubce.com
    Authorization: authorization string

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    domain String RequestParam参数 域名名称

    请求备注

    • domain所注册的顶级域后缀请查看(英文域名默认顶级域后缀中文域名默认顶级域后缀), 域名的长度不能超过64。域名由英文字母(a-z,不区分大小写)、数字(0-9)、中文汉字以及连字符"-"(即中横线)构成,不能使用空格及特殊字符(如!、$、&、?等)。“-” 不能单独注册或连续使用,不能放在开头或结尾。中文域名可以直接使用中文,也可以使用punycode。

    返回

    返回头域

    除公共头域,无其它特殊头域。

    返回参数

    参数名称 类型 描述
    domain String 域名
    verifyStatus String 实名认证状态,值为NONVERIFY/AUDIT/RETURN/NORMAL/null,未实名认证、实名认证中、实名认证失败、实名认证成功、该域名无须实名认证
    description String 如果实名认证失败,认证失败的原因

    返回错误

    请参考附录

    示例

    请求示例

    GET /v1/domain/audit?domain=test.com HTTP/1.1
    Host: bcd.baidubce.com
    x-bce-date: 2016-05-09T03:59:31Z
    Content-Type: application/json; charset=utf-8  
    Authorization: bce-auth-v1/f932edbccdb04cec8e3307b1798f16e6/2016-05-09T03:59:31Z/3600/host;x-bce-date/63916c6e4133de4352a2d43c046810b9a82a92bf325bec67da7d7eed9abb1169

    返回示例

    HTTP/1.1 200 OK
    x-bce-request-id: 0305bf9a-bd8a-4d7e-b847-6893198fffba
    Content-Type: application/json;charset=UTF-8
    Date: Mon, 09 May 2016 03:59:38 GMT
    Server: BWS
    Transfer-Encoding: chunked
    {
        "domain": "test.cn",
        "verifyStatus": "RETURN",
        "description": "域名所有者信息为个人信息,提交的资料与所有者信息不一致。"
    }

    查询域名详情

    描述

    本接口用于查询已购买域名的详情信息。

    请求

    请求结构

    GET /v{version}/domain/detail?domain={domain} HTTP/1.1
    Host: bcd.baidubce.com
    Authorization: authorization string

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    domain String RequestParam参数 域名名称

    请求备注

    • domain所注册的顶级域后缀请查看(英文域名默认顶级域后缀中文域名默认顶级域后缀), 域名的长度不能超过64。域名由英文字母(a-z,不区分大小写)、数字(0-9)、中文汉字以及连字符"-"(即中横线)构成,不能使用空格及特殊字符(如!、$、&、?等)。“-” 不能单独注册或连续使用,不能放在开头或结尾。中文域名可以直接使用中文,也可以使用punycode。

    返回

    返回头域

    除公共头域,无其它特殊头域。

    返回参数

    参数名称 类型 描述
    domain String 域名
    expireTime String 到期时间,格式为yyyy-MM-ddTHH:mm:ssZ,采用UTC时间,示例:2017-07-26T14:47:10Z
    expireTimestamp Long 到期时间戳,单位为秒,示例:1501080430
    userType String 所有者类型
    ownerChinese String 所有者中文名
    ownerEnglish String 所有者英文名
    contactChinese String 联系人中文名
    contactEnglish String 联系人英文名
    email String 注册邮箱
    region Region 地区
    addressChinese String 中文地址
    addressEnglish String 英文地址
    postalCode String 邮政编码
    mobilePhone String 手机
    countryCode String 联系电话的国家区号
    areaCode String 联系电话的城市区号
    phoneNumber String 联系电话
    privacy Boolean 是否开启隐私保护
    supportPrivacy Boolean 是否支持开启隐私保护
    status String 域名状态,RUNNING/PENDING,运行中、未验证
    verifyStatus String 实名认证状态,值为NONVERIFY/AUDIT/RETURN/NORMAL/null,未实名认证、实名认证中、实名认证失败、实名认证成功、该域名无须实名认证
    dns List<String> 域名的DNS地址
    enableRecharge Boolean 是否可以续费
    noRechargeReason String 如果不能续费,不能续费的原因

    返回错误

    请参考附录

    示例

    请求示例

    GET /v1/domain/detail?domain=mydomain.com HTTP/1.1
    Host: bcd.baidubce.com
    x-bce-date: 2016-05-09T03:59:31Z
    Content-Type: application/json; charset=utf-8  
    Authorization: bce-auth-v1/f932edbccdb04cec8e3307b1798f16e6/2016-05-09T03:59:31Z/3600/host;x-bce-date/63916c6e4133de4352a2d43c046810b9a82a92bf325bec67da7d7eed9abb1169

    返回示例

    HTTP/1.1 200 OK
    x-bce-request-id: 0305bf9a-bd8a-4d7e-b847-6893198fffba
    Content-Type: application/json;charset=UTF-8
    Date: Mon, 09 May 2016 03:59:38 GMT
    Server: BWS
    Transfer-Encoding: chunked
    {
        "domain": "mydomain.com",
        "expireTime": "2017-07-26T14:47:10Z",
        "userType": "INDIVIDUAL",
        "ownerChinese": "张三",
        "ownerEnglish": "Zhang San",
        "contactChinese": "张三",
        "contactEnglish": "Zhang San",
        "email": "zhangsan@test.com",
        "region": {
            "province": "110000",
            "city": "110000",
            "country": "086"
        },
        "addressChinese": "北京",
        "addressEnglish": "Beijing",
        "postalCode": "200000",
        "mobilePhone": "13816520733",
        "countryCode": "086",
        "areaCode": "021",
        "phoneNumber": "1000000",
        "privacy": false,
        "supportPrivacy": false,
        "status": "RUNNING",
        "verifyStatus": "NONVERIFY",
        "dns": [
            "ns3.baidudns.xyz",
            "ns4.baidudns.xyz"
        ],
        "enableRecharge": false,
        "noRechargeReason": "cn域名自注册起5天内不能续费"
    }

    查询域名解析记录列表

    描述

    本接口用于查询单个域名的解析记录,含分页功能。

    请求

    请求结构

    POST /v{version}/domain/resolve/list HTTP/1.1
    Host: bcd.baidubce.com
    Authorization: authorization string
    {
      "domain" : domain,
      "pageNo" : pageNo,
      "pageSize" : pageSize
    }

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    domain String RequestBody参数 域名名称
    pageNo Integer RequestBody参数 页码
    pageSize Integer RequestBody参数 每页最多显示记录条数

    请求备注

    • domain所注册的顶级域后缀请查看(英文域名默认顶级域后缀中文域名默认顶级域后缀), 域名的长度不能超过64。域名由英文字母(a-z,不区分大小写)、数字(0-9)、中文汉字以及连字符"-"(即中横线)构成,不能使用空格及特殊字符(如!、$、&、?等)。“-” 不能单独注册或连续使用,不能放在开头或结尾。中文域名可以直接使用中文,也可以使用punycode。
    • pageNo为页码,非必填项,默认为1。
    • pageSize为每页最多显示记录条数,非必填项,默认为100。

    返回

    返回头域

    除公共头域,无其它特殊头域。

    返回参数

    参数名称 类型 描述
    orderBy String 排序的key
    order String 排列顺序,默认都是desc,按从大到小排列
    pageNo Integer 页码
    pageSize Integer 每页显示最多记录条数
    recordId Integer 解析记录ID
    domain String 主机名称,例如www或*或@,非完整域名
    view String 解析路线,默认(DEFAULT),移动(CMNET),联通(CNC),教育(EDU),百度搜索引擎(SEARCH)之一
    rdtype String 解析记录类型:A,AAAA,CNAME,NS,TXT,MX之一
    ttl Integer DNS缓存时间,单位为秒,最小1分钟,最大1小时
    rdata String 解析记录内容,一般是域名或IP,如果是MX类记录,则是包含pri和dest_domain的一个json字符串(参考示例返回)
    zoneName String 解析记录所属的域名,例如test.com
    status String 解析记录状态,RUNNING或STOPPED,当前API未提供暂停解析的接口,所以一般都是RUNNING
    totalCount Integer 返回记录实际条数

    返回错误

    请参考附录

    示例

    请求示例

    POST /v1/domain/resolve/list HTTP/1.1
    Host: bcd.baidubce.com
    x-bce-date: 2016-05-09T03:59:31Z
    Content-Type: application/json; charset=utf-8  
    Authorization: bce-auth-v1/f932edbccdb04cec8e3307b1798f16e6/2016-05-09T03:59:31Z/3600/host;x-bce-date/63916c6e4133de4352a2d43c046810b9a82a92bf325bec67da7d7eed9abb1169
    
    {
      "domain" : "e3rbtgm5mfek17sfresolvetest.com",
      "pageNo" : 1,
      "pageSize" : 100
    }

    返回示例

    HTTP/1.1 200 OK
    x-bce-request-id: 0305bf9a-bd8a-4d7e-b847-6893198fffba
    Content-Type: application/json;charset=UTF-8
    Date: Mon, 09 May 2016 03:59:38 GMT
    Server: BWS
    Transfer-Encoding: chunked
    
    {
            "orderBy": "resourceId",
            "order": "desc",
            "pageNo": 1,
            "pageSize": 100,
            "result": [
                {
                    "recordId": 870,
                    "domain": "*.lkt5urctum5sp0p7",
                    "view": "DEFAULT",
                    "rdtype": "CNAME",
                    "ttl": 600,
                    "rdata": "www.baidu.com.",
                    "zoneName": "e3rbtgm5mfek17sfresolvetest.com",
                    "status": "RUNNING"
                },
                {
                    "recordId": 932,
                    "domain": "1l07uevh6o3j7lic",
                    "view": "DEFAULT",
                    "rdtype": "MX",
                    "ttl": 600,
                    "rdata": "{\"pri\":1,\"dest_domain\":\"xn--fiq228c.com.\"}",
                    "zoneName": "e3rbtgm5mfek17sfresolvetest.com",
                    "status": "RUNNING"
                },
                {
                    "recordId": 908,
                    "domain": "vgbp6e89lp61nuht",
                    "view": "DEFAULT",
                    "rdtype": "A",
                    "ttl": 600,
                    "rdata": "1.1.1.1",
                    "zoneName": "e3rbtgm5mfek17sfresolvetest.com",
                    "status": "RUNNING"
                }
            ],
            "totalCount": 3
        }
        

    添加域名解析记录

    描述

    本接口用于对已生效的域名添加一条解析记录。

    请求

    请求结构

    POST /v{version}/domain/resolve/add HTTP/1.1
    Host: bcd.baidubce.com
    Authorization: authorization string
    {
      "domain" : domain,
      "view" : view,
      "rdType" : rdType,
      "ttl" : ttl,
      "rdata" : rdata,
      "zoneName" : zoneName
    }

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    domain String RequestBody参数 主机名称,例如www或*或@,非完整域名
    view String RequestBody参数 解析路线
    rdType String RequestBody参数 解析记录类型
    ttl Integer RequestBody参数 DNS缓存时间
    rdata String RequestBody参数 解析记录内容
    zoneName String RequestBody参数 解析记录所属的域名,例如baidubceyun.cn

    请求备注

    • domain 主机名称,常用如下:

      1. www:解析后域名为 www.baidubceyun.cn;
      2. @:直接解析主域名 baidubceyun.cn;
      3. :泛解析,匹配其他所有域名 .baidubceyun.cn。
    • view 解析路线,可以不填,填的话必须是DEFAULT(默认),CMNET(移动),CNC(联通),EDU(教育),SEARCH(百度搜索引擎)之一。
    • rdType 解析记录类型:A,AAAA,CNAME,NS,TXT,MX之一。
    • ttl DNS缓存时间,单位为秒,默认为10分钟,最小1分钟,最大1小时。
    • rdata 解析记录内容,必须与rdType匹配,rdType为A的rdata必须是IPV4格式;rdType为AAAA的rdata必须是IPV6格式;CNAME和NS的rdata必须是域名;TXT的rdata无格式要求;rdType为MX的rdata是包含pri和dest_domain的一个json字符串(请参考示例3)。
    • zoneName 所注册的顶级域后缀请查看(英文域名默认顶级域后缀中文域名默认顶级域后缀), 域名的长度不能超过64。域名由英文字母(a-z,不区分大小写)、数字(0-9)、中文汉字以及连字符"-"(即中横线)构成,不能使用空格及特殊字符(如!、$、&、?等)。“-” 不能单独注册或连续使用,不能放在开头或结尾。中文域名可以直接使用中文,也可以使用punycode。

    返回

    返回头域

    除公共头域,无其它特殊头域。

    返回参数

    无,返回200状态码则代表成功。

    返回错误

    请参考附录

    示例

    请求示例1

    POST /v1/domain/resolve/add HTTP/1.1
    Host: bcd.baidubce.com
    x-bce-date: 2016-05-09T03:59:31Z
    Content-Type: application/json; charset=utf-8  
    Authorization: bce-auth-v1/f932edbccdb04cec8e3307b1798f16e6/2016-05-09T03:59:31Z/3600/host;x-bce-date/63916c6e4133de4352a2d43c046810b9a82a92bf325bec67da7d7eed9abb1169
    
    {
      "domain" : "www",
      "view" : "DEFAULT",
      "rdType" : "A",
      "ttl" : 600,
      "rdata" : "0.0.0.0",
      "zoneName" : "e3rbtgm5mfek17sfresolvetest.com"
    }

    请求示例2

    POST /v1/domain/resolve/add HTTP/1.1
    Host: bcd.baidubce.com
    x-bce-date: 2016-05-09T03:59:31Z
    Content-Type: application/json; charset=utf-8  
    Authorization: bce-auth-v1/f932edbccdb04cec8e3307b1798f16e6/2016-05-09T03:59:31Z/3600/host;x-bce-date/63916c6e4133de4352a2d43c046810b9a82a92bf325bec67da7d7eed9abb1169
    
    {
      "domain" : "*.test",
      "view" : "DEFAULT",
      "rdType" : "CNAME",
      "ttl" : 600,
      "rdata" : "www.baidu.com",
      "zoneName" : "e3rbtgm5mfek17sfresolvetest.com"
    }

    请求示例3

    POST /v1/domain/resolve/add HTTP/1.1
    Host: bcd.baidubce.com
    x-bce-date: 2016-05-09T03:59:31Z
    Content-Type: application/json; charset=utf-8  
    Authorization: bce-auth-v1/f932edbccdb04cec8e3307b1798f16e6/2016-05-09T03:59:31Z/3600/host;x-bce-date/63916c6e4133de4352a2d43c046810b9a82a92bf325bec67da7d7eed9abb1169
    
    {
      "domain" : "mxtest",
      "rdType" : "MX",
      "rdata" : "{\"pri\":1,\"dest_domain\":\"fiq228c.com\"}",
      "zoneName" : "81ah34apw1k.com"
    }

    请求示例4

    POST /v1/domain/resolve/add HTTP/1.1
    Host: bcd.baidubce.com
    x-bce-date: 2016-05-09T03:59:31Z
    Content-Type: application/json; charset=utf-8  
    Authorization: bce-auth-v1/f932edbccdb04cec8e3307b1798f16e6/2016-05-09T03:59:31Z/3600/host;x-bce-date/63916c6e4133de4352a2d43c046810b9a82a92bf325bec67da7d7eed9abb1169
    
    {
      "domain" : "4f3tblvldmh3n8ri",
      "rdType" : "AAAA",
      "rdata" : "1:2:3:4:5:6:7:8",
      "zoneName" : "e3rbtgm5mfek17sfresolvetest.com"
    }

    请求示例5

    POST /v1/domain/resolve/add HTTP/1.1
    Host: bcd.baidubce.com
    x-bce-date: 2016-05-09T03:59:31Z
    Content-Type: application/json; charset=utf-8  
    Authorization: bce-auth-v1/f932edbccdb04cec8e3307b1798f16e6/2016-05-09T03:59:31Z/3600/host;x-bce-date/63916c6e4133de4352a2d43c046810b9a82a92bf325bec67da7d7eed9abb1169
    
    {
      "domain" : "joiflq69deptas5s",
      "rdType" : "NS",
      "rdata" : "ns1.bdydns.com",
      "zoneName" : "e3rbtgm5mfek17sfresolvetest.com"
    }    

    请求示例6

    POST /v1/domain/resolve/add HTTP/1.1
    Host: bcd.baidubce.com
    x-bce-date: 2016-05-09T03:59:31Z
    Content-Type: application/json; charset=utf-8  
    Authorization: bce-auth-v1/f932edbccdb04cec8e3307b1798f16e6/2016-05-09T03:59:31Z/3600/host;x-bce-date/63916c6e4133de4352a2d43c046810b9a82a92bf325bec67da7d7eed9abb1169
    
    {
      "domain" : "qve1bi51skvb49ba",
      "rdType" : "TXT",
      "rdata" : "hello",
      "zoneName" : "e3rbtgm5mfek17sfresolvetest.com"
    }
        

    返回示例

    HTTP/1.1 200 OK
    x-bce-request-id: 0305bf9a-bd8a-4d7e-b847-6893198fffba
    Content-Type: application/json;charset=UTF-8
    Date: Mon, 09 May 2016 03:59:38 GMT
    Server: BWS
    Transfer-Encoding: chunked

    删除域名解析记录

    描述

    本接口用于删除一条域名解析记录。

    请求

    请求结构

    POST /v{version}/domain/resolve/delete HTTP/1.1
    Host: bcd.baidubce.com
    Authorization: authorization string
    {
      "zoneName" : zoneName,
      "recordId" : recordId
    }

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    recordId Integer RequestBody参数 解析记录ID
    zoneName String RequestBody参数 解析记录所属的域名,例如baidubceyun.cn

    请求备注

    • recordId 解析记录唯一标识,从list接口获取。
    • zoneName 所注册的顶级域后缀请查看(英文域名默认顶级域后缀中文域名默认顶级域后缀), 域名的长度不能超过64。域名由英文字母(a-z,不区分大小写)、数字(0-9)、中文汉字以及连字符"-"(即中横线)构成,不能使用空格及特殊字符(如!、$、&、?等)。“-” 不能单独注册或连续使用,不能放在开头或结尾。中文域名可以直接使用中文,也可以使用punycode。

    返回

    返回头域

    除公共头域,无其它特殊头域。

    返回参数

    无,返回200状态码则代表成功。

    返回错误

    请参考附录

    示例

    请求示例

    POST /v1/domain/resolve/delete HTTP/1.1
    Host: bcd.baidubce.com
    Authorization: authorization string
    {
      "zoneName" : "e3rbtgm5mfek17sfresolvetest.com",
      "recordId" : 950
    }

    返回示例

    HTTP/1.1 200 OK
    x-bce-request-id: 0305bf9a-bd8a-4d7e-b847-6893198fffba
    Content-Type: application/json;charset=UTF-8
    Date: Mon, 09 May 2016 03:59:38 GMT
    Server: BWS
    Transfer-Encoding: chunked

    更新域名解析记录

    描述

    本接口用于更新一条域名解析记录。

    请求

    请求结构

    POST /v{version}/domain/resolve/edit HTTP/1.1
    Host: bcd.baidubce.com
    Authorization: authorization string
    {
      "domain" : domain,
      "rdType" : rdType,
      "view" : view,
      "rdata" : rdata,
      "ttl" : ttl,
      "zoneName" : zoneName,
      "recordId" : recordId
    }

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    recordId Integer RequestBody参数 解析记录ID
    domain String RequestBody参数 主机名称,例如www或*或@,非完整域名
    view String RequestBody参数 解析路线
    rdType String RequestBody参数 解析记录类型
    ttl Integer RequestBody参数 DNS缓存时间
    rdata String RequestBody参数 解析记录内容
    zoneName String RequestBody参数 解析记录所属的域名,例如baidubceyun.cn

    请求备注

    • recordId 解析记录唯一标识,从list接口获取。
    • domain 主机名称,常用如下:

      1. www:解析后域名为 www.baidubceyun.cn;
      2. @:直接解析主域名 baidubceyun.cn;
      3. :泛解析,匹配其他所有域名 .baidubceyun.cn。
    • view 解析路线,可以不填,填的话必须是DEFAULT(默认),CMNET(移动),CNC(联通),EDU(教育),SEARCH(百度搜索引擎)之一。
    • rdType 解析记录类型:A,AAAA,CNAME,NS,TXT,MX之一。
    • ttl DNS缓存时间,单位为秒,默认为10分钟,最小1分钟,最大1小时。
    • rdata 解析记录内容,必须与rdType匹配,rdType为A的rdata必须是IPV4格式;rdType为AAAA的rdata必须是IPV6格式;CNAME和NS的rdata必须是域名;TXT的rdata无格式要求;rdType为MX的rdata是包含pri和dest_domain的一个json字符串(请参考示例3)。
    • zoneName 所注册的顶级域后缀请查看(英文域名默认顶级域后缀中文域名默认顶级域后缀), 域名的长度不能超过64。域名由英文字母(a-z,不区分大小写)、数字(0-9)、中文汉字以及连字符"-"(即中横线)构成,不能使用空格及特殊字符(如!、$、&、?等)。“-” 不能单独注册或连续使用,不能放在开头或结尾。中文域名可以直接使用中文,也可以使用punycode。
    • 只有ttl, rdType, rdata三个参数可以更新,其他字段必须与创建时保持一致。

    返回

    返回头域

    除公共头域,无其它特殊头域。

    返回参数

    无,返回200状态码则代表成功

    返回错误

    请参考附录

    示例

    请求示例

    POST /v1/domain/resolve/edit HTTP/1.1
    Host: bcd.baidubce.com
    x-bce-date: 2016-05-09T03:59:31Z
    Content-Type: application/json; charset=utf-8  
    Authorization: bce-auth-v1/f932edbccdb04cec8e3307b1798f16e6/2016-05-09T03:59:31Z/3600/host;x-bce-date/63916c6e4133de4352a2d43c046810b9a82a92bf325bec67da7d7eed9abb1169
    
    {
      "domain" : "www",
      "rdType" : "A",
      "rdata" : "1.1.1.1",
      "ttl" : 60,
      "zoneName" : "e3rbtgm5mfek17sfresolvetest.com",
      "recordId" : 950
    }

    返回示例

    HTTP/1.1 200 OK
    x-bce-request-id: 0305bf9a-bd8a-4d7e-b847-6893198fffba
    Content-Type: application/json;charset=UTF-8
    Date: Mon, 09 May 2016 03:59:38 GMT
    Server: BWS
    Transfer-Encoding: chunked

    查询信息模板列表

    描述

    本接口用于查询用户的信息模板,支持分页、排序和过滤。

    请求

    请求结构

    GET /v{version}/contact/template?orderBy={orderBy}&order={order}&pageNo={pageNo}&pageSize={pageSize} HTTP/1.1
    Host: bcd.baidubce.com
    Authorization: authorization string

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    pageNo Integer RequestParam参数 页码,从1开始
    pageSize Integer RequestParam参数 每页记录数,大于0有效
    orderBy String RequestParam参数 排序字段,支持createTime等
    order String RequestParam参数 顺序(ASC)或逆序(DESC)
    userType String RequestParam参数 所有者类型:个人(INDIVIDUAL)或企业(ENTERPRISE)
    email String RequestParam参数 联系邮箱
    ... String RequestParam参数 其他信息字段

    返回

    返回头域

    除公共头域,无其它特殊头域

    返回参数

    参数名称 类型 描述
    totalCount Integer 总模板数
    result List 返回的模板列表,信息模板字段参见创建信息模板所需字段

    返回错误请参考附录

    示例

    请求示例

    GET /v2/contact/template?orderBy=createTime&order=desc&pageNo=1&pageSize=1 HTTP/1.1
    Authorization: bce-auth-v1/2647e9da8eab431cbe58eaa6c1d46cdc/2017-08-10T02:11:09Z/3600/host;x-bce-date/e9f83f49bd3120230412c5da2ad43e6e0efbec1c9aa13efd9fc78afb61c4f0c1
    Host: bcd.baidubce.com
    x-bce-console-rpc-id: db49df1f-761e-4d39-888e-72a377f44c7b
    x-bce-date: 2017-08-10T02:11:09Z

    返回示例

    HTTP/1.1 200 OK
    Cache-Control: no-cache
    Content-Length: -1
    Content-Type: application/json;charset=UTF-8
    Date: Thu, 10 Aug 2017 02:11:13 GMT
    Server: BWS
    Transfer-Encoding: chunked
    x-bce-request-id: af332006-00c0-41ed-a75a-d45e0126ca97
    {
        "totalCount": 46,
        "result": [
            {
                "userType": "INDIVIDUAL",
                "ownerChinese": "测试二",
                "ownerEnglish": "Ce Shi Er",
                "contactChinese": "测试二",
                "contactEnglish": "Ce Shi Er",
                "email": "ceshi@cehi.com",
                "addressChinese": "北京",
                "addressEnglish": "Bei Jing",
                "postalCode": "200000",
                "mobilePhone": "13000000000",
                "countryCode": "086",
                "areaCode": "021",
                "phoneNumber": "20000000",
                "region": {
                    "province": "110000",
                    "city": "110000",
                    "country": "086"
                },
                "templateId": "73754278edf41b778e6b6a63e0e8b93d",
                "asTemplate": false,
                "ownerCode": "333333333333333333",
                "auditFile": "f1fb4c85-1b3a-49cc-b9e7-ddeba058ba8f",
                "auditStatus": "AUDIT",
                "auditDetails": [
                    ""
                ],
                "auditStartTime": "2017-08-09T13:47:17Z"
            }
        ]
    }
        

    创建信息模板

    描述

    本接口用于创建新的信息模板

    请求

    请求结构

    POST /v{version}/contact/template HTTP/1.1
    Host: bcd.baidubce.com
    Authorization: authorization string
    {
      "userType" : userType,
      "ownerChinese" : ownerChinese,
      "ownerEnglish" : ownerEnglish,
      "contactChinese" : contactChinese,
      "contactEnglish" : contactEnglish,
      "email" : email,
      "addressChinese" : addressChinese,
      "addressEnglish" : addressEnglish,
      "postalCode" : postalCode,
      "mobilePhone" : mobilePhone,
      "countryCode" : countryCode,
      "areaCode" : areaCode,
      "phoneNumber" : phoneNumber,
      "region" : {
        "province" : province,
        "city" : city,
        "country" : country
      }
    }

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    userType String RequestBody参数 所有者类型:个人(INDIVIDUAL)或企业(ENTERPRISE)
    ownerChinese String RequestBody参数 所有者中文名
    ownerEnglish String RequestBody参数 所有者英文名
    contactChinese String RequestBody参数 联系人中文名
    contactEnglish String RequestBody参数 联系人英文名
    addressChinese String RequestBody参数 通讯地址-中文
    addressEnglish String RequestBody参数 通讯地址-英文
    region Region RequestBody参数 所属区域
    postalCode String RequestBody参数 邮编
    areaCode String RequestBody参数 区号
    countryCode String RequestBody参数 国家编号,固定填086
    email String RequestBody参数 邮箱地址
    mobilePhone String RequestBody参数 手机
    phoneNumber String RequestBody参数 电话号码

    返回

    返回头域

    除公共头域,无其它特殊头域

    返回参数

    参数名称 类型 描述
    templateId String 信息模板ID

    返回错误请参考附录

    示例

    请求示例

    POST /v2/contact/template HTTP/1.1
    Authorization: bce-auth-v1/2647e9da8eab431cbe58eaa6c1d46cdc/2017-08-10T02:44:50Z/3600/host;x-bce-date/284788e13924d56c61df68e116bd007679b64fc82463bfd9cc49fb576f0fba0e
    Content-Type: application/json
    Host: bcd.baidubce.com
    x-bce-console-rpc-id: 8f18309a-0f6f-4347-81e1-771c8e051a06
    x-bce-date: 2017-08-10T02:44:50Z
    {
      "userType" : "INDIVIDUAL",
      "ownerChinese" : "纳钠",
      "ownerEnglish" : "Na Na",
      "contactChinese" : "纳钠",
      "contactEnglish" : "Na Na",
      "email" : "ceshi@cehi.com",
      "addressChinese" : "纳贤路701号",
      "addressEnglish" : "Na Xian Lu 701 Hao",
      "postalCode" : "201210",
      "mobilePhone" : "13245678901",
      "countryCode" : "086",
      "areaCode" : "021",
      "region" : {
        "province" : "310000",
        "city" : "310000",
        "country" : "086"
      }
    }
        

    返回示例

    HTTP/1.1 200 OK
    Cache-Control: no-cache
    Content-Length: -1
    Content-Type: application/json;charset=UTF-8
    Date: Thu, 10 Aug 2017 02:44:51 GMT
    Server: BWS
    Transfer-Encoding: chunked
    x-bce-request-id: 03297b52-00fe-4aa9-a89a-ec49046acc2d
    {
        "templateId": "da0d1a5269ca571338e4a6069e7d7d4c"
    }

    查询信息模板

    描述

    本接口用于查询用户的信息模板

    请求

    请求结构

    GET /v{version}/contact/template/{templateId} HTTP/1.1
    Host: bcd.baidubce.com
    Authorization: authorization string

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    templateId String PathVariable参数 信息模板ID

    返回

    返回头域

    除公共头域,无其它特殊头域

    返回参数

    参数名称 类型 描述
    userType String 所有者类型:个人(INDIVIDUAL)或企业(ENTERPRISE)
    ownerChinese String 所有者中文名
    ownerEnglish String 所有者英文名
    contactChinese String 联系人中文名
    contactEnglish String 联系人英文名
    addressChinese String 通讯地址-中文
    addressEnglish String 通讯地址-英文
    region Region 所属区域
    postalCode String 邮编
    areaCode String 区号
    countryCode String 国家编号
    email String 邮箱地址
    mobilePhone String 手机
    phoneNumber String 电话号码
    ownerCode String 证件号码
    auditStatus String 实名认证状态,值为NONVERIFY/AUDIT/RETURN/NORMAL,未实名认证、实名认证中、实名认证失败、实名认证成功
    auditDetails List 如果实名认证失败,认证失败的原因
    auditStartTime String 审核开始时间,格式为yyyy-MM-dd\THH:mm:ss\Z,采用UTC时间,示例:2017-07-26T14:47:10Z

    返回错误请参考附录

    示例

    请求示例

    GET /v2/contact/template/{templateId} HTTP/1.1
    Authorization: bce-auth-v1/2647e9da8eab431cbe58eaa6c1d46cdc/2017-08-10T02:56:20Z/3600/host;x-bce-date/a30eafc678b1751d75c8223e53caff4649c71e724ea4213cf80e9955db33210f
    Host: bcd.baidubce.com
    x-bce-console-rpc-id: fc835710-c092-4a54-bd7d-e44c994f2c61
    x-bce-date: 2017-08-10T02:56:20Z

    返回示例

    HTTP/1.1 200 OK
    Cache-Control: no-cache
    Content-Length: -1
    Content-Type: application/json;charset=UTF-8
    Date: Thu, 10 Aug 2017 02:11:13 GMT
    Server: BWS
    Transfer-Encoding: chunked
    x-bce-request-id: af332006-00c0-41ed-a75a-d45e0126ca97
    {
        "userType": "INDIVIDUAL",
        "ownerChinese": "测试二",
        "ownerEnglish": "Ce Shi Er",
        "contactChinese": "测试二",
        "contactEnglish": "Ce Shi Er",
        "email": "ceshi@cehi.com",
        "addressChinese": "北京",
        "addressEnglish": "Bei Jing",
        "postalCode": "200000",
        "mobilePhone": "13000000000",
        "countryCode": "086",
        "areaCode": "021",
        "phoneNumber": "20000000",
        "region": {
            "province": "110000",
            "city": "110000",
            "country": "086"
        },
        "templateId": "73754278edf41b778e6b6a63e0e8b93d",
        "asTemplate": false,
        "ownerCode": "333333333333333333",
        "auditFile": "f1fb4c85-1b3a-49cc-b9e7-ddeba058ba8f",
        "auditStatus": "AUDIT",
        "auditDetails": [
            ""
        ],
        "auditStartTime": "2017-08-09T13:47:17Z"
    }

    删除信息模板

    描述

    本接口用于删除一个信息模板

    请求

    请求结构

    GET /v{version}/contact/template/{templateId} HTTP/1.1
    Host: bcd.baidubce.com
    Authorization: authorization string

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    templateId String PathVariable参数 信息模板ID

    返回

    返回头域

    除公共头域,无其它特殊头域

    返回参数

    无,返回200状态码则代表成功

    返回错误请参考附录

    示例

    请求示例

    DELETE /v2/contact/template/da0d1a5269ca571338e4a6069e7d7d4c HTTP/1.1
    Host: bcd.baidubce.com
    Authorization: authorization string

    返回示例

    HTTP/1.1 200 OK
    Cache-Control: no-cache
    Content-Length: 0
    Date: Thu, 10 Aug 2017 02:56:22 GMT
    Server: BWS
    x-bce-request-id: 4646c751-2b9c-4cba-bf6e-290c837e3855

    修改信息模板

    描述

    本接口用于修改一个信息模板

    请求

    请求结构

    PUT /v{version}/contact/template/{templateId}?update HTTP/1.1
    Host: bcd.baidubce.com
    Authorization: authorization string
    {
      "userType" : userType,
      "ownerChinese" : ownerChinese,
      "ownerEnglish" : ownerEnglish,
      "contactChinese" : contactChinese,
      "contactEnglish" : contactEnglish,
      "email" : email,
      "addressChinese" : addressChinese,
      "addressEnglish" : addressEnglish,
      "postalCode" : postalCode,
      "mobilePhone" : mobilePhone,
      "countryCode" : countryCode,
      "areaCode" : areaCode,
      "region" : {
        "province" : province,
        "city" : city,
        "country" : country
      },
      "templateId" : templateId
    }

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    templateId String PathVariable参数 信息模板ID
    userType String RequestBody参数 所有者类型:个人(INDIVIDUAL)或企业(ENTERPRISE)
    ownerChinese String RequestBody参数 所有者中文名
    ownerEnglish String RequestBody参数 所有者英文名
    contactChinese String RequestBody参数 联系人中文名
    contactEnglish String RequestBody参数 联系人英文名
    addressChinese String RequestBody参数 通讯地址-中文
    addressEnglish String RequestBody参数 通讯地址-英文
    region Region RequestBody参数 所属区域
    postalCode String RequestBody参数 邮编
    areaCode String RequestBody参数 区号
    countryCode String RequestBody参数 国家编号,固定填086
    email String RequestBody参数 邮箱地址
    mobilePhone String RequestBody参数 手机
    phoneNumber String RequestBody参数 电话号码

    返回

    返回头域

    除公共头域,无其它特殊头域

    返回参数

    无,返回200状态码则代表成功

    返回错误请参考附录

    示例

    请求示例

    PUT /v2/contact/template/98d339c3fb1fab9ac9b2e081dd9bb374?update HTTP/1.1
    Authorization: bce-auth-v1/2647e9da8eab431cbe58eaa6c1d46cdc/2017-08-10T03:07:04Z/3600/host;x-bce-date/9a16d567fee51bdfdd7fa65cd4f0963854e5fbb78a0e4874c42f6acbf8bb3792
    Content-Type: application/json
    Host: bcd.baidubce.com
    x-bce-console-rpc-id: 3b0fced7-72ad-4e14-bfa4-492e56e128f5
    x-bce-date: 2017-08-10T03:07:04Z
    {
      "userType" : "INDIVIDUAL",
      "ownerChinese" : "纳钠",
      "ownerEnglish" : "Na Na",
      "contactChinese" : "纳钠",
      "contactEnglish" : "Na Na",
      "email" : "ceshi2@cehi.com",
      "addressChinese" : "纳贤路701号",
      "addressEnglish" : "Na Xian Lu 701 Hao",
      "postalCode" : "201210",
      "mobilePhone" : "13245678906",
      "countryCode" : "086",
      "areaCode" : "021",
      "region" : {
        "province" : "310000",
        "city" : "310000",
        "country" : "086"
      },
      "templateId" : "98d339c3fb1fab9ac9b2e081dd9bb374"
    }

    返回示例

    HTTP/1.1 200 OK
    Cache-Control: no-cache
    Content-Length: 0
    Date: Thu, 10 Aug 2017 03:07:06 GMT
    Server: BWS
    x-bce-request-id: 363a7e52-f432-4e93-8108-c950373c9a05

    信息模板实名认证

    描述

    本接口用于对信息模板进行实名认证

    请求

    请求结构

    PUT /v{version}/contact/template/{templateId}?audit HTTP/1.1
    Host: bcd.baidubce.com
    Authorization: authorization string
    {
        "auditFile" : auditFile,
        "ownerCode" : ownerCode
        "certType"  : certType
    }

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    templateId String PathVariable参数 信息模板ID
    ownerCode String RequestBody参数 证件号码
    auditFile String RequestBody参数 证件图片的byte数组所转成的Base64字符串
    certType String RequestBody参数 证件类型

    返回

    返回头域

    除公共头域,无其它特殊头域

    返回参数

    无,返回200状态码则代表成功

    返回错误请参考附录

    示例

    请求示例

    PUT /v2/contact/template/98d339c3fb1fab9ac9b2e081dd9bb374?audit HTTP/1.1
    Authorization: bce-auth-v1/2647e9da8eab431cbe58eaa6c1d46cdc/2017-08-10T03:07:04Z/3600/host;x-bce-date/9a16d567fee51bdfdd7fa65cd4f0963854e5fbb78a0e4874c42f6acbf8bb3792
    Content-Type: application/json
    Host: bcd.baidubce.com
    x-bce-console-rpc-id: 3b0fced7-72ad-4e14-bfa4-492e56e128f5
    x-bce-date: 2017-08-10T03:07:04Z
    {
        "auditFile" : "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDh............",
        "ownerCode" : "320911199006250320"
        "certType"  : "SFZ"
    }

    返回示例

    HTTP/1.1 200 OK
    Cache-Control: no-cache
    Content-Length: 0
    Date: Thu, 10 Aug 2017 03:07:06 GMT
    Server: BWS
    x-bce-request-id: 363a7e52-f432-4e93-8108-c950373c9a05

    域名转入

    描述

    本接口用于域名转入

    请求

    请求结构

    POST /v1/domain/transferin HTTP/1.1
    Host: bcd.baidubce.com
    Authorization: authorization string
    {
        "domain" : domain,
        "password" : password,
        "templateId" : templateId
    }

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    domain String RequestBody参数 域名名称
    password String RequestBody参数 转入密码
    templateId String RequestBody参数 信息模板ID,必须使用实名模板

    返回

    返回头域

    除公共头域,无其它特殊头域

    返回参数

    参数名称 类型 描述
    bceOrderId String 订单ID

    返回错误请参考附录

    示例

    请求示例

    POST /v1/domain/transferin HTTP/1.1
    Authorization: bce-auth-v1/2647e9da8eab431cbe58eaa6c1d46cdc/2017-08-10T03:07:04Z/3600/host;x-bce-date/9a16d567fee51bdfdd7fa65cd4f0963854e5fbb78a0e4874c42f6acbf8bb3792
    Content-Type: application/json
    Host: bcd.baidubce.com
    x-bce-console-rpc-id: 3b0fced7-72ad-4e14-bfa4-492e56e128f5
    x-bce-date: 2017-08-10T03:07:04Z
    {
        "domain" : domain,
        "password" : password,
        "templateId" : templateId
    }

    返回示例

    HTTP/1.1 200 OK
    Cache-Control: no-cache
    Content-Length: 0
    Date: Thu, 10 Aug 2017 03:07:06 GMT
    Server: BWS
    x-bce-request-id: 363a7e52-f432-4e93-8108-c950373c9a05
    {
        "bceOrderId":"7e9e5385a57f463e9ea3b6796535365e"
    }

    域名转入状态查询

    描述

    本接口用于域名转入状态查询

    请求

    请求结构

    GET /v1/domain/transferin/status?domain={domain} HTTP/1.1
    Host: bcd.baidubce.com
    Authorization: authorization string

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    domain String RequestParam参数 域名名称

    返回

    返回头域

    除公共头域,无其它特殊头域

    返回参数

    参数名称 类型 描述
    totalCount Integer 总转入状态数(一个域名转入请求可以多次提交)
    result List 域名转入状态列表,域名转入状态信息参考TransferInfo数据结构

    TransferInfo数据结构

    参数名称 类型 描述
    id Integer 转入ID,主键
    domain String 域名名称
    status String 当前转入状态具体取值参考域名转入状态
    beginTime String 转入开始时间

    返回错误请参考附录

    示例

    请求示例

    GET /v1/domain/transferin/status?domain={domain} HTTP/1.1
    Authorization: bce-auth-v1/2647e9da8eab431cbe58eaa6c1d46cdc/2017-08-10T03:07:04Z/3600/host;x-bce-date/9a16d567fee51bdfdd7fa65cd4f0963854e5fbb78a0e4874c42f6acbf8bb3792
    Content-Type: application/json
    Host: bcd.baidubce.com
    x-bce-console-rpc-id: 3b0fced7-72ad-4e14-bfa4-492e56e128f5
    x-bce-date: 2017-08-10T03:07:04Z

    返回示例

    HTTP/1.1 200 OK
    Cache-Control: no-cache
    Content-Length: 0
    Date: Thu, 10 Aug 2017 03:07:06 GMT
    Server: BWS
    x-bce-request-id: 363a7e52-f432-4e93-8108-c950373c9a05
    {
        "totalCount":1,
        "result":[
            {
                "id":6028,
                "domain":"asfyuweqfsghrw.top",
                "status":"TRANSFERRING_NEW",
                "beginTime":"2019-09-05T12:42:50Z"
            }
        ]
    }

    重新提交域名转入密码

    描述

    本接口用于域名转入密码错误时,重新提交转入密码

    请求

    请求结构

    POST /v1/domain/transferin/retry HTTP/1.1
    Host: bcd.baidubce.com
    Authorization: authorization string
    {
        "id" : id,
        "eppcode" : eppcode
    }

    请求头域

    除公共头域外,无其它特殊头域。

    请求参数

    参数名称 类型 是否必需 参数位置 描述
    id Integer RequestBody参数 转入ID,主键
    eppcode String RequestBody参数 转入密码

    返回

    返回头域

    除公共头域,无其它特殊头域

    返回参数

    无,返回200状态码则代表成功

    返回错误请参考附录

    示例

    请求示例

    POST /v1/domain/transferin/retry HTTP/1.1
    Authorization: bce-auth-v1/2647e9da8eab431cbe58eaa6c1d46cdc/2017-08-10T03:07:04Z/3600/host;x-bce-date/9a16d567fee51bdfdd7fa65cd4f0963854e5fbb78a0e4874c42f6acbf8bb3792
    Content-Type: application/json
    Host: bcd.baidubce.com
    x-bce-console-rpc-id: 3b0fced7-72ad-4e14-bfa4-492e56e128f5
    x-bce-date: 2017-08-10T03:07:04Z
    {
        "id" : 6028,
        "eppcode" : "pN3!mc2q"
    }

    返回示例

    HTTP/1.1 200 OK
    Cache-Control: no-cache
    Content-Length: 0
    Date: Thu, 10 Aug 2017 03:07:06 GMT
    Server: BWS
    x-bce-request-id: 363a7e52-f432-4e93-8108-c950373c9a05
    上一篇
    API总述
    下一篇
    附录