DescribeBackupPlanBilling - - Alibaba Cloud ドキュメントセンター

この操作は、バックアッププランの課金情報を照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dbs:DescribeBackupPlanBilling

get

*BackupPlan

acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
BackupPlanId	string	必須	バックアッププランの ID。DescribeBackupPlanList 操作を呼び出して、このパラメーターの値を取得します。	dbstooi01ex****
ClientToken	string	任意	リクエストのべき等性を保証するためのクライアントトークン。この値はクライアントによって生成され、異なるリクエスト間で一意である必要があります。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。	ETnLKlblzczshOTUbOCzxxxxxxxxxx
ShowStorageType	boolean	任意	ストレージクラスを表示するかどうかを指定します。	true

レスポンスフィールド

フィールド	型	説明	例
	object
HttpStatusCode	integer	HTTP ステータスコード。	400
RequestId	string	リクエスト ID。	DD7BC7F5-4E3A-5DF3-BFF9-831503C4D9E3
ErrCode	string	エラーコード。	InvalidParameter
Success	boolean	リクエストが成功したかどうかを示します。	true
ErrMessage	string	エラーメッセージ。	This backupPlan can't support this action
Item	object	バックアッププランの課金情報。
BuyCreateTimestamp	integer	インスタンスが購入された日時を示すタイムスタンプ。	1658372830000
FullStorageSize	integer	完全バックアップデータが使用するストレージ領域。単位：バイト。	151
BuyExpiredTimestamp	integer	インスタンスの有効期限が切れる日時を示すタイムスタンプ。説明このパラメーターは、BuyChargeType が PREPAY に設定されている場合にのみ返されます。	1661097600000
BuySpec	string	インスタンスタイプ。	micro
QuotaEndTimestamp	integer	無料バックアップトラフィックの課金サイクルの終了を示すタイムスタンプ。	1659283200000
IsExpired	boolean	インスタンスの有効期限が切れているかどうかを示します。説明このパラメーターは、BuyChargeType が PREPAY に設定されている場合にのみ返されます。	true
QuotaStartTimestamp	integer	無料バックアップトラフィックの課金サイクルの開始を示すタイムスタンプ。	1656604800000
TotalFreeBytes	integer	当月の無料バックアップトラフィックの合計。単位：バイト。説明このパラメーターは、BuyChargeType が PREPAY に設定され、かつ IsFreeBytesUnlimited が false の場合にのみ返されます。	858993459200
PaiedBytes	integer	当月の有料バックアップトラフィックの合計。単位：バイト。	0
UsedFullBytes	integer	当月の完全バックアップの有料トラフィック。単位：バイト。	0
IsFreeBytesUnlimited	boolean	インスタンスが無料のバックアップトラフィックを無制限に提供するかどうかを示します。	true
ContStorageSize	integer	増分バックアップデータが使用するストレージ領域。単位：バイト。	10437039
BuyChargeType	string	インスタンスの課金方法。有効な値： PREPAY：サブスクリプション POSTPAY：従量課金	PREPAY
UsedIncrementBytes	integer	当月の増分バックアップの有料トラフィック。単位：バイト。	9406734

例

成功レスポンス

JSONJSON

{
  "HttpStatusCode": 400,
  "RequestId": "DD7BC7F5-4E3A-5DF3-BFF9-831503C4D9E3",
  "ErrCode": "InvalidParameter",
  "Success": true,
  "ErrMessage": "This backupPlan can't support this action",
  "Item": {
    "BuyCreateTimestamp": 1658372830000,
    "FullStorageSize": 151,
    "BuyExpiredTimestamp": 1661097600000,
    "BuySpec": "micro",
    "QuotaEndTimestamp": 1659283200000,
    "IsExpired": true,
    "QuotaStartTimestamp": 1656604800000,
    "TotalFreeBytes": 858993459200,
    "PaiedBytes": 0,
    "UsedFullBytes": 0,
    "IsFreeBytesUnlimited": true,
    "ContStorageSize": 10437039,
    "BuyChargeType": "PREPAY",
    "UsedIncrementBytes": 9406734
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
403	Request.Forbidden	Have no Permissions

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

変更履歴

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