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

:DescribeInstanceBill

最終更新日:Aug 11, 2025

課金サイクル内のアカウントのすべてのプロダクトインスタンスまたは課金項目の消費サマリーをクエリします。

操作説明

  • 当月のデータは参考値であり、請求の遅延、返金、調整、または支払い遅延の償却により、月中に調整される場合があります。最終的な請求書は、翌月の 3 日の 12:00 以降に利用可能です。

  • 当月の請求データには、未決済の従量課金制リソースは含まれていません。

  • 過去 18 か月間のデータをクエリできます。

  • 請求データは、実際の使用状況と比較して 24 時間の遅延で更新されます。インスタンス ID に関連する情報は 48 時間の遅延で更新されます。これには、インスタンス構成、インスタンスタイプ、インスタンスニックネーム、リソースグループ、パブリック IP アドレス、プライベート IP アドレス、およびゾーンが含まれます。

  • 請求データは、CDN、OSS、インターネット共有帯域幅などのサービスの個々のアタッチされたリソースのコストを提供しません。たとえば、個々のドメイン名、バケット、または EIP のコストは提供されません。アタッチされたリソースのコストを表示するには、分割請求ページに移動します。

  • Alibaba Cloud Communications プロダクトの場合、2020 年 6 月以降の請求詳細のみをクエリできます。ドメインと商標を含む HiChina プロダクトの場合、2020 年 11 月以降の請求詳細のみをクエリできます。

  • 各アカウントは 1 秒あたり最大 10 クエリを実行できます。タイムアウトエラーが発生した場合は、再試行してください。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

bssapi:DescribeInstanceBill

get

*All Resource

*

bssapi:ProductCode
bssapi:ProductCode
bssapi:ProductType
bssapi:ProductType
なし

リクエストパラメーター

パラメーター

タイプ

必須 / 任意

説明

BillingCycle

string

必須

課金サイクル。 YYYY-MM 形式。過去 18 か月以内の課金サイクルのみがサポートされています。

2020-03

ProductCode

string

任意

プロダクトコード。

rds

ProductType

string

任意

プロダクトタイプ。

rds

SubscriptionType

string

任意

サブスクリプションタイプ。有効な値:

  • Subscription:サブスクリプション

  • PayAsYouGo:従量課金

PayAsYouGo

IsBillingItem

boolean

任意

課金項目ディメンションごとにデータをプルするかどうかを指定します。

  • false(デフォルト):データは、[費用とコスト] > [請求書] > [請求詳細] の下の [インスタンス請求] ページと一致しています。

  • true:データは、[費用とコスト] > [請求書] > [請求詳細] の下の [課金項目請求] ページと一致しています。

false

NextToken

string

任意

データの読み取り開始点を指定するトークン。最初のページの結果を読み取るには、このパラメータを空のままにします。次のページを読み取るには、このパラメータを前のレスポンスで返された NextToken 値に設定します。その他の値を設定するとエラーが発生します。

CAESEgoQCg4KCm

MaxResults

integer

任意

返すデータレコードの最大数。デフォルト値は 20 です。最大値は 300 です。

20

IsHideZeroCharge

boolean

任意

PretaxGrossAmount と PretaxAmount の両方が 0 である請求書を除外するかどうかを指定します。

  • false

  • true

false

BillingDate

string

任意

請求日。このパラメータは、Granularity が DAILY に設定されている場合にのみ必須です。形式は YYYY-MM-DD です。

説明

BillingDate の月は BillingCycle の月と一致する必要があります。たとえば、BillingCycle が 2020-03 の場合、BillingDate は 2020-03-DD 形式である必要があります。月が一致しない場合、クエリは BillingCycle 設定に基づいて結果を返します。

2020-03-02

Granularity

string

任意

クエリする請求書の粒度。有効な値:

  • MONTHLY:毎月。これは、[請求詳細] ページの [課金サイクル別請求書] タブの請求書に対応しています。

  • DAILY:毎日。これは、[請求詳細] ページの [日別請求書] タブの請求書に対応しています。

説明

DAILY を選択した場合は、BillingDate を指定します。

MONTHLY

BillOwnerId

