GET committed_group

API情報

管理権限HTTPメソッドAPI名目的
不要GETcommitted_group反映中グループの取得
  • レコードとして反映されているグループを取得します。
  • Active/Standby全ての監視が失敗している場合は、SorryServerが有効または無効でレスポンスが変わります。
    • SorryServer有効時は、"SORRY"がレスポンスとして返ります。
    • SorryServer無効時は、"EMPTY"がレスポンスとして返ります。

個別パラメータ

URL
フィールドタイプ必須意味
DoServiceCodeString

DNSアウトソースサービスのサービスコード

DowOptionCodeStringサイトフェイルオーバーオプションのサービスコード
ZoneNameString操作対象のゾーン名 (例: example.jp)
  • 操作対象のゾーン名は、GET zonesで取得した文字列を指定してください。
HTTPリクエストボディ
  • なし

レスポンス

フィールドタイプ意味
CommittedString

現在レコードとして反映されているグループ

(ACTIVE / STANDBY / SORRY / EMPTY)

エラーコード

エラーHTTP Status CodeErrorTypeErrorMessage説明備考
パラメーターエラー200ParameterErrorThere are invalid parameters.

以下のパラメータの形式が不正

  • DoServiceCode
  • DowOptionCode
  • ZoneName
 
リソースエラー200ResourceNotExistResource is not found.

以下のいずれかのリソースが存在しない

  • 契約情報
  • オプション情報
  • ゾーン
 
UnrelateErrorResource is unrelated to other resources.

以下それぞれのリソースの組み合わせが正しくない

  • 契約情報
  • オプション情報
  • ゾーン
 

制限

  • 契約外のゾーン情報は取得できません。

サンプル

リクエスト

GET /r/(APIVersion)/(DoServiceCode)/(DowOptionCode)/(ZoneName)/committed_group.json HTTP/1.1
Host: do.api.iij.jp
Date: Mon, 20 Jan 2014 12:34:56 GMT
x-iijapi-Expire: (Expire)
x-iijapi-SignatureMethod: (SignatureMethod)
x-iijapi-SignatureVersion: (SignatureVersion)
Authorization: IIJAPI (AccessKeyId):(Signature)

レスポンスボディ

JSON
{
    "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
    "Committed": "ACTIVE"
}