コスト分析の概要

使用量APIでは、MONTLY、DAILYおよびHOURLYの粒度がサポートされます。すべてのstartTimeは包含的で、endTimeは排他的であり、Java部分文字列と同じです。

• HOURLYの場合、最大36時間の期間のみがサポートされ、1時間を超える精度はありません。これは、入力時間に分または秒がないことを意味します。

• MONTHLYの場合、月の最初の日付から別の月の最初の日付までのみがサポートされます。たとえば、2020-06-01T00:00:00Zで、最大12か月の期間です。

• DAILYの場合、最大90日の期間で、1日を超える精度はサポートされません。これは00:00:00として入力する必要があります。たとえば、2020-06-01T00:00:00Zです。

APIレスポンスでは、ディメンションはgroupByでのみ表示されます。たとえば、"service"がgroupByにない場合、レスポンスの"service"フィールドは空になります。

APIはUSAGEまたはCOSTを問い合せることができます。computedQuantityは使用量を表し、computedAmountはコストを表します。使用量を期待どおりに取得するには、queryTypeをUSAGEに設定するか、groupByKeyに"unit"を追加する必要があります。これは、単位別にグループ化する場合に使用量が正しく集計/グループ化されるためです。

APIリクエストでのネストされたフィルタリングがサポートされています。フィルタのリストは、演算子によって評価されます。各フィルタでは、すべてのディメンションおよびタグが演算子によって評価されます。フィルタ・リストとディメンション/タグの同時評価はサポートされていません。つまり、ディメンションまたはタグとフィルタ・リストを同時に空以外にすることはできません。

サポートされている演算子はAND、ORです。次の2つのフィルタは等しいです:

"filter": {
  "operator": "AND",
  "dimensions": [
    {
      "key": "service",
      "value": "compute"
    },
    {
      "key": "compartmentPath",
      "value": "abc/cde"
    }
  ],
  "tags": [
    {
      "namespace": "compute",
      "key": "created",
      "value": "string"
    }
  ],
  "filters": null
}
  
or 
 
"filter": {
    "operator": "AND",
    "dimensions": [],
    "tags": [],
    "filters": [{
            "operator": "AND",
            "dimensions": [{
                "key": "service",
                "value": "compute"
            }],
            "tags": null,
            "filters": null
        }, {
            "operator": "AND",
            "dimensions": [{
                "key": "compartmentPath",
                "value": "abc/cde"
            }],
            "tags": null,
            "filters": null
        },
        {
            "operator": "AND",
            "dimensions": null,
            "tags": [{
                "namespace": "compute",
                "key": "created",
                "value": "string"
            }],
            "filters": null
        }
    ]
}

"filter": {
    "operator": "AND",
    "dimensions": [{
                "key": "compartmentPath",
                "value": "abc/cde"
            }],
    "tags": [],
    "filters": [{
            "operator": "AND",
            "dimensions": [{
                "key": "service",
                "value": "compute"
            }],
            "tags": null,
            "filters": null
        },
        {
            "operator": "AND",
            "dimensions": null,
            "tags": [{
                "namespace": "compute",
                "key": "created",
                "value": "string"
            }],
            "filters": null
        }
    ]
}

前述のように、groupByのフィールドのみを表示します。そのため、groupByにタグ関連フィールドを追加する必要があります。例:

"tagNamespace", "tagKey", "tagValue"

tagKeyを追加すると、レスポンス内のすべてのアイテムにtagKeyが設定されます。tagKeyは、tagKeyを追加した場合でも空にできます。これは、一部のリソースにtagKeyがないためです。これらの3つをすべてgroupByに追加して、レスポンスに完全なタグが表示されるようにすることをお薦めします:

"tagNamespace", "tagKey", "tagValue" 

タグでフィルタする場合は、フィルタ・オブジェクトにタグを追加する必要があります。これは、tagKey/Namespace/valueの任意のtagKey/Namespace/valueの組合せでフィルタできます。

"tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit",
"compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd",
"resourceId", "tenantId", "tenantName"

"tenantId"および"tenantName"は現在サポートされていません。

コンパートメント関連のgroupByキー("compartmentName"、"compartmentPath"、"compartmentId")は、他のgroupByキーとは異なります。

結果を期待どおりに得るには、compartmentDepthを使用してリクエストする必要があります。compartmentDepthは1以上6以下です。

コンパートメントのgroupByでは、指定した深さのコンパートメントに、それより深い深さのすべてのコンパートメントの使用量またはコストが集計されます。例:

           Root             1

        B          C        2

    D    E                  3

 F                          4

深さが1の場合、すべての使用量またはコストはルート・コンパートメントにグループ化されます。

深さが2の場合、深さ2のすべてのコンパートメントに、そのすべての子とともに使用量またはコストが含まれることを意味します。レスポンスでは、ルートにはルートの使用量が含まれ、Bには(B、D、E、F)が集計され、CにはCが含まれます。

フィールドは、フィールドがgroupByにある場合にのみ表示されます。現在レスポンスですべてのフィールドが使用可能なわけではありません。有効なgroupByの例で説明されているフィールドのみがサポートされます。

これは、nullとして設定できます。現在サポートされていません。

APIの動作を理解する最善の方法は、コンソールがAPIをどのように使用しているかを確認することです。リクエスト本文は、Webブラウザのデバッグ・モードで確認できます。

{
  "tenantId": "ocid1.tenancy.oc1..<unique_ID>",
  "timeUsageStarted": "2020-04-01T00:00:00.000Z",
  "timeUsageEnded": "2020-07-01T00:00:00.000Z",
  "granularity": "MONTHLY",
  "queryType": "COST",
  "groupBy": [
    "tagNamespace",
    "tagKey",
    "tagValue",
    "service",
    "compartmentPath"
  ],
  "compartmentDepth": 2,
  "filter": null
}

フィルタを使用せずにリクエストを行うと、ディメンション/タグの値を確認できます。その後、フィルタと正しいディメンション値を使用してリクエストを作成できます。

{
  "tenantId": "ocid1.tenancy.oc1..<unique_ID>",
  "timeUsageStarted": "2020-04-01T00:00:00.000Z",
  "timeUsageEnded": "2020-07-01T00:00:00.000Z",
  "granularity": "MONTHLY",
  "groupBy": ["tagNamespace","tagKey","tagValue", "service", "compartmentPath"],
  "compartmentDepth": 2,
  "filter": {
    "operator": "AND",
    "dimensions": [],
    "tags": [],
    "filters": [{
      "operator": "AND",
      "dimensions": [{
        "key": "service",
        "value": "compute"
      }],
      "tags": null,
      "filters": null
    }, {
      "operator": "AND",
      "dimensions": [{
        "key": "compartmentPath",
        "value": "abc/cde"
      }],
      "tags": null,
      "filters": null
    },
      {
        "operator": "AND",
        "dimensions": null,
        "tags": [{
          "namespace": "compute",
          "key": "created",
          "value": "string"
        }],
        "filters": null
      }
    ]
  }
}

カスタマイズされたスクリプトを記述する場合、Oracleはスクリプトのデバッグをサポートまたは支援していません。CLI、SDKおよびTerraformのみがサポートされています。詳細は、コマンドライン・インタフェース(CLI)を参照してください。例:

oci raw-request --http-method POST --target-uri https://usageapi.us-ashburn-1.oci.oraclecloud.com/20200107/usage 
--request-body file:///<system_path>SimpleRequestSummarizedUsagesDetails.json 
--config-file ~/Downloads/clitest.conf

{
  "tenantId": "ocid1.tenancy.oc1..<unique_ID>",
  "timeUsageStarted": "2020-03-19T17:00:00.000000-07:00",
  "timeUsageEnded": "2020-03-21T00:00:00Z",
  "granularity": "DAILY",
  "groupBy": [],
  "compartmentDepth": null,
  "filter": null,
  "nextPageToken": "string"
}

[DEFAULT]
user=ocid1.user.oc1..<unique_ID>
fingerprint=<MAC_ID>
key_file=<system_path>/oci_api_key.pem
#tenancy=ocid1.tenancy.oc1..<unique_ID>
tenancy=ocid1.tenancy.oc1..<unique_ID>
region=us-ashburn-1