文档

调用示例

更新时间:

对媒体处理服务接口的调用是通过向媒体处理服务端发送请求(可以通过HTTP或HTTPS通道发送),并获取服务器对该请求响应结果的过程。服务端在接收到用户请求后,对请求做必要的身份验证和参数验证,在所有验证成功后根据请求的指定参数提交或完成相应操作,并把处理的结果以HTTP响应的形式返回给调用者。

流程

  1. 准备请求参数。

  2. 使用请求参数构造规范化的请求字符串(Canonicalized Query String)。

  3. 构造签名的字符串。

  4. 计算签名(包括HMAC签名以及Base64编码)。

  5. 构造请求的URL。

以下使用Java代码演示了构造请求的流程。

全局定义


private static final String ENCODE_TYPE = "UTF-8";
private static final String ALGORITHM = "HmacSHA1";
private static final String HTTP_METHOD = "GET";
private static final String SEPARATOR = "&";
private static final String EQUAL = "=";

准备请求参数


Map parameterMap = new HashMap();
// 请求公共参数
parameterMap.put("Action", "SearchTemplate");
parameterMap.put("Version", "2014-06-18");
parameterMap.put("AccessKeyId", "testId"); //此处请替换成您自己的AccessKeyId
parameterMap.put("Timestamp", "2015-05-14T09:03:45Z");//此处将时间戳固定只是测试需要,这样此示例中生成的签名值就不会变,方便您对比验证,可变时间戳的生成需要用下边这句替换
//parameterMap.put("Timestamp", formatIso8601Date(new Date())); 
parameterMap.put("SignatureMethod", "HMAC-SHA1");
parameterMap.put("SignatureVersion", "1.0");
parameterMap.put("SignatureNonce", "4902260a-516a-4b6a-a455-45b653cf6150"); //此处将唯一随机数固定只是测试需要,这样此示例中生成的签名值就不会变,方便您对比验证,可变唯一随机数的生成需要用下边这句替换
//parameterMap.put("SignatureNonce", UUID.randomUUID().toString());
parameterMap.put("Format", "XML"); //另外支持JSON格式

使用请求参数构造规范化的请求字符串(Canonicalized Query String)


private static String percentEncode(String value) throws UnsupportedEncodingException {
return URLEncoder.encode(value, ENCODE_TYPE).replace("+", "%20").replace("*", "%2A").replace("%7E", "~");
}
private static String buildCanonicalizedQueryString(Map parameterMap) throws UnsupportedEncodingException {
// 对参数进行排序
List sortedKeys = new ArrayList(parameterMap.keySet());
Collections.sort(sortedKeys);
StringBuilder temp = new StringBuilder();
for (String key : sortedKeys) {
// 此处需要对key和value进行编码
String value = parameterMap.get(key);
temp.append(SEPARATOR).append(percentEncode(key)).append(EQUAL).append(percentEncode(value));
}
return temp.toString().substring(1);
}

计算签名(包括HMAC签名以及Base64编码)


private static String buildStringToSign(String canonicalizedQueryString) throws UnsupportedEncodingException {
// 生成stringToSign字符
StringBuilder temp = new StringBuilder();
temp.append(HTTP_METHOD).append(SEPARATOR);
temp.append(percentEncode("/")).append(SEPARATOR);
// 此处需要对canonicalizedQueryString进行编码
temp.append(percentEncode(canonicalizedQueryString));
return temp.toString();
}
private static String buildSignature(String keySecret, String stringToSign) throws UnsupportedEncodingException, InvalidKeyException, NoSuchAlgorithmException {
SecretKey key = new SecretKeySpec((keySecret + SEPARATOR).getBytes(ENCODE_TYPE), SignatureMethod.HMAC_SHA1);
Mac mac = Mac.getInstance(ALGORITHM);
mac.init(key);
byte[] hashBytes = mac.doFinal(stringToSign.toString().getBytes(ENCODE_TYPE));
byte[] base64Bytes = new Base64().encode(hashBytes);
String base64UTF8String = new String(base64Bytes, "utf-8");
return URLEncoder.encode(base64UTF8String, ENCODE_TYPE);
}