integer

任意

リソース所有アカウントの ID。これは、実際にリソースを使用するアカウントです。

122

InstanceID

string

任意

インスタンス ID。

abc

PipCode

string

任意

プロダクトコード。これは、ユーザーセンターの請求書のプロダクトコードと同じです。

rds

レスポンスパラメーター

パラメーター

タイプ

説明

object

Code

string

状態コード。

Success

Message

string

エラーメッセージ。

Successful!

RequestId

string

リクエスト ID。

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

Success

boolean

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

true

Data

object

返されたデータ。

NextToken

string

次のクエリ位置を示すトークン。空の値は、すべてのデータが読み取られたことを示します。クエリを続行するには、NextToken リクエストパラメータを次の呼び出しでこの値に設定します。

CAESEgoQCg4KCm

BillingCycle

string

請求日。形式:YYYY-MM。

2020-03

MaxResults

integer

1 ページあたりに返されるレコードの最大数。

20

AccountID

string

アカウント ID。

122

TotalCount

integer

レコードの総数。

20

AccountName

string

ユーザーアカウント。

test@test.aliyunid.com

Items

array<object>

請求の詳細。

object

BillingDate

string

請求日は YYYY-MM-DD 形式です。このパラメータは、Granularity が DAILY に設定されている場合にのみ値を持ちます。

2020-03-20

InstanceConfig

string

インスタンスの詳細構成。

CPU:12

InternetIP

string

パブリック IP アドレス。

34.xx.x.x

Item

string

請求タイプ:

  • SubscriptionOrder:プリペイド注文。

  • PayAsYouGoBill:ポストペイド請求書。

  • Refund:返金。

  • Adjustment:調整。

PayAsYouGoBill

Tag

string

リソースのタグ。

key:testKey value:testValue; key:testKey1 value:testValues1

InstanceID

string

インスタンス ID。

i-dadada

Currency

string

通貨。有効な値は次のとおりです。

  • CNY

  • USD

  • JPY

CNY

BillAccountName

string

請求書に関連付けられているアカウントの名前。

test@test.aliyunid.com

DeductedByCashCoupons

number

キャッシュクーポンで差し引かれた金額。

0.1

SubscriptionType

string

サブスクリプションタイプ。有効な値:

  • Subscription:サブスクリプション。

  • PayAsYouGo:従量課金。

PayAsYouGo

BizType

string

サービスタイプ。

trusteeship

InstanceSpec

string

インスタンスタイプ。

ecs.sn1ne.3xlarge

DeductedByCoupons

number

クーポンで差し引かれた金額。

0.1

BillingItem

string

課金項目。このプロパティは、IsBillingItem が true の場合にのみ値を持ちます。

Bandwidth

BillingItemCode

string

課金項目コード。

disk

Region

string

リージョン。

China (Hangzhou)

OutstandingAmount

number

未払い金額。

0.1

CostUnit

string

コストセンター。

Not allocated

ListPriceUnit

string

定価の単位。このパラメータは、isBillingItem が true の場合にのみ有効です。

CNY

ResourceGroup

string

リソースグループ。

Default resource group

PipCode

string

プロダクトコード。これは、ユーザーセンターの請求書のプロダクトコードと同じです。

rds

ServicePeriodUnit

string

サービス期間の単位。

Second

PretaxAmount

number

税抜金額。

0.1

CommodityCode

string

プロダクトコード。これは、ユーザーセンターのプロダクト詳細コードと同じです。

rds

ProductName

string

プロダクトの名前。

ApsaraDB RDS

AdjustAmount

number

クレジット返金に対するオフセット。

0

NickName

string

インスタンスのニックネーム。

test

ProductDetail

string

プロダクトの詳細。

ApsaraDB RDS

Usage

string

使用量。

説明

このパラメータは、isBillingItem が true に設定されている場合にのみ有効です。使用量データは、エポック内のすべての請求書の合計使用量であり、実際に購入した量ではありません。たとえば、1 GB のストレージを使用し、1 時間ごとに請求書が生成される場合、1 時間の使用量は 1 GB です。請求書の 1 日の使用量は 1 GB × 24 = 24 GB です。

