すべてのプロダクト
Search
ドキュメントセンター

:DescribeSavingsPlansUsageTotal

最終更新日:Jan 29, 2026

節約プランの総使用量をクエリします。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

bss:SavingsPlansAnalysis

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

StartPeriod

string

必須

クエリする期間の開始時刻。 開始時刻はクエリ範囲に含まれます。 時刻の形式は yyyy-MM-dd HH:mm:ss です。

2021-01-01 00:00:00

EndPeriod

string

任意

クエリする期間の終了時刻。 終了時刻はクエリ範囲に含まれません。 このパラメーターを指定しない場合、現在の時刻が使用されます。 時刻の形式は yyyy-MM-dd HH:mm:ss です。

2021-01-02 00:00:00

PeriodType

string

必須

クエリする使用量概要の時間の粒度。 有効な値: MONTH、DAY、HOUR。

HOUR

BillOwnerId

integer

任意

リソースを所有するアカウントの ID。 リソース所有者は、リソースを使用するアカウントです。

123745698925000

FilterParam

object

任意

Dimensions

array<object>

任意

object

任意

Code

string

任意

Values

array

任意

string

任意

SelectType

string

任意

Tags

array<object>

任意

object

任意

Code

string

任意

Values

array

任意

string

任意

SelectType

string

任意

レスポンスフィールド

フィールド

説明

object

Code

string

ステータスコード。

success

Message

string

呼び出しに対して返されるメッセージ。

Successful!

RequestId

string

リクエスト ID。

79EE7556-0CFD-44EB-9CD6-B3B526E3A85F

Success

boolean

リクエストが成功したかどうかを示します。

true

Data

object

返されるデータ。

PeriodCoverage

array<object>

各期間の使用量データ。

object

Percentage

number

使用率。

1

Period

string

データの期間。 形式は yyyyMMddHH です。

2021041500

TotalUsage

object

総使用量の概要。

PostpaidCost

number

従量課金のコスト。

200

SavedCost

number

節約額。

100

UsagePercentage

number

総使用率。

1

PoolValue

number

節約プランの合計プール値。

100

成功レスポンス

JSONJSON

{
  "Code": "success",
  "Message": "Successful!",
  "RequestId": "79EE7556-0CFD-44EB-9CD6-B3B526E3A85F",
  "Success": true,
  "Data": {
    "PeriodCoverage": [
      {
        "Percentage": 1,
        "Period": "2021041500"
      }
    ],
    "TotalUsage": {
      "PostpaidCost": 200,
      "SavedCost": 100,
      "UsagePercentage": 1,
      "PoolValue": 100
    }
  }
}

エラーコード

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

変更履歴

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