阅读304 返回首页    go 阿里云

调用说明__附录_API文档_云解析-阿里云

以DescribeDomainRecords接口为例(以下示例代码采用Java语言，关于更完整的示例程序及其他开发语言的示例代码，请参见阿里云开发者论坛https://bbs.aliyun.com/ ).

对应的Action是DescribeDomainRecords，需要一个必要的操作参数是DomainName。在添加了所有公共请求参数（除Signature）后，请求的URL是（为了便于阅读，这里是进行URL编码前的URL）：

https://alidns.aliyuncs.com/?Format=XML&AccessKeyId=testid&Action=DescribeDomainRecords&SignatureMethod=HMAC-SHA1&DomainName=example.com&SignatureNonce=f59ed6a9-83fc-473b-9cc6-99c95df3856e&SignatureVersion=1.0&Version=2015-01-09&Timestamp=2016-03-24T16:41:54Z

按照签名计算规则，先构造出规范化请求字符串（Canonicalized Query String），如下：

AccessKeyId=testid&Action=DescribeDomainRecords&DomainName=example.com&Format=XML&SignatureMethod=HMAC-SHA1&SignatureNonce=f59ed6a9-83fc-473b-9cc6-99c95df3856e&SignatureVersion=1.0&Timestamp=2016-03-24T16%3A41%3A54Z&Version=2015-01-09

再构造出用于签名的字符串StringToSign值为：

GET&%2F&AccessKeyId%3Dtestid%26Action%3DDescribeDomainRecords%26DomainName%3Dexample.com%26Format%3DXML%26SignatureMethod%3DHMAC-SHA1%26SignatureNonce%3Df59ed6a9-83fc-473b-9cc6-99c95df3856e%26SignatureVersion%3D1.0%26Timestamp%3D2016-03-24T16%253A41%253A54Z%26Version%3D2015-01-09

以下Java示例代码演示了如何添加公共请求参数、如何构造用请求参数构造规范化请求字符串，以及如何构造StringToSign字符串。示例假定所有请求参数放在一个Map<String, String>对象里，使用的Access Key ID是“testid”。

        final String HTTP_METHOD = "GET";

        Map<String, String> parameters = new HashMap<String, String>();
        // 加入请求参数
        parameters.put("Action", "DescribeDomainRecords");
        parameters.put("DomainName", "example.com");
        parameters.put("Version", "2015-01-09");
        parameters.put("AccessKeyId", "testid");
        parameters.put("TimeStamp", formatIso8601Date(new Date()));
        parameters.put("SignatureMethod", "HMAC-SHA1");
        parameters.put("SignatureVersion", "1.0");
        parameters.put("SignatureNonce", UUID.randomUUID().toString());
        parameters.put("Format", "XML");

        // 对参数进行排序，注意严格区分大小写
        String[] sortedKeys = parameters.keySet().toArray(new String[]{});
        Arrays.sort(sortedKeys);

        final String SEPARATOR = "&";

        // 生成stringToSign字符串
        StringBuilder stringToSign = new StringBuilder();
        stringToSign.append(HTTP_METHOD).append(SEPARATOR);
        stringToSign.append(percentEncode("/")).append(SEPARATOR);

        StringBuilder canonicalizedQueryString = new StringBuilder();
        for(String key : sortedKeys) {
            // 这里注意对key和value进行编码
            canonicalizedQueryString.append("&")
            .append(percentEncode(key)).append("=")
            .append(percentEncode(parameters.get(key)));
        }

        // 这里注意对canonicalizedQueryString进行编码
        stringToSign.append(percentEncode(canonicalizedQueryString.toString().substring(1)));

其中需要注意的是，TimeStamp参数要求符合ISO8601规范，并注意使用UTC时间，否则会遇到错误。下面的示例代码演示了如何生成符合规范的TimeStamp字符串：

    private static final String ISO8601_DATE_FORMAT = "yyyy-MM-dd'T'HH:mm:ss'Z'";

    private static String formatIso8601Date(Date date) {
        SimpleDateFormat df = new SimpleDateFormat(ISO8601_DATE_FORMAT);
        df.setTimeZone(new SimpleTimeZone(0, "GMT"));
        return df.format(date);
    }

生成规范化请求字符串（示例中的canonicalizedQueryString变量），以及stringToSign时，都需要进行必要的编码。编码的规则在签名机制一节中有详细描述。下面的示例代码演示了如何用java.net.URLEncoder类完成编码：

    private static final String ENCODING = "UTF-8";

    private static String percentEncode(String value)
            throws UnsupportedEncodingException{
        return value != null ?
                URLEncoder.encode(value, ENCODING).replace("+", "%20")
                .replace("*", "%2A").replace("%7E", "~")
                : null;
    }

假定使用的Access Key Id是“testid”， Access Key Secret是“testsecret”，用于计算HMAC的Key就是“testsecret&”，最终计算得到的签名值为：

uRpHwaSEt3J+6KQD//svCh/x+pI=

计算签名的示例代码（Java）：

        // 以下是一段计算签名的示例代码
        final String ALGORITHM = "HmacSHA1";
        final String ENCODING = "UTF-8";
        key = "testsecret&";

        Mac mac = Mac.getInstance(ALGORITHM);
        mac.init(new SecretKeySpec(
                 key.getBytes(ENCODING), ALGORITHM));
        byte[] signData = mac.doFinal(
                  stringToSign.getBytes(ENCODING));

        String signature =
                  new String(Base64.encodeBase64(signData));

增加签名参数后，请按照RFC3986规则进行URL编码后得到的：

https://alidns.aliyuncs.com/?Format=XML&Action=DescribeDomainRecords&AccessKeyId=testid&SignatureMethod=HMAC-SHA1&DomainName=example.com&SignatureNonce=f59ed6a9-83fc-473b-9cc6-99c95df3856e&Version=2015-01-09&SignatureVersion=1.0&Signature=uRpHwaSEt3J%2B6KQD%2F%2FsvCh%2Fx%2BpI%3D&Timestamp=2016-03-24T16%3A41%3A54Z

接下来，通过HTTP请求的方式向上面的URL地址发送HTTP请求，并得到DNS服务端的响应结果（示例）：

<DescribeDomainRecordsResponse>
    <PageNumber>1</PageNumber>
    <DomainRecords>
        <Record>
            <DomainName>example.com</DomainName>
            <Line>default</Line>
            <Priority>1</Priority>
            <RR>2222</RR>
            <RecordId>51542601</RecordId>
            <TTL>600</TTL>
            <Type>MX</Type>
            <Value>hichina.com</Value>
        </Record>
        <Record>
            <DomainName>example.com</DomainName>
            <Line>default</Line>
            <RR>234234</RR>
            <RecordId>51542600</RecordId>
            <TTL>600</TTL>
            <Type>SRV</Type>
            <Value>3 0 2176 example-server.2.google.com</Value>
        </Record>
        <Record>
            <DomainName>example.com</DomainName>
            <Line>default</Line>
            <RR>2222</RR>
            <RecordId>51542068</RecordId>
            <TTL>600</TTL>
            <Type>A</Type>
            <Value>3.4.5.6</Value>
        </Record>
    </DomainRecords>
    <PageSize>3</PageSize>
    <TotalCount>3</TotalCount>
    <RequestId>F3440766-E1C5-4110-8285-5F53F6750560</RequestId>
</DescribeDomainRecordsResponse>

通过解析这个XML结果即可以得到域名下所有解析记录的列表。如果在提交请求时，指定Format参数为JSON，那么返回结果的格式为JSON格式。

最后更新：2016-11-23 16:04:06

  上一篇：go 入门示例__附录_API文档_云解析-阿里云
  下一篇：go 续费__常见问题_云解析-阿里云