リクエスト構造

CloudMonitor API は RPC API です。 HTTP リクエストを送信して CloudMonitor API を呼び出すことができます。

リクエスト構造は以下の通りです。

http://endpoint/?Action=xx&parameters

説明

  • Endpoint:クラウドサービスアクセスポイント。 CloudMonitor のエンドポイントは、 metrics.aliyuncs.com です。 さまざまなリージョンのエンドポイントの詳細については、 CloudMonitor エンドポイントをご参照ください。
  • Action: 実行するオペレーションです。 たとえば、DescribeMetricList を呼び出して、インスタンスのモニタリングデータを照会できます。
  • Version:使用したい API のバージョン。 現在の CloudMonitor API バージョンは、2019-01-01 です。
  • Parameters :アンパサンド (&) で区切られたリクエストパラメーター。 リクエストパラメーターは、共通パラメーターと API 固有パラメーターで構成されます。 共通パラメーターには、API のバージョン番号、認証情報その他の情報が含まれます。

次の例は、DescribeMetricList を呼び出して、インスタンスのモニタリングデータを照会する方法を示しています。

http://metrics.cn-hangzhou.aliyuncs.com/?Action=DescribeMetricList
&EndTime=2017-05-17+11%3A30%3A27 
&StartTime=2017-05-17+11%3A20%3A27 
&Period=60 
&Dimensions=%7B%22instanceId%22%3A%22i-abcdefgh123456%22%7D 
&Timestamp=2017-03-22T09%3A30%3A57Z 
&Namespace=acs_ecs_dashboard 
&Metric=cpu_idle 

CloudMonitor エンドポイント

リージョン エンドポイント
中国 (杭州) metrics.cn-hangzhou.aliyuncs.com
中国 (上海) metrics.cn-shanghai.aliyuncs.com
中国 (青島) metrics.cn-qingdao.aliyuncs.com
中国 (北京) metrics.cn-beijing.aliyuncs.com
中国 (深セン) metrics.cn-shenzhen.aliyuncs.com
中国 (張家口 - 北京冬季オリンピック) metrics.cn-zhangjiakou.aliyuncs.com
中国 (香港) metrics.cn-hongkong.aliyuncs.com
シンガポール metrics.ap-southeast-1.aliyuncs.com
米国 (シリコンバレー ) metrics.us-west-1.aliyuncs.com
米国 (バージニア ) metrics.us-east-1.aliyuncs.com
ドイツ (フランクフルト) metrics.eu-central-1.aliyuncs.com
オーストラリア (シドニー) metrics.ap-southeast-2.aliyuncs.com
UAE (ドバイ) metrics.me-east-1.aliyuncs.com
日本 (東京) metrics.cn-hangzhou.aliyuncs.com
マレーシア (クアラルンプール ) metrics.ap-southeast-3.aliyuncs.com
中国 (フフホト) metrics.cn-huhehaote.aliyuncs.com
インドネシア (ジャカルタ ) metrics.ap-southeast-5.aliyuncs.com
インド (ムンバイ ) metrics.ap-south-1.aliyuncs.com
イギリス (ロンドン) metrics.eu-west-1.aliyuncs.com
API を呼び出して日本 (東京) のモニタリングデータを照会するときは、中国 (杭州) のエンドポイントを使用してください。

API 権限付与

アカウントを安全に保つために、CloudMonitor API を RAM ユーザーとして呼び出すことを推奨します。 CloudMonitor API を RAM ユーザーとして呼び出す前に、RAM ユーザーを作成し、それに対応する権限を割り当てる必要があります。

API 署名

安全性を確保するために、Alibaba Cloud では署名を使用して各 API リクエストを認証します。 手動で API リクエストを行うときは、AccessKey Secret を使用して、 RFC 2104 の定義に従い、エンコードおよびソートされたリクエスト文字列に基づいて、 HMAC 値を計算する必要があります。 HMAC 値が署名です。 詳細については、Sign RPC APIsをご参照ください。

RPC API の場合は、次の形式で API リクエストに署名を追加する必要があります。

https://endpoint/?SignatureVersion=1.0&SignatureMethod=HMAC-SHA1&Signature=CT9X0VtwR86fNWSnsc6v8YGOjuE%3D&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf

DescribeMetricList を例に説明します。 AccessKey ID は testid で、AccessKey Secret は testsecret です。 元のリクエスト URL は次のとおりです。
http://metrics.aliyuncs.com/?Action=DescribeMetricList&period=60&StartTime=2016-03-22T11:30:27Z&Dimensions={instanceId:'i-abcdefgh123456'}&Timestamp=2017-03-23T06:59:55Z&Namespace=acs_ecs_dashboard&SignatureVersion=1.0&Format=JSON&SignatureNonce=aeb03861-611f-43c6-9c07-b752fad3dc06&Version=2015-10-20&AccessKeyId=TestId&MetricName=cpu_idle&SignatureMethod=HMAC-SHA1
対応する StringToSign は次のとおりです。
GET&%2F&AccessKeyId%3DTestId&Action%3DDescribeMetricList&Dimensions%3D%257B%2522instanceId%2522%253A%2522i-abcdefgh123456%2522%257D&Format%3DJSON&Metric%3Dcpu_idle&Period%3D60&Namespace%3Dacs_ecs_dashboard&SignatureMethod%3DHMAC-SHA1&SignatureNonce%3Daeb03861-611f-43c6-9c07-b752fad3dc06&SignatureVersion%3D1.0&StartTime%3D2016-03-22T11%253A30%253A27Z&Timestamp%3D2017-03-23T06%253A59%253A55Z&Version%3D2015-10-20
AccessKey Secret は、 testsecret のため、HMAC 計算で使用されるキーは testsecret& になます。計算された署名の値は、次のとおりです。
TLj49H/wqBWGJ7RK0r84SN5IDfM=

署名の値を Signature パラメーターとしてリクエスト URL に追加します。 最終的なリクエスト URL は次のとおりです。

http://metrics.cn-hangzhou.aliyuncs.com/?Action=DescribeMetricList&StartTime=2016-03-22T11%3A30%3A27Z&Period=60&Dimensions=%7B%22instanceId%22%3A%22i-abcdefgh123456%22%7D&Timestamp=2017-03-23T06%3A59%3A55Z&Namespace=acs_ecs_dashboard&SignatureVersion=1.0&Format=JSON&SignatureNonce=aeb03861-611f-43c6-9c07-b752fad3dc06&Version=2015-10-20&AccessKeyId=TestId&Metric=cpu_idle&SignatureMethod=HMAC-SHA1&Signature=TLj49H%2FwqBWGJ7RK0r84SN5IDfM%3D