REST APIリファレンス

前へ次へ

カスタムIPUアラート設定の取得

GET要求を使用して、組織またはタグに設定したカスタムIPUアラートしきい値を取得します。

GET要求

組織のカスタムIPUアラート設定を取得するには、次のURlを使用します。

/public/core/v3/metering/ipuAlert/org('<organization Id>')

タグのカスタムIPUアラート設定を取得するには、次のURlを使用します。

/public/core/v3/metering/ipuAlert/org('<organization Id>')/viewTagsPreference

GET応答

応答には、組織の設定の次のフィールドが含まれます。

フィールド	タイプ	説明
orgName	文字列	組織の名前。
orgId	文字列	組織のID。
parentOrgId	文字列	親組織のID。このフィールドは、サブ組織にのみ適用されます。それ以外の場合はNULLになります。
thresholdValue	整数	しきい値が設定されています。
ipuConsumed	BigDecimal	使用されたIPUの数を指定します。このフィールドの値はipuThresholdPrefTypeフィールドに関連するもので、絶対値またはパーセンテージが表示されます。
ipuThresholdPrefType	文字列	しきい値のタイプ。次のいずれかの値を返します。 ABSOLUTE。 PERCENTAGE。

応答には、タグの設定の次のフィールドが含まれます。

フィールド	タイプ	説明
orgId	文字列	組織のID。
projectName	文字列	プロジェクトの名前。
folderName	文字列	フォルダの名前。プロジェクトベースのしきい値の場合、フォルダ名はNULLになります。
thresholdValue	整数	しきい値の値。
currentConsumption	BigDecimal	使用されたIPUの数を指定します。このフィールドの値はipuThresholdPrefTypeフィールドに関連するもので、絶対値またはパーセンテージが表示されます。
ipuThresholdPrefType	文字列	しきい値のタイプ。次のいずれかの値を返します。 ABSOLUTE。 PERCENTAGE。

GET要求の例

組織のカスタムIPUアラート設定を取得するには、次の要求を使用します。

GET <BaseApiUrl>/public/core/v3/metering/ipuAlert/org('3nqii4jGTiLda0M3ympy4E')
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <SessionId>

タグのカスタムIPUアラート設定を取得するには、次の要求を使用します。

GET <BaseApiUrl>/public/core/v3/metering/ipuAlert/org('3nqii4jGTiLda0M3ympy4E')/viewTagsPreference
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <SessionId>

GET応答の例

成功した場合、組織の設定に関して次のような応答を受け取ることがあります。

 {
    "orgName": "Infa",
    "orgId": "3nqii4jGTiLda0M3ympy4E",
    "parentOrgId": null,
    "thresholdValue": 35,
    "ipuConsumed": 100,
    "ipuThresholdPrefType": "ABSOLUTE"
  }

タグの設定に対する正常な応答は、次のようになります。

 {
    "orgId": "3nqii4jGTiLda0M3ympy4E",
    "projectName": "My Project",
    "folderName": "Mapping Jobs",
    "thresholdValue": 20,
    "currentConsumption": 10,
    "ipuThresholdPrefType": "PERCENTAGE"
  }

メータリングデータ

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal