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

:QueryBill

最終更新日:Jul 31, 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:DescribeBillList

get

*すべてのリソース。

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

BillingCycle

string

必須

請求書の課金サイクル。YYYY-MM フォーマットです。

2018-07

Type

string

任意

タイプ。有効な値:

  • SubscriptionOrder

  • PayAsYouGoBill

  • Refund

  • Adjustment

SubscriptionOrder

ProductCode

string

任意

プロダクトコード。

rds

ProductType

string

任意

プロダクトタイプ。

rds

SubscriptionType

string

任意

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

  • Subscription

  • PayAsYouGo

説明

このパラメーターは ProductCode パラメーターと一緒に使用する必要があります。

Subscription

IsHideZeroCharge

boolean

任意

元価格 (PretaxGrossAmount) が 0 の請求書をフィルターで除外するかどうかを指定します。デフォルト値: false (既存ロジックと互換)。有効な値:

  • true: ゼロ充電の請求書をフィルターで除外します。

  • false: ゼロ充電の請求書をフィルターで除外しません。

true

PageNum

integer

任意

ページ番号。デフォルト値: 1。

1

PageSize

integer

任意

1 ページあたりのエントリ数。デフォルト値: 20。最大値: 300。

20

BillOwnerId

integer

任意

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

123

レスポンスフィールド

フィールド

説明

object

Code

string

状態コード。

Success

Message

string

エラーメッセージ。

Successful!

RequestId

string

リクエスト ID。

AE3F4057-DFC9-4B81-8858-F620651010C9

Success

boolean

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

true

Data

object

返されるデータ。

PageNum

integer

ページ番号。

1

BillingCycle

string

請求書の課金サイクル。YYYY-MM フォーマットです。

2020-02

AccountID

string

アカウント ID。

185xxxxx489

PageSize

integer

1 ページあたりのエントリ数。

1

TotalCount

integer

レコードの総数。

20

AccountName

string

アカウント名。

test@test.aliyunid.com

Items

object

Item

array<object>

請求書の詳細。

object

Status

string

支払いステータス。有効な値:

  • PayFinish: 支払い済み。

  • PayUnclear: 未清算。

  • PayUnsettle: 未決済。

  • NoSettle: 決済必須ではありません。

PayFinish

RoundDownDiscount

string

四捨五入によるダウン割引額。

0

Item

string

請求書タイプ。有効な値:

  • SubscriptionOrder

  • PayAsYouGoBill

  • Refund

  • Adjustment

SubscriptionOrder

Currency

string

通貨。有効な値:

  • CNY

  • USD

  • JPY

CNY

UsageStartTime

string

請求書の開始時刻。

2020-03-11 07:00:00

SubscriptionType

string

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

  • Subscription

  • PayAsYouGo

PayAsYouGo

UsageEndTime

string

請求書の終了時間。

2020-03-11 08:00:00

DeductedByCoupons

number

クーポンによる控除額。

0

SubOrderId

string

請求書に対応する注文詳細の ID。

325345254353

OutstandingAmount

number

未払い金額。

0

AfterTaxAmount

number

PaymentTime

string

注文の支払い時間。

2020-03-11 08:00:00

PretaxAmountLocal

number

Tax

number

PipCode

string

プロダクトコード。

rds

PaymentTransactionID

string

PretaxAmount

number

支払金額。

100

CommodityCode

string

商品コード。

rds

ProductName

string

プロダクト名。

ApsaraDB RDS

RecordID

string

注文 ID または請求書 ID。

2020xxxx5912

AdjustAmount

number

クレジット返金による控除額。

0

ProductDetail

string

プロダクトの詳細。

Relational Database Service (Subscription)

PaymentCurrency

string

OwnerID

string

メンバーアカウントの AccountID (マルチアカウント支払いシナリオの場合)。

3532535235

ProductType

string

プロダクトタイプ。

rds

InvoiceDiscount

number

割引額。

0

PaymentAmount

number

現金支払額 (クレジット返金の控除を含む)。

0

PretaxGrossAmount

number

元価格。

0

CashAmount

number

現金支払額 (クレジット返金の控除を除く)。

0

ProductCode

string

プロダクトコード。

rds

成功レスポンス

JSONJSON

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "AE3F4057-DFC9-4B81-8858-F620651010C9",
  "Success": true,
  "Data": {
    "PageNum": 1,
    "BillingCycle": "2020-02",
    "AccountID": "185xxxxx489",
    "PageSize": 1,
    "TotalCount": 20,
    "AccountName": "test@test.aliyunid.com",
    "Items": {
      "Item": [
        {
          "Status": "PayFinish",
          "RoundDownDiscount": "0",
          "Item": "SubscriptionOrder",
          "Currency": "CNY",
          "UsageStartTime": "2020-03-11 07:00:00",
          "SubscriptionType": "PayAsYouGo",
          "UsageEndTime": "2020-03-11 08:00:00",
          "DeductedByCoupons": 0,
          "SubOrderId": "325345254353",
          "OutstandingAmount": 0,
          "AfterTaxAmount": 0,
          "PaymentTime": "2020-03-11 08:00:00",
          "PretaxAmountLocal": 0,
          "Tax": 0,
          "PipCode": "rds",
          "PaymentTransactionID": "",
          "PretaxAmount": 100,
          "CommodityCode": "rds",
          "ProductName": "ApsaraDB RDS",
          "RecordID": "2020xxxx5912",
          "AdjustAmount": 0,
          "ProductDetail": "Relational Database Service (Subscription)",
          "PaymentCurrency": "",
          "OwnerID": "3532535235",
          "ProductType": "rds",
          "InvoiceDiscount": 0,
          "PaymentAmount": 0,
          "PretaxGrossAmount": 0,
          "CashAmount": 0,
          "ProductCode": "rds"
        }
      ]
    }
  }
}

エラーコード

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

変更履歴

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