Obtaining the Information from Region in Use (GET /v1/contracts/{domain_id}?action=getRegion)

To obtain the Region information being used by the Subscriber's organization for the specified domain.

{domain_id}:
Domain ID of the intended subscriber's organization.

Request Headers

Please refer to "Common API Items".

Request Parameter

None

Response Headers

Status

In the case of "normal", the status below will be returned.

200:
Successful completion

In case of abnormality, please refer to "Common API Error Information".

Data Type Cardinality
Int 1..1

Response Elements

Regions

Container of region information.

Data Type Cardinality Parent Element Child Element(s)
Element 1..1 None id

status

default

ID

Region ID

Data Type Cardinality Parent Element Child Element(s)
String 1..* regions None

Status

Status of Region

Data Type Cardinality Parent Element Child Element(s)
String 1..* regions None

default

In case of true, it will become the Contract Region.

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"
       }
       ]
       }