> For the complete documentation index, see [llms.txt](https://cloudforet.gitbook.io/cloudforet-apis/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cloudforet.gitbook.io/cloudforet-apis/content/en/inventory/v1/region.md).

# Region

A Region is a resource storing regional information from each cloud service provider. Regional data stored by the resource includes the latitude and longitude of the region.

> **Package : spaceone.api.inventory.v1**

\ <br>

## Region

**Region Methods:**

| Method                                                                                                             | Request                                                                                                                                  | Response                                                                                                                 |
| ------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| [**create**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Region/README.md#create) | [CreateRegionRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Region/README.md#createregionrequest) | [RegionInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Region/README.md#regioninfo)   |
| [**update**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Region/README.md#update) | [UpdateRegionRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Region/README.md#updateregionrequest) | [RegionInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Region/README.md#regioninfo)   |
| [**delete**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Region/README.md#delete) | [RegionRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Region/README.md#regionrequest)             | [Empty](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Region/README.md#empty)             |
| [**get**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Region/README.md#get)       | [RegionRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Region/README.md#regionrequest)             | [RegionInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Region/README.md#regioninfo)   |
| [**list**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Region/README.md#list)     | [RegionQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Region/README.md#regionquery)                 | [RegionsInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Region/README.md#regionsinfo) |
| [**stat**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Region/README.md#stat)     | [RegionStatQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Region/README.md#regionstatquery)         | [Struct](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Region/README.md#struct)           |

<br>

### create

Creates a new Region. As the parameter `region_key`, which is automatically created when a Region is created, is in a form of `{provider}.{region_code}`, it is unique regardless of providers. You can also specify the latitude, longitude, and continent information in `tags`.

> **POST** /inventory/v1/region/create

{{< tabs " create " >}}

{{< tab "Request Example" >}}

[CreateRegionRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Region/README.md#createregionrequest)

* **name** (string) `Required`
* **region\_code** (string) `Required`
* **provider** (string)
* **tags** (Struct)

{{< highlight json >}} { "name": "Asia Pacific (Seoul)", "region\_code": "ap-northeast-2", "provider": "aws", "tags": { "continent": "asis\_pacific", "longitude": "73.013805", "latitude": "19.147428" } } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[RegionInfo](#REGIONINFO)

* **region\_id** (string) `Required`
* **name** (string) `Required`
* **region\_key** (string) `Required`
* **region\_code** (string) `Required`
* **provider** (string) `Required`
* **tags** (Struct) `Required`
* **domain\_id** (string) `Required`
* **workspace\_id** (string) `Required`
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`

{{< highlight json >}} { "region\_id": "region-e41deed3c939", "name": "Asia Pacific (Seoul)", "region\_key": "aws.ap-northeast-2", "region\_code": "ap-northeast-2", "provider": "aws", "tags": { "continent": "asia\_pacific", "longitude": "73.013805", "latitude": "19.147428" }, "domain\_id": "domain-x1b3c34v432", "workspace\_id": "workspace-123456789012", "created\_at": "2021-11-18T13:07:31.382Z", "updated\_at": "2022-06-17T00:07:35.469Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### update

Updates a specific Region. You can make changes in Region settings, including `name` and `tags`. The `tags` contain the continent, latitude, and longitude.

> **POST** /inventory/v1/region/update

{{< tabs " update " >}}

{{< tab "Request Example" >}}

[UpdateRegionRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Region/README.md#updateregionrequest)

* **region\_id** (string) `Required`
* **name** (string)
* **tags** (Struct)

{{< highlight json >}} { "region\_id": "region-e41deed3c939", "name": "Region home", "tags": { "latitude": "6.34545", "continent": "asia\_pacific", "longitude": "5.6433213" } } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[RegionInfo](#REGIONINFO)

* **region\_id** (string) `Required`
* **name** (string) `Required`
* **region\_key** (string) `Required`
* **region\_code** (string) `Required`
* **provider** (string) `Required`
* **tags** (Struct) `Required`
* **domain\_id** (string) `Required`
* **workspace\_id** (string) `Required`
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`

{{< highlight json >}} { "region\_id": "region-e41deed3c939", "name": "Asia Pacific (Seoul)", "region\_key": "aws.ap-northeast-2", "region\_code": "ap-northeast-2", "provider": "aws", "tags": { "continent": "asia\_pacific", "longitude": "73.013805", "latitude": "19.147428" }, "domain\_id": "domain-x1b3c34v432", "workspace\_id": "workspace-123456789012", "created\_at": "2021-11-18T13:07:31.382Z", "updated\_at": "2022-06-17T00:07:35.469Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### delete

Deletes a specific Region. You must specify the `region_id` of the Region to delete.

> **POST** /inventory/v1/region/delete

{{< tabs " delete " >}}

{{< tab "Request Example" >}}

[RegionRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Region/README.md#regionrequest)

* **region\_id** (string) `Required`

{{< highlight json >}} { "region\_id": "region-e41deed3c939" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### get

Gets a specific Region. Prints detailed information about the Region, including `name`, `region_code`, and a location coordinate.

> **POST** /inventory/v1/region/get

{{< tabs " get " >}}

{{< tab "Request Example" >}}

[RegionRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Region/README.md#regionrequest)

* **region\_id** (string) `Required`

{{< highlight json >}} { "region\_id": "region-e41deed3c939" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[RegionInfo](#REGIONINFO)

* **region\_id** (string) `Required`
* **name** (string) `Required`
* **region\_key** (string) `Required`
* **region\_code** (string) `Required`
* **provider** (string) `Required`
* **tags** (Struct) `Required`
* **domain\_id** (string) `Required`
* **workspace\_id** (string) `Required`
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`

{{< highlight json >}} { "region\_id": "region-e41deed3c939", "name": "Asia Pacific (Seoul)", "region\_key": "aws.ap-northeast-2", "region\_code": "ap-northeast-2", "provider": "aws", "tags": { "continent": "asia\_pacific", "longitude": "73.013805", "latitude": "19.147428" }, "domain\_id": "domain-x1b3c34v432", "workspace\_id": "workspace-123456789012", "created\_at": "2021-11-18T13:07:31.382Z", "updated\_at": "2022-06-17T00:07:35.469Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### list

Gets a list of all Regions. You can use a query to get a filtered list of Regions.

> **POST** /inventory/v1/region/list

{{< tabs " list " >}}

{{< tab "Request Example" >}}

[RegionQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/Region/README.md#regionquery)

* **query** (Query)
* **region\_id** (string)
* **name** (string)
* **region\_key** (string)
* **region\_code** (string)
* **provider** (string)
* **workspace\_id** (string)

{{< highlight json >}} { "query": { "filter": \[ { "key": "name", "value": "Asia Pacific", "operator": "contain" } ] } } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[RegionsInfo](#REGIONSINFO)

* **results** (RegionInfo) `Repeated` `Required`
* **total\_count** (int32) `Required`

{{< highlight json >}} { "results": \[ { "region\_id": "region-e41deed3c939", "name": "Asia Pacific (Mumbai)", "region\_key": "aws.ap-south-1", "region\_code": "ap-south-1", "provider": "aws", "tags": { "continent": "asia\_pacific", "longitude": "73.013805", "latitude": "19.147428" }, "domain\_id": "domain-x1b3c34v432", "workspace\_id": "workspace-123456789012", "created\_at": "2021-11-18T13:07:31.382Z", "updated\_at": "2022-06-17T00:07:35.469Z" }, { "region\_id": "region-f803eb00b567", "name": "Asia Pacific (Seoul)", "region\_key": "aws.ap-northeast-2", "region\_code": "ap-northeast-2", "provider": "aws", "tags": { "latitude": "6.34545", "continent": "asia\_pacific", "longitude": "5.6433213" }, "domain\_id": "domain-x1b3c34v432", "workspace\_id": "workspace-123456789012", "created\_at": "2022-03-21T09:08:31.961Z", "updated\_at": "2022-06-17T00:07:35.749Z" } ], "total\_count": 2 } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### stat

> **POST** /inventory/v1/region/stat

\ <br>

## Message

### CreateRegionRequest

* **name** (string) `Required`
* **region\_code** (string) `Required`
* **provider** (string)
* **tags** (Struct)

  <br>

### RegionInfo

* **region\_id** (string) `Required`
* **name** (string) `Required`
* **region\_key** (string) `Required`
* **region\_code** (string) `Required`
* **provider** (string) `Required`
* **tags** (Struct) `Required`
* **domain\_id** (string) `Required`
* **workspace\_id** (string) `Required`
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`

  <br>

### RegionQuery

* **query** (Query)
* **region\_id** (string)
* **name** (string)
* **region\_key** (string)
* **region\_code** (string)
* **provider** (string)
* **workspace\_id** (string)

  <br>

### RegionRequest

* **region\_id** (string) `Required`

  <br>

### RegionStatQuery

* **query** (StatisticsQuery) `Required`

  <br>

### RegionsInfo

* **results** (RegionInfo) `Repeated` `Required`
* **total\_count** (int32) `Required`

  <br>

### UpdateRegionRequest

* **region\_id** (string) `Required`
* **name** (string)
* **tags** (Struct)

  <br>