edit-icon download-icon

Invoke example

最終更新日: Dec 13, 2018

MPS API は、MPS サーバーにリクエスト(HTTP または HTTPS リクエスト)を送信して呼び出し、リクエストに対するサーバーの応答を受信します。ユーザー リクエストを受信すると、MPS サーバは、リクエストの ID およびパラメーターを検証します。すべての検証手続きにパスすると、MPS サーバーは、指定されたリクエストのパラメーターに応じた処理を実行し、完了します。HTTP 応答で処理結果を呼び出し元に返します。

手順

  • リクエストパラメーターを準備します。
  • リクエストパラメーターを使用して正規化クエリ文字列を構築します。
  • 署名文字列を構築します。
  • 署名を計算します(HMAC 署名と Base64 コードを含む)。
  • リクエスト URL を作成します。

以下では、Java を使用してリクエストを作成する方法を示しています。

Global 定義。

  1. private static final String ENCODE_TYPE = "UTF-8";
  2. private static final String ALGORITHM = "HmacSHA1";
  3. private static final String HTTP_METHOD = "GET";
  4. private static final String SEPARATOR = "&";
  5. private static final String EQUAL = "=";

リクエストパラメーターを用意します。

  1. Map<String, String> parameterMap = new HashMap<String, String>();
  2. // Request public parameters.
  3. parameterMap.put("Action", "SearchTemplate");
  4. parameterMap.put("Version", "2014-06-18");
  5. parameterMap.put("AccessKeyId", "testId"); //AccessKeyId をご自身のAccessKeyId に置き換えます。
  6. parameterMap.put("Timestamp", "2015-05-14T09:03:45Z");//このタイムスタンプはテストのために固定されています。この例で生成された署名の値はそのまま変更されないため、データの比較と検証が容易になります。可変タイムスタンプを生成するには、この 1 文を次の文に置き換えます。
  7. //parameterMap.put("Timestamp", formatIso8601Date(new Date()));
  8. parameterMap.put("SignatureMethod", "HMAC-SHA1");
  9. parameterMap.put("SignatureVersion", "1.0");
  10. parameterMap.put("SignatureNonce", "4902260a-516a-4b6a-a455-45b653cf6150"); //一意のランダムな数値がテストのために固定されています。この例で生成された署名の値はそのまま変更されないため、データの比較と検証が容易になります。可変の一意のランダムな数値を生成するには、この 1 文を次の 1 文に置き換えます。
  11. //parameterMap.put("SignatureNonce", UUID.randomUUID().toString());
  12. parameterMap.put("Format", "XML"); //The JSON format is also supported.

リクエストパラメーターを使用して正規化クエリ文字列を構築します。

  1. private static String percentEncode(String value) throws UnsupportedEncodingException {
  2. return URLEncoder.encode(value, ENCODE_TYPE).replace("+", "%20").replace("*", "%2A").replace("%7E", "~");
  3. }
  4. private static String buildCanonicalizedQueryString(Map<String, String> parameterMap) throws UnsupportedEncodingException {
  5. // パラメーターを並べ替えます。
  6. List<String> sortedKeys = new ArrayList<String>(parameterMap.keySet());
  7. Collections.sort(sortedKeys);
  8. StringBuilder temp = new StringBuilder();
  9. for (String key : sortedKeys) {
  10. // キーと値は暗号化される必要があります。
  11. String value = parameterMap.get(key);
  12. temp.append(SEPARATOR).append(percentEncode(key)).append(EQUAL).append(percentEncode(value));
  13. }
  14. return temp.toString().substring(1);
  15. }

