GetOssUsageData を使用してストレージと帯域幅使用量をクエリする - ENS

操作説明

帯域幅およびストレージ使用量の照会・集約粒度は、1 日を超えることはできません。データ集約とは、一定期間内における使用量データの最大値を収集することです。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ens:GetOssUsageData

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
StartTime	string	必須	照会対象期間の開始時刻です。時刻は協定世界時 (UTC) で指定する必要があります。フォーマット：2010-01-21T09:50:23Z。	2022-01-11T00:00:00Z
EndTime	string	必須	照会対象期間の終了時刻です。時刻は協定世界時 (UTC) で指定する必要があります。フォーマット：2010-01-21T09:50:23Z。	2022-01-12T00:00:00Z
Bucket	string	任意	論理的な Object Storage Service (OSS) バケットの名前です。	ens-sink-bucketzyp1656903494
Period	string	任意	集約粒度です。単位：分。デフォルト値：5。有効な値：5～1440。	10

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID です。	2A8CCD48-14F9-0309-B957-7B1D74A8119D
UsageList	array<object>	使用量データの配列です。
	object
LanRxBw	integer	内部ネットワーク経由のインバウンド帯域幅です。単位：bit/s。	37865147
LanTxBw	integer	内部ネットワーク経由のアウトバウンド帯域幅です。単位：bit/s。	22012187890
Point	integer	1 日あたりの時間ポイント数です。	144
PointTs	string	協定世界時 (UTC) での時間ポイントです。フォーマット：2010-01-21T09:50:23Z。	2022-01-12T00:00:00Z
StorageUsageByte	integer	ストレージ使用量です。単位：バイト。	85462146217
WanRxBw	integer	インターネット経由のアウトバウンド帯域幅 (単位：ビット/秒) です。	542155715
WanTxBw	integer	インターネット経由のアウトバウンド帯域幅です。単位：bit/s。	547126175217

例

成功レスポンス

JSONJSON

{
  "RequestId": "2A8CCD48-14F9-0309-B957-7B1D74A8119D",
  "UsageList": [
    {
      "LanRxBw": 37865147,
      "LanTxBw": 22012187890,
      "Point": 144,
      "PointTs": "2022-01-12T00:00:00Z",
      "StorageUsageByte": 85462146217,
      "WanRxBw": 542155715,
      "WanTxBw": 547126175217
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	ParamNotEnough	参数不足
400	ParamScopeError	参数值错误
400	ParamTypeError	参数类型错误
400	SqlError	数据库操作异常
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

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

変更履歴

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