DescribeSiteMonitorData による詳細サイトモニタリングデータのクエリ - CMS

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cms:DescribeSiteMonitorData

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
TaskId	string	必須	ジョブ ID。	49f7b317-7645-4cc9-94fd-ea42e522****
Type	string	任意	クエリするモニタリングデータの監視対象のタイプ。有効な値： metric event	metric
MetricName	string	必須	メトリック名。有効な値： Availability ResponseTime	Availability
StartTime	string	任意	クエリする時間範囲の開始時刻。次のフォーマットがサポートされています： UNIX タイムスタンプ：1970 年 1 月 1 日 (木) 00:00:00 UTC から経過したミリ秒数。 UTC 時間：YYYY-MM-DDThh:mm:ssZ フォーマットの UTC 時間。	1551579637000
EndTime	string	任意	クエリする時間範囲の終了時刻。次のフォーマットがサポートされています： UNIX タイムスタンプ：1970 年 1 月 1 日 (木) 00:00:00 UTC から経過したミリ秒数。 UTC 時間：YYYY-MM-DDThh:mm:ssZ フォーマットの UTC 時間。	1551581437000
Period	string	任意	統計期間。値は 60 の整数倍である必要があります。単位：秒。説明デフォルト値は、監視対象アドレスに検出リクエストが送信される最小間隔と同じです。	60
NextToken	string	任意	ページネーショントークン。	49f7b317-7645-4cc9-94fd-ea42e5220930ea42e5220930ea42e522****
Length	integer	任意	返すデータポイントの数。	1000

レスポンスフィールド

フィールド	型	説明	例
	object
NextToken	string	ページネーショントークン。	ea42e5220930ea42e522****
Data	string	モニタリングデータ。	[{"Maximum":247,"Mimimum":61,"Average":154,"userId":"127067667954**","taskId":"49f7b317-7645-4cc9-94fd-ea42e522**","timestamp":1551581760000}]
RequestId	string	リクエスト ID。	3febb181-0d98-4af9-8b04-7faf36b048b9
Success	string	リクエストが成功したかどうかを示します。有効な値：true：リクエストは成功しました。false：リクエストは失敗しました。	true
Code	string	応答コード。説明状態コード 200 は、リクエストが成功したことを示します。	200
Message	string	返されたメッセージ。	Successful

返されるデータには、次のパラメーターの一部またはすべてで構成される JSON 文字列が含まれます：

Error4XXRate：状態コードが 4XX の検出結果の割合。
Error6XXRate：状態コードが 6XX の検出結果の割合。
Error5XXRate：状態コードが 5XX の検出結果の割合。
Error4XXNumber：状態コードが 4XX の検出結果の数。
Error5XXNumber：状態コードが 5XX の検出結果の数。
Error6XXNumber：状態コードが 6XX の検出結果の数。
Over5totalTime：応答時間が 5,000 ms を超える検出リクエストの割合。
Over3totalTime：応答時間が 3,000 ms を超える検出リクエストの割合。
Over2totalTime：応答時間が 2,000 ms を超える検出リクエストの割合。
Over10FailureRate：検出リクエストの失敗率が 10% を超える検出ポイントの割合。
Over100FailureRate：検出リクエストの失敗率が 99% を超える検出ポイントの割合。
Over30FailureRate：検出リクエストの失敗率が 30% を超える検出ポイントの割合。
Over50FailureRate：検出リクエストの失敗率が 50% を超える検出ポイントの割合。
Over80FailureRate：検出リクエストの失敗率が 80% を超える検出ポイントの割合。
Over90FailureRate：検出リクエストの失敗率が 90% を超える検出ポイントの割合。
Over400NumberRate：状態コードが 400 を超える検出結果の割合。
Over400NumberRate：状態コードが 500 を超える検出結果の割合。
AvailableNumber：利用可能な検出ポイントの数。
UnavailableNumber：利用不可能な検出ポイントの数。
Availability：可用性率。
Unavailability：非可用性率。
ErrorCodeMaximum：特定の期間に返された検出結果の最大エラーコード。5 つの検出ポイントから検出リクエストが送信された後、1 分間に 5 つの状態コードが返されると仮定します。4 つの検出結果の状態コードが 200 で、1 つの検出結果の状態コードが 404 の場合、最大エラーコードは 404 です。
ErrorCodeMinimum：モニタリング期間中に返された検出結果の最小エラーコード。5 つの検出ポイントから検出リクエストが送信された後、1 分間に 5 つの状態コードが返されると仮定します。4 つの検出結果の状態コードが 200 で、1 つの検出結果の状態コードが 404 の場合、最小エラーコードは 200 です。

説明

値の計算が容易な AvailableNumber、UnavailableNumber、Availability、Unavailability、ErrorCodeMaximum、または ErrorCodeMinimum メトリックを使用することを推奨します。

例

成功レスポンス

JSONJSON

{
  "NextToken": "ea42e5220930ea42e522****",
  "Data": "[{\"Maximum\":247,\"Mimimum\":61,\"Average\":154,\"userId\":\"127067667954****\",\"taskId\":\"49f7b317-7645-4cc9-94fd-ea42e522****\",\"timestamp\":1551581760000}]",
  "RequestId": "3febb181-0d98-4af9-8b04-7faf36b048b9",
  "Success": "true",
  "Code": "200",
  "Message": "Successful"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidQueryParameter	%s
401	AccessDeniedException	You donot have sufficient access to perform this action.
500	InternalError	%s
402	LimitExceeded	The quota for this customer had been reached.
403	Forbidden	You are not authorized to operate the specified resource.
503	%s	%s
406	ExceedingQuota	Exceeding quota limits.
429	ThrottlingException	The request was denied due to request throttling.
409	%s	%s

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。