使用量の照会

Classic/VPC環境で利用できます。

Cloud Log Analyticsサービスで使用中の容量を照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/api/{regionCode}-v1/capacity

リクエストヘッダ

Cloud Log Analytics APIで共通して使用されるヘッダの詳細は、Cloud Log Analyticsのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Required	リージョンコード `kr` \| `sgn` \| `jpn` \| `uswn` \| `den` `kr`: 韓国リージョン `sgn`: シンガポールリージョン `jpn`: 日本リージョン `uswn`: 米国西部リージョン `den`: ドイツリージョン

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://cloudloganalytics.apigw.ntruss.com/api/{regionCode}-v1/capacity' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`code`	Integer	-	レスポンスステータスコード
`message`	String	-	レスポンスステータスメッセージ
`result`	Object	-	レスポンス結果
`result.prodNo`	Integer	-	商品番号
`result.prodNm`	String	-	料金プラン名
`result.prodSubNm`	String	-	サブ料金プラン名
`result.prodNmDefaultYn`	Boolean	-	基本料金プランかどうか `true` \| `false` `true`: 基本料金プラン `false`: 基本料金プランではない
`result.saveTerm`	String	-	データの保管期間
`result.dataSize`	String	-	提供容量
`result.dataLimit`	Integer	-	容量の上限
`result.dataLimitDaily`	Integer	-	1日当たりの使用可能な容量の上限
`result.alarmLimitCount`	Integer	-	アラーム発生条件
`result.prodYmdt`	String	-	商品利用の開始日
`result.usageSize`	String	-	使用中容量
`result.remainSize`	String	-	空き容量
`result.usagePercent`	Number	-	空き容量

レスポンスステータスコード

Cloud Log Analytics APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud Log Analyticsのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "code": 0,
    "message": "リクエストが正常に処理されました。",
    "result": {
        "prodNo": 1,
        "prodNm": "Standard",
        "prodSubNm": null,
        "prodNmDefaultYn": null,
        "saveTerm": "1m",
        "dataSize": "100.0G",
        "dataLimit": null,
        "dataLimitDaily": null,
        "alarmLimitCount": null,
        "prodYmdt": null,
        "usageSize": "52M",
        "remainSize": "102348.0M",
        "usagePercent": 0.05078125
    }
}