构造请求的URL


private static String buildRequestURL(String signature, Map parameterMap) throws UnsupportedEncodingException {
// 生成请求URL
StringBuilder temp = new StringBuilder("http://mts.aliyuncs.com/?");
temp.append(URLEncoder.encode("Signature", ENCODE_TYPE)).append("=").append(signature);
for (Map.Entry e : parameterMap.entrySet()) {
temp.append("&").append(percentEncode(e.getKey())).append("=").append(percentEncode(e.getValue()));
}
return temp.toString();
}

示例

  • 准备请求参数

    • Access Key Id是testId

    • Access Key Secret是testKeySecret

    • Timestamp是2015-05-14T09:03:45Z

    • SignatureNonce是4902260a-516a-4b6a-a455-45b653cf6150

    • Action是SearchTemplate,参数PageSize是2

    • Format是XML

  • 使用请求参数构造规范化的请求字符(Canonicalized Query String)

    AccessKeyId=testId&Action=SearchTemplate&Format=XML&PageSize=2&SignatureMethod=HMAC-SHA1&SignatureNonce=4902260a-516a-4b6a-a455-45b653cf6150&SignatureVersion=1.0&Timestamp=2015-05-14T09%3A03%3A45Z&Version=2014-06-18
  • 构造签名的字符串

    GET&%2F&AccessKeyId%3DtestId&Action%3DSearchTemplate&Format%3DXML&PageSize%3D2&SignatureMethod%3DHMAC-SHA1&SignatureNonce%3D4902260a-516a-4b6a-a455-45b653cf6150&SignatureVersion%3D1.0&Timestamp%3D2015-05-14T09%253A03%253A45Z&Version%3D2014-06-18
  • 计算签名(包括HMAC签名以及Base64编码)

    kmDv4mWo806GWPjQMy2z4VhBBDQ%3D
  • 构造请求的URL

    http://mts.cn-hangzhou.aliyuncs.com/?Signature=kmDv4mWo806GWPjQMy2z4VhBBDQ%3D&SignatureVersion=1.0&Action=SearchTemplate&Format=XML&SignatureNonce=4902260a-516a-4b6a-a455-45b653cf6150&PageSize=2&Version=2014-06-18&AccessKeyId=testId&SignatureMethod=HMAC-SHA1&Timestamp=2015-05-14T09%3A03%3A45Z
  • 接下来对URL地址发送HTTP请求(例如curl),并得到服务端的响应结果(示例指定响应结果格式为XML)。

    <SearchTemplateResponse>
            <RequestId>017F1B2D-2B5B-4441-ABBA-E0DC08F5AFEC</RequestId>
            <Template>
                <Id>88c6ca184c0e47098a5b665e2a126799</Id>
                <Name>MTS-example</Name>
                <Container>
                    <Format>mp4</Format>
                </Container>
                <Video>
                    <Codec>H.264</Codec>
                    <Profile>high</Profile>
                    <Bitrate>Auto</Bitrate>
                    <Crf>15</Crf>
                    <Width>256</Width>
                    <Height>800</Height>
                    <Fps>25</Fps>
                    <Gop>10</Gop>
                    <Preset>lower</Preset>
                    <ScanMode></ScanMode>
                    <Bufsize>6000</Bufsize>
                    <Maxrate></Maxrate>
                    <BitrateBnd>
                       <Max></Max>
                       <Min></Min>
                    </BitrateBnd>
                </Video>
                <Audio>
                    <Codec>aac</Codec>
                    <Samplerate>44100</Samplerate>
                    <Bitrate>500</Bitrate>
                    <Channels>2</Channels>
                </Audio>
                <State>Normal</State>
            </Template>
        </SearchTemplateResponse>
  • 本页导读 (1)
文档反馈