# Region

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

## Region

{% hint style="info" %}
**Region Methods:**
{% endhint %}

| Method                | Request                                     | Response                                                                                                           |
| --------------------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| [**create**](#create) | [CreateRegionRequest](#createregionrequest) | [RegionInfo](#regioninfo)                                                                                          |
| [**update**](#update) | [UpdateRegionRequest](#updateregionrequest) | [RegionInfo](#regioninfo)                                                                                          |
| [**delete**](#delete) | [RegionRequest](#regionrequest)             | [google.protobuf.Empty](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/empty.proto)   |
| [**get**](#get)       | [GetRegionRequest](#getregionrequest)       | [RegionInfo](#regioninfo)                                                                                          |
| [**list**](#list)     | [RegionQuery](#regionquery)                 | [RegionsInfo](#regionsinfo)                                                                                        |
| [**stat**](#stat)     | [RegionStatQuery](#regionstatquery)         | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |

### create

> **POST** /inventory/v1/regions

| Type     | Message                                     |
| -------- | ------------------------------------------- |
| Request  | [CreateRegionRequest](#createregionrequest) |
| Response | [RegionInfo](#regioninfo)                   |

### update

> **PUT** /inventory/v1/region/{region\_id}

| Type     | Message                                     |
| -------- | ------------------------------------------- |
| Request  | [UpdateRegionRequest](#updateregionrequest) |
| Response | [RegionInfo](#regioninfo)                   |

### delete

> **DELETE** /inventory/v1/region/{region\_id}

| Type     | Message                                                                                                          |
| -------- | ---------------------------------------------------------------------------------------------------------------- |
| Request  | [RegionRequest](#regionrequest)                                                                                  |
| Response | [google.protobuf.Empty](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/empty.proto) |

### get

> **GET** /inventory/v1/region/{region\_id}

| Type     | Message                               |
| -------- | ------------------------------------- |
| Request  | [GetRegionRequest](#getregionrequest) |
| Response | [RegionInfo](#regioninfo)             |

### list

> **GET** /inventory/v1/regions
>
> **POST** /inventory/v1/regions/search

| Type     | Message                     |
| -------- | --------------------------- |
| Request  | [RegionQuery](#regionquery) |
| Response | [RegionsInfo](#regionsinfo) |

### stat

> **POST** /inventory/v1/regions/stat

| Type     | Message                                                                                                            |
| -------- | ------------------------------------------------------------------------------------------------------------------ |
| Request  | [RegionStatQuery](#regionstatquery)                                                                                |
| Response | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |

##

## Message

### CreateRegionRequest

| Field        | Type                                                                                                               | Required | Description |
| ------------ | ------------------------------------------------------------------------------------------------------------------ | :------: | ----------- |
| name         | string                                                                                                             |     ✔    |             |
| region\_code | string                                                                                                             |     ✔    |             |
| provider     | string                                                                                                             |     ✘    |             |
| tags         | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |     ✘    |             |
| domain\_id   | string                                                                                                             |     ✔    |             |

### GetRegionRequest

| Field      | Type           | Required | Description |
| ---------- | -------------- | :------: | ----------- |
| region\_id | string         |     ✔    |             |
| domain\_id | string         |     ✔    |             |
| only       | list of string |     ✘    |             |

### RegionInfo

| Field        | Type                                                                                                               | Description |
| ------------ | ------------------------------------------------------------------------------------------------------------------ | ----------- |
| region\_id   | string                                                                                                             |             |
| name         | string                                                                                                             |             |
| region\_key  | string                                                                                                             |             |
| region\_code | string                                                                                                             |             |
| provider     | string                                                                                                             |             |
| tags         | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |             |
| domain\_id   | string                                                                                                             |             |
| created\_at  | string                                                                                                             |             |
| updated\_at  | string                                                                                                             |             |

### RegionQuery

| Field        | Type                                                                                               | Required | Description |
| ------------ | -------------------------------------------------------------------------------------------------- | :------: | ----------- |
| query        | [spaceone.api.core.v1.Query](https://spaceone-dev.gitbook.io/api-reference/common-v1/search-query) |     ✘    |             |
| region\_id   | string                                                                                             |     ✘    |             |
| name         | string                                                                                             |     ✘    |             |
| region\_key  | string                                                                                             |     ✘    |             |
| region\_code | string                                                                                             |     ✘    |             |
| provider     | string                                                                                             |     ✘    |             |
| domain\_id   | string                                                                                             |     ✔    |             |

### RegionRequest

| Field      | Type   | Required | Description |
| ---------- | ------ | :------: | ----------- |
| region\_id | string |     ✔    |             |
| domain\_id | string |     ✔    |             |

### RegionStatQuery

| Field      | Type                                                                                                             | Required | Description |
| ---------- | ---------------------------------------------------------------------------------------------------------------- | :------: | ----------- |
| query      | [spaceone.api.core.v1.StatisticsQuery](https://spaceone-dev.gitbook.io/api-reference/common-v1/statistics-query) |     ✔    |             |
| domain\_id | string                                                                                                           |     ✔    |             |

### RegionsInfo

| Field        | Type                                                                                            | Description |
| ------------ | ----------------------------------------------------------------------------------------------- | ----------- |
| results      | [list of RegionInfo](#regioninfo)                                                               |             |
| total\_count | [int32](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/type.proto) |             |

### UpdateRegionRequest

| Field      | Type                                                                                                               | Required | Description |
| ---------- | ------------------------------------------------------------------------------------------------------------------ | :------: | ----------- |
| region\_id | string                                                                                                             |     ✔    |             |
| name       | string                                                                                                             |     ✘    |             |
| tags       | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |     ✘    |             |
| domain\_id | string                                                                                                             |     ✔    |             |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://spaceone-dev.gitbook.io/spaceone-apis/inventory/v1/region.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.