利用リージョン情報取得 (GET /v1/contracts/{domain_id}?action=getRegion)
指定されたドメインの契約組織が利用しているリージョン情報を取得する。
- {domain_id}:
- 対象となる契約組織のドメインID。
Request Headers
「API共通項目」を参照してください。
Request Parameter
なし
Response Headers
ステータス
正常の場合は以下のステータスを返却します。
- 200:
- 正常終了
異常の場合は、「API共通エラー情報」を参照してください。
Data Type | Cardinality |
---|---|
Int | 1..1 |
Response Elements
Regions
リージョン情報のコンテナ
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
Element | 1..1 | None | id status default |
ID
リージョンID
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..* | regions | None |
Status
リージョンの状態
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..* | regions | None |
default
trueの場合、契約リージョンとなる。
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
String | 1..* | regions | None |
Example of Request
GET /v1/contracts/fc8c41d7e36d49f7b66a3f9b1e25fc16?action=getRegion
HTTP/1.1
Content-Type: application/json
X-Auth-Token: "JpZCI6ICJjM2VlNzA4YTZhZTI0ZGRmOTJjMDc4..."
Example of Response
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"
}
]
}