Obtaining the Information from Region in Use#

指定されたドメインの契約組織が利用しているリージョン情報を取得します。

APIエンドポイント#

リージョン APIエンドポイント
西日本リージョン3の場合 https://contract.gls.cloud.global.fujitsu.com
東日本リージョン3の場合 https://contract.gls.cloud.global.fujitsu.com

HTTPメソッドとURI#

GET

/v1/contracts/{domain_id}?action=getRegion

HTTPステータスコード#

正常時:200

エラー時:400, 401, 403, 404, 500

リクエストパラメータの説明#

名前 In Type デフォルト値
/必須指定
Description
X-Auth-Token header string 必須 認証のトークン
Content-Type header string 必須 「application/json」を設定します。
domain_id path string 必須 対象となる契約組織のドメインID
action query string 必須 「getRegion」を設定します。

レスポンスボディ(正常系)の説明#

名前 Type Description
Regions object リージョン情報のコンテナ
Id string リージョンID
Status string リージョンの状態
default string trueの場合、契約リージョンです。

リクエスト例#

       GET /v1/contracts/fc8c41d7e36d49f7b66a3f9b1e25fc16?action=getRegion
       HTTP/1.1
       Content-Type: application/json
       X-Auth-Token: "JpZCI6ICJjM2VlNzA4YTZhZTI0ZGRmOTJjMDc4..."

レスポンス例#

       HTTP/1.1 200 OK
       Content-Length: 121
       Content-Type: application/json;charset=UTF-8
       {
        "regions": [
         {
          "id": "jp-east-1",
          "status": "active",
          "default": "true"
         },
         {
          "id": "uk-1",
          "status": "ready",
          "default": "false"
         }
        ]
       }