署名を計算します(HMAC 署名と Base64 コードを含む)。

  1. private static String buildStringToSign(String canonicalizedQueryString) throws UnsupportedEncodingException {
  2. // StringToSign 文字列を生成します。
  3. StringBuilder temp = new StringBuilder();
  4. temp.append(HTTP_METHOD).append(SEPARATOR);
  5. temp.append(percentEncode("/")).append(SEPARATOR);
  6. // 正規化クエリ文字列は暗号化される必要があります。
  7. temp.append(percentEncode(canonicalizedQueryString));
  8. return temp.toString();
  9. }
  10. private static String buildSignature(String keySecret, String stringToSign) throws UnsupportedEncodingException, InvalidKeyException, NoSuchAlgorithmException {
  11. SecretKey key = new SecretKeySpec((keySecret + SEPARATOR).getBytes(ENCODE_TYPE), SignatureMethod.HMAC_SHA1);
  12. Mac mac = Mac.getInstance(ALGORITHM);
  13. mac.init(key);
  14. byte[] hashBytes = mac.doFinal(stringToSign.toString().getBytes(ENCODE_TYPE));
  15. byte[] base64Bytes = new Base64().encode(hashBytes);
  16. String base64UTF8String = new String(base64Bytes, "utf-8");
  17. return URLEncoder.encode(base64UTF8String, ENCODE_TYPE);
  18. }

リクエスト URL を作成します。

  1. private static String buildRequestURL(String signature, Map<String, String> parameterMap) throws UnsupportedEncodingException {
  2. // リクエスト URL を生成します。
  3. StringBuilder temp = new StringBuilder("http://mts.aliyuncs.com/?");
  4. temp.append(URLEncoder.encode("Signature", ENCODE_TYPE)).append("=").append(signature);
  5. for (Map.Entry<String, String> e : parameterMap.entrySet()) {
  6. temp.append("&").append(percentEncode(e.getKey())).append("=").append(percentEncode(e.getValue()));
  7. }
  8. return temp.toString();
  9. }

  • リクエストパラメーターを準備します。

    • AccessKeyID の値はtestId
    • AccessKeySecret の値はtestKeySecret
    • Timestamp の値は2015-05-14T09:03:45Z
    • SignatureNonce の値は4902260a-516a-4b6a-a455-45b653cf6150
    • Action の値はSearchTemplateで、PageSize の値は 2
    • フォーマット値はXML
  • リクエストパラメーターを使用して正規化クエリ文字列を構築します。

    1. 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
  • 署名文字列を構築します。

    1. 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 コードを含む)を計算します。

    1. kmDv4mWo806GWPjQMy2z4VhBBDQ%3D
  • リクエスト URL を作成します。

    1. 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
  • 次に、HTTP リクエスト(たとえば curl)を URL に送信し、サーバーからの応答結果を取得します(サンプルコードの応答結果は XML 形式)。

    1. <SearchTemplateResponse>
    2. <RequestId>017F1B2D-2B5B-4441-ABBA-E0DC08F5AFEC</RequestId>
    3. <Template>
    4. <Id>88c6ca184c0e47098a5b665e2a126799</Id>
    5. <Name>MTS-example</Name>
    6. <Container>
    7. <Format>mp4</Format>
    8. </Container>
    9. <Video>
    10. <Codec>H.264</Codec>
    11. <Profile>high</Profile>
    12. <Bitrate>Auto</Bitrate>
    13. <Crf>15</Crf>
    14. <Width>256</Width>
    15. <Height>800</Height>
    16. <Fps>25</Fps>
    17. <Gop>10</Gop>
    18. <Preset>lower</Preset>
    19. <ScanMode></ScanMode>
    20. <Bufsize>6000</Bufsize>
    21. <Maxrate></Maxrate>
    22. <BitrateBnd>
    23. <Max></Max>
    24. <Min></Min>
    25. </BitrateBnd>
    26. </Video>
    27. <Audio>
    28. <Codec>aac</Codec>
    29. <Samplerate>44100</Samplerate>
    30. <Bitrate>500</Bitrate>
    31. <Channels>2</Channels>
    32. </Audio>
    33. <State>Normal</State>
    34. </Template>
    35. </SearchTemplateResponse>

完全なサンプルコード

サンプルコードは Java で記述され、パッケージマネージャーは Maven です。

コードのダウンロード

JAR バイナリのダウンロード

実行コマンド: java -jar mts-signature-sample-all-0.1.jar testId testKeySecret 4902260a-516a-4b6a-a455-45b653cf6150 2015-05-14T09:03:45Z SearchTemplate XML PageSize@=2