DescribeSiteTopData API リファレンス - Edge Security Acceleration

ウェブサイトまたは Alibaba Cloud アカウント別に、トラフィック分析レポートの上位レコードをクエリします。

操作説明

StartTime と EndTime を指定しない場合、このインターフェースは過去 24 時間のデータを返します。StartTime と EndTime を指定した場合、このインターフェースは指定された期間のデータを返します。
クエリ期間のアクセス回数が多いため、データ分析はサンプリングされる場合があります。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

esa:DescribeSiteTopData

none

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SiteId	string	任意	ウェブサイト ID です。ListSites 操作を呼び出すことで取得できます。このパラメーターを指定しない場合、システムはアカウント単位でデータを返します。	1150376036*****
StartTime	string	任意	クエリ対象の時間範囲の開始時刻です。 ISO 8601 標準に準拠した yyyy-MM-ddTHH:mm:ssZ フォーマットで時間を指定します。時刻は協定世界時 (UTC) である必要があります。	2023-04-08T16:00:00Z
EndTime	string	任意	クエリ対象の時間範囲の終了時刻です。 ISO 8601 標準に準拠した yyyy-MM-ddTHH:mm:ssZ フォーマットで時間を指定します。時刻は協定世界時 (UTC) である必要があります。説明終了時刻は開始時刻より後である必要があります。	2023-04-09T16:00:00Z
Interval	string	任意	返すデータエントリ間の時間間隔です。単位：秒。	300
Fields	array<object>	必須	クエリ対象のメトリックです。
	object	任意	クエリ対象のメトリックです。
FieldName	string	任意	メトリック名です。	Traffic
Dimension	array	任意	データをクエリするディメンションです。
	string	任意	データをクエリするディメンションです。説明詳細については、対応するログフィールドをご参照ください。	ALL
Limit	string	任意	クエリする上位データエントリの数です。列挙値: 5 : 5 10 : 10 150 : 150	5

レスポンスフィールド

フィールド	型	説明	例
	object
Data	array<object>	返されるデータ。
	array<object>	返されるデータ。
FieldName	string	メトリック名。	Traffic
DimensionName	string	データがクエリされたディメンション。	ALL
DetailData	array<object>	返されるデータ。
	object	返されるデータ。
DimensionValue	string	ディメンション値。	ALL
Value	any	クエリされた数値。	123
RequestId	string	リクエスト ID。	35C66C7B-671H-4297-9187-2C447724****
StartTime	string	データがクエリされた期間の開始時刻。時刻は ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式に従います。時刻は協定世界時 (UTC) で表示されます。	2023-04-08T16:00:00Z
EndTime	string	データがクエリされた期間の終了時刻。時刻は ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式に従います。時刻は協定世界時 (UTC) で表示されます。	2023-04-09T16:00:00Z
SamplingRate	number	サンプリングレート。	100

例

成功レスポンス

JSONJSON

{
  "Data": [
    {
      "FieldName": "Traffic",
      "DimensionName": "ALL",
      "DetailData": [
        {
          "DimensionValue": "ALL",
          "Value": "123"
        }
      ]
    }
  ],
  "RequestId": "35C66C7B-671H-4297-9187-2C447724****",
  "StartTime": "2023-04-08T16:00:00Z",
  "EndTime": "2023-04-09T16:00:00Z",
  "SamplingRate": 100
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidParameter.TimeRange	The specified time range exceeds the limit. Adjust it and try again.
400	TooManyRequests	Too many requests.Please try again later.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.
400	InvalidParameter	Parameter verification failed. Check your configurations and try again.
400	QuotaCheckFailed.Function	The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.
400	InvalidParameter.Field	The specified Field is invalid.
400	InvalidParameter.Dimension	The specified Dimension is invalid.
400	InvalidTime.Malformed	Specified start time or end time is malformed.
400	TooManyDimensions	Too many query dimensions specified. Delete some and try again.

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

変更履歴

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