调用方式

一、简述概览

对DNS API接口调用是通过向DNS API的服务端地址发送HTTP POST请求，并按照接口说明在请求中加入相应请求参数来完成的；根据请求的处理情况，系统会返回处理结果。

二、调用方式

对云解析API接口调用是通过向DNS API的服务端地址发送HTTP(s)创建、查看、修改、删除资源，并按照接口说明在请求中加入相应请求参数来完成的；根据请求的处理情况，系统会返回处理结果。为便于问题跟踪和沟通，我司平台为每一次请求/任务分配一个ID，并在响应的头信息中增加x-cnc-request-id字段，用于返回该请求ID给客户。务必注意：API接口响应中的json字段，由于功能规划扩展，会在原有基础上新增json或者xml字段，请使用方的开发人员根据json和xml的规范去解析，而不要通过具体字符串去解析。我司平台对每个客户账号的访问频率做了限制，每5分钟的请求次数不超过1200次。每个账号对应单个接口建议频率30次/5min。如有特殊需要，可与我司平台接口人员联系。

三、请求结构

通信协议

支持通过HTTP或HTTPS通道进行请求通信。为了获得更高的安全性，推荐您使用HTTPS通道发送请求。

请求参数

API的每个请求都需要指定两类参数：即公共请求参数以及接口请求参数。其中公共请求参数是每个接口都要用到的请求参数，具体可参见公共参数说明，而接口请求参数是各个接口所特有的，具体见各个接口的“请求参数”描述。

四、公共参数

请求参数：

响应参数：

五、鉴权方法

我司平台会将接口请求中的{Date}（或者x-cnc-date头）指定的GMT时间和平台本地时间进行比较，如果时间差超过15分钟，会忽略该请求，以避免过期消息的重复发送。然后，按照同样的加密方式加密得到的password与用户传递的password做比较。如果一致则通过，如果不一致则拒绝访问。

六、代码示例

示例下载

Java：本地下载
PHP：本地下载
示例代码仅供参考， 请根据实际情况使用。

七、响应规范

成功结果

可直接提供成功结果示例。

json示例

{
    "resCode":0,
    "msg":"操作成功",
    "content":[
        {
            "domainId":1683943,
            "domainName":"quansucloud.com.cn",
            "ret":"Success",
            "msg":"操作成功",
            "msgEn":null,
            "result":null,
            "code":0,
            "success":true
        }
    ]
}

错误结果

调用接口出错后，将不会返回结果数据。调用方可根据<错误码>来定位错误原因。当调用出错时，HTTP请求返回一个4xx或5xx的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。另外，请求头中还包含一个全局唯一的请求ID：RequestId。在调用方找不到错误原因时，可以联系我司对应技术人员，并提供该RequestId，以便我们尽快帮您解决问题。

json示例

{
    "resCode":105,
    "msg":"批量操作,全部失败",
    "content":[
        {
            "domainId":null,
            "domainName":"quansucloud.com.cn",
            "ret":"TIP_DOM_REP",
            "msg":"域名quansucloud.com.cn重复",
            "msgEn":"Domain name repeated ",
            "result":null,
            "code":201,
            "success":false
        }
    ]
}

八、附录说明

附表1 业务状态码 （适用于云调度及云解析）： 本地下载
附表2 ViewID与线路的对应关系（适用于云调度及云解析）： 本地下载
附表3 监控节点数据（适用于云调度及云解析）： 本地下载

九、错误码表

公共鉴权错误码