DescribeDomainUsageData 操作を呼び出して、特定の請求リージョンにある 1 つ以上のドメイン名の使用状況データを照会します。
操作説明
-
この操作は、ドメイン名のバッチクエリをサポートしています。複数のドメイン名を照会するには、カンマ (,) で区切ります。一度に最大 100 個のドメイン名を照会できます。 DomainName パラメーターを指定しない場合、操作はアカウントに関連付けられているすべてのドメイン名のデータを返します。
-
使用状況データには、トラフィック、帯域幅、リクエスト数が含まれます。単位はそれぞれバイト、bps、カウントです。
-
Interval パラメーターを指定しない場合、過去 1 年以内に生成されたデータを照会できます。1 回のクエリの最大時間範囲は 31 日です。時間範囲が 1 ～ 3 日の場合、データは 1 時間ごとの粒度で返されます。時間範囲が 3 日を超える場合、データは日単位の粒度で返されます。
-
Interval パラメーターを指定した場合、1 回のクエリの最大時間範囲、照会可能な既存データ範囲、およびデータ遅延は次のとおりです。
時間の粒度 | 1 回のクエリの最大時間範囲 | 照会可能な既存データ範囲 | データ遅延 |
5 分 | 3 日 | 93 日 | 15 分 |
1 時間 | 31 日 | 186 日 | 4 時間 |
1 日 | 90 日 | 366 日 | 翌日の午前 4 時 00 分 |
QPS 制限
1 ユーザーあたりのクエリ/秒 (QPS) 制限は 10 です。この制限を超えると、API 呼び出しがスロットルされます。これはビジネスに影響を与える可能性があります。それに応じて呼び出しを計画してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
live:DescribeDomainUsageData |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
タイプ |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
任意 |
リージョンの ID。 |
cn-shanghai |
| DomainName |
string |
任意 |
ライブストリーミングドメイン名。
|
example.com |
| StartTime |
string |
必須 |
照会する時間範囲の開始時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式で指定します。時刻は UTC でなければなりません。 |
2015-12-10T20:00:00Z |
| EndTime |
string |
必須 |
照会する時間範囲の終了時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式で指定します。時刻は UTC でなければなりません。 終了時刻は開始時刻より後である必要があります。時間範囲は 31 日を超えることはできません。 |
2015-12-10T21:00:00Z |
| Type |
string |
任意 |
照会する使用状況データのタイプ。 Field が bps または traf に設定されている場合、有効な値は次のとおりです。
Field が req_traf または req_bps に設定されている場合、有効な値は次のとおりです。
|
all |
| Field |
string |
必須 |
照会する使用状況データのタイプ。有効な値は次のとおりです。
|
traf |
| Area |
string |
任意 |
リージョン。有効な値は次のとおりです。
説明
このパラメーターを指定しない場合、デフォルト値は CN です。リージョンは次のように定義されています。アジア太平洋 1: 香港 (中国)、マカオ (中国)、台湾 (中国)、日本、およびベトナムとインドネシアを除く東南アジア諸国。アジア太平洋 2: インドネシア、韓国、ベトナム。アジア太平洋 3: オーストラリアとニュージーランド。北米: 米国とカナダ。南米: ブラジル。ヨーロッパ: ウクライナ、英国、フランス、オランダ、スペイン、イタリア、スウェーデン、ドイツ。中東およびアフリカ: 南アフリカ、オマーン、アラブ首長国連邦、クウェート。 |
CN |
| DataProtocol |
string |
任意 |
照会するデータのプロトコル。有効な値は次のとおりです。
|
all |
| Interval |
string |
任意 |
照会するデータの時間粒度 (秒単位)。これにより、操作は特定の粒度でデータを返すようになります。有効な値: 300 (5 分)、3600 (1 時間)、86400 (1 日)。 |
300 |
特定の時刻 T のデータを照会する場合、その時刻の安定したデータは 2 時間後に利用可能になります。
たとえば、12 月 21 日午後 1 時のデータを照会する場合、12 月 21 日午後 3 時に午後 1 時以前の安定したデータを取得できます。
レスポンスパラメーター
|
パラメーター |
タイプ |
説明 |
例 |
|
object |
|||
| EndTime |
string |
時間範囲の終了時刻。時刻は UTC で、形式は yyyy-MM-ddTHH:mm:ssZ です。 |
2015-12-10T21:00Z |
| Type |
string |
使用状況データのタイプ。 |
all |
| StartTime |
string |
時間範囲の開始時刻。時刻は UTC で、形式は yyyy-MM-ddTHH:mm:ssZ です。 |
2015-12-10T20:00Z |
| RequestId |
string |
リクエストの ID。 |
B955107D-E658-4E77-B913-E0AC3D31693E |
| Area |
string |
使用リージョン。 |
CN |
| DomainName |
string |
ライブストリーミングドメイン名。 |
example.com |
| DataInterval |
string |
データレコード間の時間間隔 (秒単位)。 |
300 |
| UsageDataPerInterval |
object |
||
| DataModule |
array<object> |
各レコードの使用状況データ。 |
|
|
object |
|||
| Value |
string |
使用値。
|
423304182 |
| TimeStamp |
string |
時間スライスの開始時刻。時刻は UTC で、形式は yyyy-MM-ddTHH:mm:ssZ です。 |
2015-12-10T20:00:00Z |
例
成功レスポンス
JSONJSON
{
"EndTime": "2015-12-10T21:00Z",
"Type": "all",
"StartTime": "2015-12-10T20:00Z",
"RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
"Area": "CN",
"DomainName": "example.com",
"DataInterval": "300",
"UsageDataPerInterval": {
"DataModule": [
{
"Value": "423304182",
"TimeStamp": "2015-12-10T20:00:00Z"
}
]
}
}エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvaildParameter | Invalid Parameter | |
| 400 | InvalidStartTime.Malformed | Specified StartTime is malformed. | |
| 400 | InvalidEndTime.Malformed | Specified EndTime is malformed. | |
| 400 | InvalidStartTime.ValueNotSupported | The specified value of parameter StartTime is not supported. | |
| 400 | InvalidTime.Malformed | Specified Time is malformed. | |
| 400 | InvalidParameterField | The specified Field is invalid. | |
| 400 | InvalidParameterType | The specified Type is invalid. | |
| 400 | InvalidEndTime.Mismatch | Specified end time does not math the specified start time. | |
| 400 | InvalidTimeSpan | The time span exceeds the limit. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。