MPS API は、MPS サーバーにリクエスト(HTTP または HTTPS リクエスト)を送信して呼び出し、リクエストに対するサーバーの応答を受信します。ユーザー リクエストを受信すると、MPS サーバは、リクエストの ID およびパラメーターを検証します。すべての検証手続きにパスすると、MPS サーバーは、指定されたリクエストのパラメーターに応じた処理を実行し、完了します。HTTP 応答で処理結果を呼び出し元に返します。
- リクエストパラメーターを準備します。
- リクエストパラメーターを使用して正規化クエリ文字列を構築します。
- 署名文字列を構築します。
- 署名を計算します(HMAC 署名と Base64 コードを含む)。
- リクエスト URL を作成します。
以下では、Java を使用してリクエストを作成する方法を示しています。
Global 定義。
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<String, String> parameterMap = new HashMap<String, String>();
// Request public parameters.
parameterMap.put("Action", "SearchTemplate");
parameterMap.put("Version", "2014-06-18");
parameterMap.put("AccessKeyId", "testId"); //AccessKeyId をご自身のAccessKeyId に置き換えます。
parameterMap.put("Timestamp", "2015-05-14T09:03:45Z");//このタイムスタンプはテストのために固定されています。この例で生成された署名の値はそのまま変更されないため、データの比較と検証が容易になります。可変タイムスタンプを生成するには、この 1 文を次の文に置き換えます。
//parameterMap.put("Timestamp", formatIso8601Date(new Date()));
parameterMap.put("SignatureMethod", "HMAC-SHA1");
parameterMap.put("SignatureVersion", "1.0");
parameterMap.put("SignatureNonce", "4902260a-516a-4b6a-a455-45b653cf6150"); //一意のランダムな数値がテストのために固定されています。この例で生成された署名の値はそのまま変更されないため、データの比較と検証が容易になります。可変の一意のランダムな数値を生成するには、この 1 文を次の 1 文に置き換えます。
//parameterMap.put("SignatureNonce", UUID.randomUUID().toString());
parameterMap.put("Format", "XML"); //The JSON format is also supported.
リクエストパラメーターを使用して正規化クエリ文字列を構築します。
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<String, String> parameterMap) throws UnsupportedEncodingException {
// パラメーターを並べ替えます。
List<String> sortedKeys = new ArrayList<String>(parameterMap.keySet());
Collections.sort(sortedKeys);
StringBuilder temp = new StringBuilder();
for (String key : sortedKeys) {
// キーと値は暗号化される必要があります。
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);
// 正規化クエリ文字列は暗号化される必要があります。
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<String, String> 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<String, String> e : parameterMap.entrySet()) {
temp.append("&").append(percentEncode(e.getKey())).append("=").append(percentEncode(e.getValue()));
}
return temp.toString();
}
例
-
リクエストパラメーターを準備します。
- AccessKeyID の値は
testId
- AccessKeySecret の値は
testKeySecret
- Timestamp の値は
2015-05-14T09:03:45Z
- SignatureNonce の値は
4902260a-516a-4b6a-a455-45b653cf6150
- Action の値は
SearchTemplate
で、PageSize の値は2
- フォーマット値は
XML
- AccessKeyID の値は
-
リクエストパラメーターを使用して正規化クエリ文字列を構築します。
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
-
次に、HTTP リクエスト(たとえば curl)を URL に送信し、サーバーからの応答結果を取得します(サンプルコードの応答結果は 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>
完全なサンプルコード
サンプルコードは Java で記述され、パッケージマネージャーは Maven です。
実行コマンド: 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