> 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/cloudservicetype.md).

# CloudServiceType

A CloudServiceType is a classification with hierarchical information of `CloudService`. A CloudServiceType provides information about which `group` a specific `Resource` belongs to and which `Services` are in it.

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

\ <br>

## CloudServiceType

**CloudServiceType Methods:**

| Method                                                                                                                       | Request                                                                                                                                                                | Response                                                                                                                                               |
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [**create**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudServiceType/README.md#create) | [CreateCloudServiceTypeRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudServiceType/README.md#createcloudservicetyperequest) | [CloudServiceTypeInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudServiceType/README.md#cloudservicetypeinfo)   |
| [**update**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudServiceType/README.md#update) | [UpdateCloudServiceTypeRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudServiceType/README.md#updatecloudservicetyperequest) | [CloudServiceTypeInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudServiceType/README.md#cloudservicetypeinfo)   |
| [**delete**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudServiceType/README.md#delete) | [CloudServiceTypeRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudServiceType/README.md#cloudservicetyperequest)             | [Empty](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudServiceType/README.md#empty)                                 |
| [**get**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudServiceType/README.md#get)       | [CloudServiceTypeRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudServiceType/README.md#cloudservicetyperequest)             | [CloudServiceTypeInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudServiceType/README.md#cloudservicetypeinfo)   |
| [**list**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudServiceType/README.md#list)     | [CloudServiceTypeQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudServiceType/README.md#cloudservicetypequery)                 | [CloudServiceTypesInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudServiceType/README.md#cloudservicetypesinfo) |
| [**stat**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudServiceType/README.md#stat)     | [CloudServiceTypeStatQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudServiceType/README.md#cloudservicetypestatquery)         | [Struct](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudServiceType/README.md#struct)                               |

<br>

### create

Creates a new CloudServiceType. You must specify the `name`, `provider`, and `group` parameters to create a CloudServiceType. One or several CloudServiceTypes exist in a specific `group`, and each CloudServiceType is identified by the `name` parameter.

> **POST** /inventory/v1/cloud-service-type/create

{{< tabs " create " >}}

{{< tab "Request Example" >}}

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

* **name** (string) `Required`
* **provider** (string) `Required`
* **group** (string) `Required`
* **service\_code** (string)
* **is\_primary** (bool)
* **is\_major** (bool)
* **resource\_type** (string)
* **metadata** (Struct)
* **labels** (ListValue)
* **tags** (Struct)

{{< highlight json >}} { "name": "API-TEST", "provider": "aws", "group": "APIGateway", "service\_code": "AmazonApiGateway", "is\_primary": true, "is\_major": true, "resource\_type": "inventory.CloudService", "metadata": {}, "labels": \[ "Networking" ], "tags": { "a": "b" } } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[CloudServiceTypeInfo](#CLOUDSERVICETYPEINFO)

* **cloud\_service\_type\_id** (string) `Required`
* **name** (string) `Required`
* **provider** (string) `Required`
* **group** (string) `Required`
* **cloud\_service\_type\_key** (string) `Required`
* **service\_code** (string) `Required`
* **is\_primary** (bool) `Required`
* **is\_major** (bool) `Required`
* **resource\_type** (string) `Required`
* **metadata** (Struct) `Required`
* **tags** (Struct) `Required`
* **labels** (ListValue) `Required`
* **domain\_id** (string) `Required`
* **workspace\_id** (string) `Required`
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`

{{< highlight json >}} { "cloud\_service\_type\_id": "cloud-svc-type-27dd73ac89f8", "name": "API-TEST", "provider": "aws", "group": "APIGateway", "cloud\_service\_type\_key": "aws.APIGateway.API-TEST", "service\_code": "AmazonApiGateway", "is\_primary": true, "is\_major": true, "resource\_type": "inventory.CloudService", "metadata": {}, "tags": { "a": "b" }, "labels": \[ "Networking" ], "domain\_id": "domain-58010aa2e451", "workspace\_id": "workspace-abcde12345", "created\_at": "2022-06-22T01:38:16.301Z", "updated\_at": "2022-06-22T01:38:16.301Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### update

Updates a specific CloudServiceType. You can make changes in CloudServiceType settings, except for `name`, `provider` and `group`. In particular, you can set the CloudServiceType's priority in a `group`.

> **POST** /inventory/v1/cloud-service-type/update

{{< tabs " update " >}}

{{< tab "Request Example" >}}

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

* **cloud\_service\_type\_id** (string) `Required`
* **service\_code** (string)
* **is\_primary** (bool)
* **is\_major** (bool)
* **resource\_type** (string)
* **metadata** (Struct)
* **labels** (ListValue)
* **tags** (Struct)

{{< highlight json >}} { "cloud\_service\_type\_id": "cloud-svc-type-27dd73ac89f8", "service\_code": "AmazonApi", "metadata": {}, "labels": \[ "Networking2" ], "tags": { "b": "c" } } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[CloudServiceTypeInfo](#CLOUDSERVICETYPEINFO)

* **cloud\_service\_type\_id** (string) `Required`
* **name** (string) `Required`
* **provider** (string) `Required`
* **group** (string) `Required`
* **cloud\_service\_type\_key** (string) `Required`
* **service\_code** (string) `Required`
* **is\_primary** (bool) `Required`
* **is\_major** (bool) `Required`
* **resource\_type** (string) `Required`
* **metadata** (Struct) `Required`
* **tags** (Struct) `Required`
* **labels** (ListValue) `Required`
* **domain\_id** (string) `Required`
* **workspace\_id** (string) `Required`
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`

{{< highlight json >}} { "cloud\_service\_type\_id": "cloud-svc-type-27dd73ac89f8", "name": "API-TEST", "provider": "aws", "group": "APIGateway", "cloud\_service\_type\_key": "aws.APIGateway.API-TEST", "service\_code": "AmazonApiGateway", "is\_primary": true, "is\_major": true, "resource\_type": "inventory.CloudService", "metadata": {}, "tags": { "a": "b" }, "labels": \[ "Networking" ], "domain\_id": "domain-58010aa2e451", "workspace\_id": "workspace-abcde12345", "created\_at": "2022-06-22T01:38:16.301Z", "updated\_at": "2022-06-22T01:38:16.301Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### delete

Deletes a specific CloudServiceType. You must specify the `cloud_service_type_id` of the CloudServiceType to delete.

> **POST** /inventory/v1/cloud-service-type/delete

{{< tabs " delete " >}}

{{< tab "Request Example" >}}

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

* **cloud\_service\_type\_id** (string) `Required`

{{< highlight json >}} { "cloud\_service\_type\_id": "cloud-svc-type-27dd73ac89f8" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### get

Gets a specific CloudServiceType. Prints detailed information about the CloudServiceType.

> **POST** /inventory/v1/cloud-service-type/get

{{< tabs " get " >}}

{{< tab "Request Example" >}}

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

* **cloud\_service\_type\_id** (string) `Required`

{{< highlight json >}} { "cloud\_service\_type\_id": "cloud-svc-type-27dd73ac89f8" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[CloudServiceTypeInfo](#CLOUDSERVICETYPEINFO)

* **cloud\_service\_type\_id** (string) `Required`
* **name** (string) `Required`
* **provider** (string) `Required`
* **group** (string) `Required`
* **cloud\_service\_type\_key** (string) `Required`
* **service\_code** (string) `Required`
* **is\_primary** (bool) `Required`
* **is\_major** (bool) `Required`
* **resource\_type** (string) `Required`
* **metadata** (Struct) `Required`
* **tags** (Struct) `Required`
* **labels** (ListValue) `Required`
* **domain\_id** (string) `Required`
* **workspace\_id** (string) `Required`
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`

{{< highlight json >}} { "cloud\_service\_type\_id": "cloud-svc-type-27dd73ac89f8", "name": "API-TEST", "provider": "aws", "group": "APIGateway", "cloud\_service\_type\_key": "aws.APIGateway.API-TEST", "service\_code": "AmazonApiGateway", "is\_primary": true, "is\_major": true, "resource\_type": "inventory.CloudService", "metadata": {}, "tags": { "a": "b" }, "labels": \[ "Networking" ], "domain\_id": "domain-58010aa2e451", "workspace\_id": "workspace-abcde12345", "created\_at": "2022-06-22T01:38:16.301Z", "updated\_at": "2022-06-22T01:38:16.301Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### list

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

> **POST** /inventory/v1/cloud-service-type/list

{{< tabs " list " >}}

{{< tab "Request Example" >}}

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

* **query** (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)
* **workspace\_id** (string)

{{< highlight json >}} { "query": { "filter": \[ { "key": "provider", "value": "aws", "operator": "eq" } ] } } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[CloudServiceTypesInfo](#CLOUDSERVICETYPESINFO)

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

{{< highlight json >}} { "results": \[ { "cloud\_service\_type\_id": "cloud-svc-type-7e1c113b39ff", "name": "API", "provider": "aws", "group": "APIGateway", "cloud\_service\_type\_key": "aws.APIGateway.API", "service\_code": "AmazonApiGateway", "is\_primary": true, "is\_major": true, "resource\_type": "inventory.CloudService", "metadata": { }, "tags": { "spaceone:icon": "<https://spaceone.s3.ap-northeast-2.amazonaws.com/console-assets/icons/cloud-services/aws/Amazon-API-Gateway.svg>" }, "labels": \[ "Networking" ], "domain\_id": "domain-58010aa2e451", "workspace\_id": "workspace-abcde12345", "created\_at": "2021-06-03T02:29:32.690Z", "updated\_at": "2022-06-22T00:04:45.477Z" }, { "cloud\_service\_type\_id": "cloud-svc-type-64a0de601371", "name": "Certificate", "provider": "aws", "group": "CertificateManager", "cloud\_service\_type\_key": "aws.CertificateManager.Certificate", "service\_code": "AWSCertificateManager", "is\_primary": true, "resource\_type": "inventory.CloudService", "metadata": { }, "tags": { "spaceone:icon": "<https://spaceone.s3.ap-northeast-2.amazonaws.com/console-assets/icons/cloud-services/aws/AWS-Certificate-Manager.svg>" }, "labels": \[ "Security" ], "domain\_id": "domain-58010aa2e451", "workspace\_id": "workspace-abcde12345", "created\_at": "2021-06-03T02:29:53.052Z", "updated\_at": "2022-06-22T00:05:41.252Z" } ], "total\_count": 2 } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### stat

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

\ <br>

## Message

### CloudServiceTypeInfo

* **cloud\_service\_type\_id** (string) `Required`
* **name** (string) `Required`
* **provider** (string) `Required`
* **group** (string) `Required`
* **cloud\_service\_type\_key** (string) `Required`
* **service\_code** (string) `Required`
* **is\_primary** (bool) `Required`
* **is\_major** (bool) `Required`
* **resource\_type** (string) `Required`
* **metadata** (Struct) `Required`
* **tags** (Struct) `Required`
* **labels** (ListValue) `Required`
* **domain\_id** (string) `Required`
* **workspace\_id** (string) `Required`
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`

  <br>

### CloudServiceTypeQuery

* **query** (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)
* **workspace\_id** (string)

  <br>

### CloudServiceTypeRequest

* **cloud\_service\_type\_id** (string) `Required`

  <br>

### CloudServiceTypeStatQuery

* **query** (StatisticsQuery) `Required`
* **domain\_id** (string) `Required`

  <br>

### CloudServiceTypesInfo

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

  <br>

### CreateCloudServiceTypeRequest

* **name** (string) `Required`
* **provider** (string) `Required`
* **group** (string) `Required`
* **service\_code** (string)
* **is\_primary** (bool)
* **is\_major** (bool)
* **resource\_type** (string)
* **metadata** (Struct)
* **labels** (ListValue)
* **tags** (Struct)

  <br>

### UpdateCloudServiceTypeRequest

* **cloud\_service\_type\_id** (string) `Required`
* **service\_code** (string)
* **is\_primary** (bool)
* **is\_major** (bool)
* **resource\_type** (string)
* **metadata** (Struct)
* **labels** (ListValue)
* **tags** (Struct)

  <br>