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

操作説明

この操作を呼び出すときは、次の点に注意してください。

一度にサブスクライブできる請求書ファイルの種類は 1 つだけです。
サブスクライブすると、システムは前日の請求書ファイルを毎日プッシュし始めます。毎月 4 日には、システムは前の課金サイクルの完全な請求書ファイルをプッシュします。前月の PDF 形式の月次請求書も毎月 4 日にプッシュされます。
日次請求書ファイルの生成が遅れる場合があります。遅延した請求書ファイルは翌日プッシュされます。このファイルには、前日から遅延した請求書データも含まれる場合があります。毎月初めに前月の全データをプルしてください。

説明

OSS を使用して初めて請求書をサブスクライブする場合は、AliyunConsumeDump2OSSRole 権限をサブスクライバーに付与する必要があります。権限付与が取り消されると、システムはファイルのプッシュを停止します。権限を再度付与する必要があります。

このサブスクリプションは、経費とコストコンソールの「データストレージ」機能と同等です。サブスクリプションは同期されます。
バケット内のフォルダをサブスクライブする場合は、フォルダ名が次の要件を満たしていることを確認してください。
- 絵文字は使用しないでください。有効な UTF-8 文字を使用してください。
- スラッシュ (/) を使用してパスを区切り、サブディレクトリを作成します。スラッシュ (/) またはバックスラッシュ (\) で名前を開始しないでください。連続したスラッシュ (/) は使用しないでください。
- サブディレクトリに「..」という名前を付けないでください。
- 全長は 1 ～ 254 文字である必要があります。
ファイル名:
- BillingItemDetailForBillingPeriod (課金項目別の請求書の詳細)
  - 毎日プッシュされるファイルの形式: UID_BillingItemDetail_YYYYMMDD。例: 169**_BillingItemDetail_20190310.
  - 翌月初めの完全ファイルの形式: UID_BillingItemDetail_YYYYMM。例: 169**_BillingItemDetail_201903.
- InstanceDetailForBillingPeriod (インスタンス別の請求書の詳細)
  - 毎日プッシュされるファイルの形式: UID_InstanceDetail_YYYYMMDD。例: 169**_InstanceDetail_20190310.
  - 翌月初めの完全ファイルの形式: UID_InstanceDetail_YYYYMM。例: 169**_InstanceDetail_201903.
- InstanceDetailMonthly (インスタンス別の月次請求書の概要)
  - 毎日プッシュされるファイルの形式: UID_InstanceDetailMonthly_YYYYMM。例: 169**_InstanceDetailMonthly_201903. このファイルは、月初から現在までの完全データで毎日更新されます。このプロセスは翌月の 4 日まで続きます。
- BillingItemDetailMonthly (課金項目別の月次請求書の概要)
  - 毎日プッシュされるファイルの形式: UID_BillingItemDetailMonthly_YYYYMM。例: 169**_BillingItemDetailMonthly_201903. このファイルは、月初から現在までの完全データで毎日更新されます。このプロセスは翌月の 4 日まで続きます。
- SplitItemDetailDaily (分割請求書の日次概要)
  - 毎日プッシュされるファイルの形式: UID_SplitItemDetailDaily_YYYYMM。例: 169**_SplitItemDetailDaily_201903. このファイルは、月初から現在までの完全データで毎日更新されます。このプロセスは翌月の 4 日まで続きます。
- MonthBill (PDF 形式の月次請求書)
  - 毎月プッシュされるファイルの形式: UID_MonthBill_YYYYMM。例: 169**_MonthBill_201903. 前月の請求書ファイルは毎月 4 日にプッシュされます。
PDF 形式の MonthBill ファイルを除き、他のすべてのファイルは CSV 形式です。請求書のデータ行数が特定のしきい値を超えると、請求書は複数の CSV ファイルに分割されます。これらのファイルはマージされ、ZIP ファイルに圧縮されます。ZIP ファイルは同じファイル名形式を使用します。

今すぐお試しください

この 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:ModifySubscribeToOSS

create

*All Resource

*

なし

リクエストパラメーター

パラメーター	タイプ	必須 / 任意	説明	例
SubscribeBucket	string	必須	サブスクライブされた請求書ファイルが保存される OSS バケットの名前。	xxxxxx-bucket
SubscribeType	string	任意	サブスクライブする請求書の種類。有効な値: BillingItemDetailForBillingPeriod: 課金項目別の請求書の詳細。 InstanceDetailForBillingPeriod: インスタンス別の請求書の詳細。 BillingItemDetailMonthly: 課金項目別の月次請求書の概要。 InstanceDetailMonthly: インスタンス別の月次請求書の概要。 SplitItemDetailDaily: 分割請求書の日次概要。 MonthBill: PDF 形式の月次請求書。Alibaba Cloud アカウントの月次請求書のみサブスクライブできます。	BillingItemDetailForBillingPeriod
MultAccountRelSubscribe	string	任意	サブスクライブする請求書の種類。このパラメーターは、複数層アカウントでのみ使用できます。有効な値: MA: Alibaba Cloud アカウントの請求書と、非信託リンクアカウントの請求書をプッシュします。 ACP1: 仮想ディーラーのサブアカウントの請求書をプッシュします。デフォルト: MA.	MA
BucketOwnerId	integer	任意	OSS バケット所有者の UID。このパラメーターは、販売代理店が請求書をサブスクライブしてサブアカウントの OSS バケットに保存する場合にのみ必要です。この場合、サブアカウントは販売代理店アカウントのサブアカウントであり、AliyunConsumeDump2OSSRole 権限が付与されている必要があります。通常のユーザーはこのパラメーターを指定する必要はありません。デフォルトでは、現在のアカウントの UID が使用されます。	12341324
BeginBillingCycle	string	任意	請求書がプッシュされる最初の課金サイクル。請求書をサブスクライブすると、システムは最初の課金サイクルから現在までのデータを自動的にプッシュします。このパラメーターは、PDF 形式の月次請求書のサブスクリプションでは無効です。履歴データは再プッシュされません。過去 1 年以内に生成されたデータをプッシュできます。	2021-03
BucketPath	string	任意	サブスクライブするバケット内の指定されたフォルダ。	testpath
RowLimitPerFile	integer	任意	1 つのファイルの最大行数。請求書ファイルがこの制限を超えると、複数のファイルに分割されます。ファイルはマージされ、ZIP パッケージに圧縮されます。	300000
UsingSsl	string	任意	ネットワーク通信の保護に Secure Sockets Layer (SSL) を使用するかどか。有効な値: true: SSL 暗号化を有効にして、転送中のデータのセキュリティと整合性を確保します。 false (デフォルト): SSL 暗号化を無効にします。	true

レスポンスパラメーター

パラメーター	タイプ	説明	例
	object
Code	string	状態コード。	Success
Message	string	エラーメッセージ。	Successful!
RequestId	string	リクエスト ID。	F61FCE4B-9B56-4FD9-A17E-******
Success	boolean	リクエストが成功したかどうかを示します。	true

例

成功レスポンス

JSONJSON

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "F61FCE4B-9B56-4FD9-A17E-******",
  "Success": true
}

エラーコード

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

変更履歴

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