100

IntranetIP

string

内部 IP アドレス。

192.xx.xx.xx

OwnerID

string

複数アカウント支払いシナリオにおけるリソース所有者のアカウント ID。

123

DeductedByPrepaidCard

number

プリペイドカードで差し引かれた金額。

0.1

UsageUnit

string

使用量の単位。このパラメータは、isBillingItem が true の場合にのみ有効です。

GB

BillAccountID

string

請求書の属するアカウントの ID。

122

PaymentAmount

number

現金での支払い。これには、クレジットとして発行された返金で賄われた支払いが含まれます。

0.1

InvoiceDiscount

number

割引額。

0.1

DeductedByResourcePackage

string

リソースプランで差し引かれた金額。このパラメータは、isBillingItem が true の場合にのみ有効です。

0.1

ProductType

string

プロダクトタイプ。

rds

ServicePeriod

string

サービス期間。

3600

Zone

string

ゾーン。

Hangzhou Zone B

ListPrice

string

定価。これは、isBillingItem が true の場合にのみ有効です。

100

PretaxGrossAmount

number

元の金額。

0.1

CashAmount

number

現金で支払われた金額。これには、クレジットラインの返金からのオフセットは含まれません。

0

ProductCode

string

プロダクトコード。

rds

BillingType

string

課金方法。

Other

ItemName

string

プロジェクトの名前。

iZ28bycvyb4Z

AfterDiscountAmount

number

割引適用後の金額。この金額には、クーポン控除後の支払い額が含まれます。計算式:割引額 = 定価 - 割引額。

成功レスポンス

JSONJSON

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "79EE7556-0CFD-44EB-9CD6-B3B526E3A85F",
  "Success": true,
  "Data": {
    "NextToken": "CAESEgoQCg4KCm",
    "BillingCycle": "2020-03",
    "MaxResults": 20,
    "AccountID": "122",
    "TotalCount": 20,
    "AccountName": "test@test.aliyunid.com",
    "Items": [
      {
        "BillingDate": "2020-03-20",
        "InstanceConfig": "CPU:12",
        "InternetIP": "34.xx.x.x\t",
        "Item": "PayAsYouGoBill",
        "Tag": "key:testKey value:testValue; key:testKey1 value:testValues1",
        "InstanceID": "i-dadada",
        "Currency": "CNY",
        "BillAccountName": "test@test.aliyunid.com",
        "DeductedByCashCoupons": 0.1,
        "SubscriptionType": "PayAsYouGo",
        "BizType": "trusteeship",
        "InstanceSpec": "ecs.sn1ne.3xlarge\t",
        "DeductedByCoupons": 0.1,
        "BillingItem": "Bandwidth\n",
        "BillingItemCode": "disk",
        "Region": "China (Hangzhou)\n",
        "OutstandingAmount": 0.1,
        "CostUnit": "Not allocated\n",
        "ListPriceUnit": "CNY\n",
        "ResourceGroup": "Default resource group\n",
        "PipCode": "rds",
        "ServicePeriodUnit": "Second\n",
        "PretaxAmount": 0.1,
        "CommodityCode": "rds",
        "ProductName": "ApsaraDB RDS\n",
        "AdjustAmount": 0,
        "NickName": "test",
        "ProductDetail": "ApsaraDB RDS\n",
        "Usage": "100",
        "IntranetIP": "192.xx.xx.xx",
        "OwnerID": "123",
        "DeductedByPrepaidCard": 0.1,
        "UsageUnit": "GB",
        "BillAccountID": "122",
        "PaymentAmount": 0.1,
        "InvoiceDiscount": 0.1,
        "DeductedByResourcePackage": "0.1",
        "ProductType": "rds",
        "ServicePeriod": "3600",
        "Zone": "Hangzhou Zone B\n",
        "ListPrice": "100",
        "PretaxGrossAmount": 0.1,
        "CashAmount": 0,
        "ProductCode": "rds",
        "BillingType": "Other\n",
        "ItemName": "iZ28bycvyb4Z",
        "AfterDiscountAmount": 0
      }
    ]
  }
}

エラーコード

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

変更履歴

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