# Cloud Service Type

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

## CloudServiceType

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

| Method                | Request                                                         | Response                                                                                                           |
| --------------------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| [**create**](#create) | [CreateCloudServiceTypeRequest](#createcloudservicetyperequest) | [CloudServiceTypeInfo](#cloudservicetypeinfo)                                                                      |
| [**update**](#update) | [UpdateCloudServiceTypeRequest](#updatecloudservicetyperequest) | [CloudServiceTypeInfo](#cloudservicetypeinfo)                                                                      |
| [**delete**](#delete) | [CloudServiceTypeRequest](#cloudservicetyperequest)             | [google.protobuf.Empty](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/empty.proto)   |
| [**get**](#get)       | [GetCloudServiceTypeRequest](#getcloudservicetyperequest)       | [CloudServiceTypeInfo](#cloudservicetypeinfo)                                                                      |
| [**list**](#list)     | [CloudServiceTypeQuery](#cloudservicetypequery)                 | [CloudServiceTypesInfo](#cloudservicetypesinfo)                                                                    |
| [**stat**](#stat)     | [CloudServiceTypeStatQuery](#cloudservicetypestatquery)         | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |

### create

> **POST** /inventory/v1/cloud-service-types

| Type     | Message                                                         |
| -------- | --------------------------------------------------------------- |
| Request  | [CreateCloudServiceTypeRequest](#createcloudservicetyperequest) |
| Response | [CloudServiceTypeInfo](#cloudservicetypeinfo)                   |

### update

> **PUT** /inventory/v1/cloud-service-type/{cloud\_service\_type\_id}

| Type     | Message                                                         |
| -------- | --------------------------------------------------------------- |
| Request  | [UpdateCloudServiceTypeRequest](#updatecloudservicetyperequest) |
| Response | [CloudServiceTypeInfo](#cloudservicetypeinfo)                   |

### delete

> **DELETE** /inventory/v1/cloud-service-type/{cloud\_service\_type\_id}

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

### get

> **GET** /inventory/v1/cloud-service-type/{cloud\_service\_type\_id}

| Type     | Message                                                   |
| -------- | --------------------------------------------------------- |
| Request  | [GetCloudServiceTypeRequest](#getcloudservicetyperequest) |
| Response | [CloudServiceTypeInfo](#cloudservicetypeinfo)             |

### list

> **GET** /inventory/v1/cloud-service-types
>
> **POST** /inventory/v1/cloud-service-types/search

| Type     | Message                                         |
| -------- | ----------------------------------------------- |
| Request  | [CloudServiceTypeQuery](#cloudservicetypequery) |
| Response | [CloudServiceTypesInfo](#cloudservicetypesinfo) |

### stat

> **POST** /inventory/v1/cloud-service-types/stat

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

##

## Message

### CloudServiceTypeInfo

| Field                     | Type                                                                                                               | Description |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------ | ----------- |
| cloud\_service\_type\_id  | string                                                                                                             |             |
| name                      | string                                                                                                             |             |
| provider                  | string                                                                                                             |             |
| group                     | string                                                                                                             |             |
| cloud\_service\_type\_key | string                                                                                                             |             |
| service\_code             | string                                                                                                             |             |
| is\_primary               | bool                                                                                                               |             |
| is\_major                 | bool                                                                                                               |             |
| resource\_type            | string                                                                                                             |             |
| metadata                  | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |             |
| tags                      | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |             |
| labels                    | [google.protobuf.ListValue](https://developers.google.com/protocol-buffers/docs/reference/overview)                |             |
| domain\_id                | string                                                                                                             |             |
| created\_at               | string                                                                                                             |             |
| updated\_at               | string                                                                                                             |             |

### CloudServiceTypeQuery

| Field                     | Type                                                                                               | Required | Description |
| ------------------------- | -------------------------------------------------------------------------------------------------- | :------: | ----------- |
| query                     | [spaceone.api.core.v1.Query](https://spaceone-dev.gitbook.io/api-reference/common-v1/search-query) |     ✘    |             |
| cloud\_service\_type\_id  | string                                                                                             |     ✘    |             |
| name                      | string                                                                                             |     ✘    |             |
| provider                  | string                                                                                             |     ✘    |             |
| group                     | string                                                                                             |     ✘    |             |
| cloud\_service\_type\_key | string                                                                                             |     ✘    |             |
| service\_code             | string                                                                                             |     ✘    |             |
| is\_primary               | bool                                                                                               |     ✘    |             |
| is\_major                 | bool                                                                                               |     ✘    |             |
| resource\_type            | string                                                                                             |     ✘    |             |
| domain\_id                | string                                                                                             |     ✔    |             |

### CloudServiceTypeRequest

| Field                    | Type   | Required | Description |
| ------------------------ | ------ | :------: | ----------- |
| cloud\_service\_type\_id | string |     ✔    |             |
| domain\_id               | string |     ✔    |             |

### CloudServiceTypeStatQuery

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

### CloudServiceTypesInfo

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

### CreateCloudServiceTypeRequest

| Field          | Type                                                                                                               | Required | Description |
| -------------- | ------------------------------------------------------------------------------------------------------------------ | :------: | ----------- |
| name           | string                                                                                                             |     ✔    |             |
| provider       | string                                                                                                             |     ✔    |             |
| group          | string                                                                                                             |     ✔    |             |
| service\_code  | string                                                                                                             |     ✘    |             |
| is\_primary    | bool                                                                                                               |     ✘    |             |
| is\_major      | bool                                                                                                               |     ✘    |             |
| resource\_type | string                                                                                                             |     ✘    |             |
| metadata       | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |     ✘    |             |
| labels         | [google.protobuf.ListValue](https://developers.google.com/protocol-buffers/docs/reference/overview)                |     ✘    |             |
| tags           | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |     ✘    |             |
| domain\_id     | string                                                                                                             |     ✔    |             |

### GetCloudServiceTypeRequest

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

### UpdateCloudServiceTypeRequest

| Field                    | Type                                                                                                               | Required | Description |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------ | :------: | ----------- |
| cloud\_service\_type\_id | string                                                                                                             |     ✔    |             |
| service\_code            | string                                                                                                             |     ✘    |             |
| is\_primary              | bool                                                                                                               |     ✘    |             |
| is\_major                | bool                                                                                                               |     ✘    |             |
| resource\_type           | string                                                                                                             |     ✘    |             |
| metadata                 | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |     ✘    |             |
| labels                   | [google.protobuf.ListValue](https://developers.google.com/protocol-buffers/docs/reference/overview)                |     ✘    |             |
| tags                     | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |     ✘    |             |
| domain\_id               | string                                                                                                             |     ✔    |             |
