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

# CloudService

A CloudService is data of an `instance` of a `resource`. A CloudService follows the pre-created classification system of a CloudServiceType and indicates the property value of the `resource`.

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

\ <br>

## CloudService

**CloudService Methods:**

| Method                                                                                                                     | Request                                                                                                                                                    | Response                                                                                                                                   |
| -------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| [**create**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudService/README.md#create)   | [CreateServiceRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudService/README.md#createservicerequest)           | [CloudServiceInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudService/README.md#cloudserviceinfo)   |
| [**update**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudService/README.md#update)   | [UpdateCloudServiceRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudService/README.md#updatecloudservicerequest) | [CloudServiceInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudService/README.md#cloudserviceinfo)   |
| [**delete**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudService/README.md#delete)   | [CloudServiceRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudService/README.md#cloudservicerequest)             | [Empty](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudService/README.md#empty)                         |
| [**get**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudService/README.md#get)         | [CloudServiceRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudService/README.md#cloudservicerequest)             | [CloudServiceInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudService/README.md#cloudserviceinfo)   |
| [**list**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudService/README.md#list)       | [CloudServiceQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudService/README.md#cloudservicequery)                 | [CloudServicesInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudService/README.md#cloudservicesinfo) |
| [**export**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudService/README.md#export)   | [CloudServiceExportRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudService/README.md#cloudserviceexportrequest) | [Struct](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudService/README.md#struct)                       |
| [**analyze**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudService/README.md#analyze) | [CloudServiceAnalyzeQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudService/README.md#cloudserviceanalyzequery)   | [Struct](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudService/README.md#struct)                       |
| [**stat**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudService/README.md#stat)       | [CloudServiceStatQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudService/README.md#cloudservicestatquery)         | [Struct](https://github.com/cloudforet-io/api-doc/blob/master/content/en/inventory/v1/CloudService/README.md#struct)                       |

<br>

### create

Creates a new CloudService. A CloudService instance is created based on data including the `resource`'s attribute values. When creating, the classification information defined by CloudServiceType is also needed. The created CloudService has collection information which is the collection history for the `resource` by plugin.

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

{{< tabs " create " >}}

{{< tab "Request Example" >}}

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

* **cloud\_service\_type** (string) `Required`
* **provider** (string) `Required`
* **cloud\_service\_group** (string) `Required`
* **data** (Struct) `Required`
* **name** (string)
* **account** (string)
* **instance\_type** (string)
* **instance\_size** (float)
* **ip\_addresses** (string) `Repeated`
* **metadata** (Struct)
* **reference** (CloudServiceReference)
* **tags** (Struct)
* **region\_code** (string)
* **project\_id** (string)

{{< highlight json >}} { "cloud\_service\_type": "Key", "provider": "aws", "cloud\_service\_group": "KMS", "name": "cloud\_service\_test", "account": "251340636361", "launched\_at": "2020-08-03T15:00:54.000Z", "ip\_addresses": \[], "data": { "alias\_arn": null, "origin": "AWS\_KMS", "cloudwatch": { "region\_name": "ap-northeast-1", "namespace": "AWS/KMS", "dimensions": \[ { "Value": "0drda5e1-c40f-45d7-a647-xxxxxxx", "Name": "KeyId" } ] }, "aws\_account\_id": "251340636361", "creation\_date": "2020-07-09T09:39:03.097000+0000", "encryption\_algorithms": \[ "SYMMETRIC\_DEFAULT" ], "key\_usage": "ENCRYPT\_DECRYPT", "key\_id": "0drda5e1-c40f-45d7-a647-xxxxxxx", "key\_type\_path": "defaultKeys", "key\_rotated": false, "description": "Default master key that protects my Secrets Manager data when no other key is defined", "key\_state": "Enabled", "customer\_master\_key\_spec": "SYMMETRIC\_DEFAULT", "enabled": true, "arn": "arn:aws:kms:ap-northeast-1:251340636361:key/0drda5e1-c40f-45d7-a647-xxxxxxx", "key\_manager": "AWS" }, "metadata": {}, "reference": { "resource\_id": "arn:aws:kms:ap-northeast-1:251340636361:key/0drda5e1-c40f-45d7-a647-xxxxxxx", "external\_link": "<https://console.aws.amazon.com/kms/home?region=ap-northeast-1#/kms/defaultKeys/0drda5e1-c40f-45d7-a647-xxxxxxx/>" }, "tags": { "a": "b" }, "region\_code": "ap-northeast-1" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[CloudServiceInfo](#CLOUDSERVICEINFO)

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

  This id value is unique at each domain.
* **name** (string) `Required`

  Name of cloud resource from CSP like AWS, Azure, GCP
* **state** (string) `Required`

  State of cloud resource
* **ip\_addresses** (string) `Repeated` `Required`

  IP addresses of cloud resource having public IP
* **account** (string) `Required`

  Account ID of cloud resource
* **instance\_type** (string) `Required`

  Instance type of cloud resource
* **instance\_size** (float) `Required`

  Instance size of cloud resource
* **cloud\_service\_type** (string) `Required`

  Classification of cloud resource
* **cloud\_service\_group** (string) `Required`

  Group of cloud resource that is parent of cloud\_service\_type
* **provider** (string) `Required`

  Cloud Service provider like AWS, Azure, GCP
* **data** (Struct) `Required`

  Original data from CSP
* **metadata** (Struct) `Required`

  Metadata for Dynamic UI converting at SpaceONE
* **reference** (CloudServiceReference) `Required`
* **tags** (Struct) `Required`

  Tags from CSP
* **tag\_keys** (Struct) `Required`
* **collection\_info** (CollectionInfo) `Required`

  Collection information
* **region\_code** (string) `Required`
* **domain\_id** (string) `Required`

  Domain Id
* **workspace\_id** (string) `Required`

  Workspace Id
* **project\_id** (string) `Required`

  Project Id
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`
* **deleted\_at** (string) `Required`

{{< highlight json >}} { "cloud\_service\_id": "cloud-svc-c00f38a173e1", "name": "cloud\_service\_test", "state": "ACTIVE", "account": "251340636361", "cloud\_service\_type": "Key", "cloud\_service\_group": "KMS", "provider": "aws", "data": { "alias\_arn": null, "origin": "AWS\_KMS", "cloudwatch": { "region\_name": "ap-northeast-1", "namespace": "AWS/KMS", "dimensions": \[ { "Value": "0drda5e1-c40f-45d7-a647-xxxxxxx", "Name": "KeyId" } ] }, "aws\_account\_id": "251340636361", "creation\_date": "2020-07-09T09:39:03.097000+0000", "encryption\_algorithms": \[ "SYMMETRIC\_DEFAULT" ], "key\_usage": "ENCRYPT\_DECRYPT", "key\_id": "0drda5e1-c40f-45d7-a647-xxxxxxx", "key\_type\_path": "defaultKeys", "key\_rotated": false, "description": "Default master key that protects my Secrets Manager data when no other key is defined", "key\_state": "Enabled", "customer\_master\_key\_spec": "SYMMETRIC\_DEFAULT", "enabled": true, "arn": "arn:aws:kms:ap-northeast-1:251340636361:key/0drda5e1-c40f-45d7-a647-xxxxxxx", "key\_manager": "AWS" }, "metadata": { "manual": {} }, "reference": { "resource\_id": "arn:aws:kms:ap-northeast-1:251340636361:key/0drda5e1-c40f-45d7-a647-xxxxxxx", "external\_link": "<https://console.aws.amazon.com/kms/home?region=ap-northeast-1#/kms/defaultKeys/0drda5e1-c40f-45d7-a647-xxxxxxx/>" }, "tags": { "custom": { "b" : "c" }, "aws" : { "env": "dev" } }, "collection\_info": { "service\_account\_id": "sa-abcd1234", "secret\_id": "secret-abcd1234", "collector\_id": "collector-abcd1234", "last\_collected\_at": "2022-06-22T06:38:48.989Z" }, "ip\_addresses": \[], "region\_code": "ap-northeast-1", "workspace\_id": "workspace-58010aa2e451", "domain\_id": "domain-58010aa2e451", "created\_at": "2022-06-22T06:38:48.989Z", "updated\_at": "2022-06-22T06:38:48.989Z", "launched\_at": "2020-08-03T15:00:54.000Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### update

Updates a specific CloudService. You can make changes in CloudService settings, except for the classification system of CloudService and the information about the `resource` attribute value.

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

{{< tabs " update " >}}

{{< tab "Request Example" >}}

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

* **cloud\_service\_id** (string) `Required`
* **name** (string)
* **account** (string)
* **instance\_type** (string)
* **instance\_size** (float)
* **ip\_addresses** (string) `Repeated`
* **data** (Struct)
* **metadata** (Struct)
* **reference** (CloudServiceReference)
* **tags** (Struct)
* **region\_code** (string)
* **project\_id** (string)

{{< highlight json >}} { "cloud\_service\_id": "cloud-svc-c00f38a173e1", "name": "cloud\_service\_test2", "ip\_addresses": \[ "1.1.1.1", "2.2.2.2" ], "tags": { "description": "spaceone" }, "region\_code": "ap-northeast-2" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[CloudServiceInfo](#CLOUDSERVICEINFO)

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

  This id value is unique at each domain.
* **name** (string) `Required`

  Name of cloud resource from CSP like AWS, Azure, GCP
* **state** (string) `Required`

  State of cloud resource
* **ip\_addresses** (string) `Repeated` `Required`

  IP addresses of cloud resource having public IP
* **account** (string) `Required`

  Account ID of cloud resource
* **instance\_type** (string) `Required`

  Instance type of cloud resource
* **instance\_size** (float) `Required`

  Instance size of cloud resource
* **cloud\_service\_type** (string) `Required`

  Classification of cloud resource
* **cloud\_service\_group** (string) `Required`

  Group of cloud resource that is parent of cloud\_service\_type
* **provider** (string) `Required`

  Cloud Service provider like AWS, Azure, GCP
* **data** (Struct) `Required`

  Original data from CSP
* **metadata** (Struct) `Required`

  Metadata for Dynamic UI converting at SpaceONE
* **reference** (CloudServiceReference) `Required`
* **tags** (Struct) `Required`

  Tags from CSP
* **tag\_keys** (Struct) `Required`
* **collection\_info** (CollectionInfo) `Required`

  Collection information
* **region\_code** (string) `Required`
* **domain\_id** (string) `Required`

  Domain Id
* **workspace\_id** (string) `Required`

  Workspace Id
* **project\_id** (string) `Required`

  Project Id
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`
* **deleted\_at** (string) `Required`

{{< highlight json >}} { "cloud\_service\_id": "cloud-svc-c00f38a173e1", "name": "cloud\_service\_test", "state": "ACTIVE", "account": "251340636361", "cloud\_service\_type": "Key", "cloud\_service\_group": "KMS", "provider": "aws", "data": { "alias\_arn": null, "origin": "AWS\_KMS", "cloudwatch": { "region\_name": "ap-northeast-1", "namespace": "AWS/KMS", "dimensions": \[ { "Value": "0drda5e1-c40f-45d7-a647-xxxxxxx", "Name": "KeyId" } ] }, "aws\_account\_id": "251340636361", "creation\_date": "2020-07-09T09:39:03.097000+0000", "encryption\_algorithms": \[ "SYMMETRIC\_DEFAULT" ], "key\_usage": "ENCRYPT\_DECRYPT", "key\_id": "0drda5e1-c40f-45d7-a647-xxxxxxx", "key\_type\_path": "defaultKeys", "key\_rotated": false, "description": "Default master key that protects my Secrets Manager data when no other key is defined", "key\_state": "Enabled", "customer\_master\_key\_spec": "SYMMETRIC\_DEFAULT", "enabled": true, "arn": "arn:aws:kms:ap-northeast-1:251340636361:key/0drda5e1-c40f-45d7-a647-xxxxxxx", "key\_manager": "AWS" }, "metadata": { "manual": {} }, "reference": { "resource\_id": "arn:aws:kms:ap-northeast-1:251340636361:key/0drda5e1-c40f-45d7-a647-xxxxxxx", "external\_link": "<https://console.aws.amazon.com/kms/home?region=ap-northeast-1#/kms/defaultKeys/0drda5e1-c40f-45d7-a647-xxxxxxx/>" }, "tags": { "custom": { "b" : "c" }, "aws" : { "env": "dev" } }, "collection\_info": { "service\_account\_id": "sa-abcd1234", "secret\_id": "secret-abcd1234", "collector\_id": "collector-abcd1234", "last\_collected\_at": "2022-06-22T06:38:48.989Z" }, "ip\_addresses": \[], "region\_code": "ap-northeast-1", "workspace\_id": "workspace-58010aa2e451", "domain\_id": "domain-58010aa2e451", "created\_at": "2022-06-22T06:38:48.989Z", "updated\_at": "2022-06-22T06:38:48.989Z", "launched\_at": "2020-08-03T15:00:54.000Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### delete

Deletes a specific CloudService. You must specify the `cloud_service_id` of the CloudService to delete.

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

{{< tabs " delete " >}}

{{< tab "Request Example" >}}

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

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

{{< highlight json >}} { "cloud\_service\_id": "cloud-svc-fea2b0d32141" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### get

Gets a specific CloudService. Prints detailed information about the CloudService, including its state, classification information, and attribute values.

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

{{< tabs " get " >}}

{{< tab "Request Example" >}}

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

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

{{< highlight json >}} { "cloud\_service\_id": "cloud-svc-fea2b0d32141" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[CloudServiceInfo](#CLOUDSERVICEINFO)

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

  This id value is unique at each domain.
* **name** (string) `Required`

  Name of cloud resource from CSP like AWS, Azure, GCP
* **state** (string) `Required`

  State of cloud resource
* **ip\_addresses** (string) `Repeated` `Required`

  IP addresses of cloud resource having public IP
* **account** (string) `Required`

  Account ID of cloud resource
* **instance\_type** (string) `Required`

  Instance type of cloud resource
* **instance\_size** (float) `Required`

  Instance size of cloud resource
* **cloud\_service\_type** (string) `Required`

  Classification of cloud resource
* **cloud\_service\_group** (string) `Required`

  Group of cloud resource that is parent of cloud\_service\_type
* **provider** (string) `Required`

  Cloud Service provider like AWS, Azure, GCP
* **data** (Struct) `Required`

  Original data from CSP
* **metadata** (Struct) `Required`

  Metadata for Dynamic UI converting at SpaceONE
* **reference** (CloudServiceReference) `Required`
* **tags** (Struct) `Required`

  Tags from CSP
* **tag\_keys** (Struct) `Required`
* **collection\_info** (CollectionInfo) `Required`

  Collection information
* **region\_code** (string) `Required`
* **domain\_id** (string) `Required`

  Domain Id
* **workspace\_id** (string) `Required`

  Workspace Id
* **project\_id** (string) `Required`

  Project Id
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`
* **deleted\_at** (string) `Required`

{{< highlight json >}} { "cloud\_service\_id": "cloud-svc-c00f38a173e1", "name": "cloud\_service\_test", "state": "ACTIVE", "account": "251340636361", "cloud\_service\_type": "Key", "cloud\_service\_group": "KMS", "provider": "aws", "data": { "alias\_arn": null, "origin": "AWS\_KMS", "cloudwatch": { "region\_name": "ap-northeast-1", "namespace": "AWS/KMS", "dimensions": \[ { "Value": "0drda5e1-c40f-45d7-a647-xxxxxxx", "Name": "KeyId" } ] }, "aws\_account\_id": "251340636361", "creation\_date": "2020-07-09T09:39:03.097000+0000", "encryption\_algorithms": \[ "SYMMETRIC\_DEFAULT" ], "key\_usage": "ENCRYPT\_DECRYPT", "key\_id": "0drda5e1-c40f-45d7-a647-xxxxxxx", "key\_type\_path": "defaultKeys", "key\_rotated": false, "description": "Default master key that protects my Secrets Manager data when no other key is defined", "key\_state": "Enabled", "customer\_master\_key\_spec": "SYMMETRIC\_DEFAULT", "enabled": true, "arn": "arn:aws:kms:ap-northeast-1:251340636361:key/0drda5e1-c40f-45d7-a647-xxxxxxx", "key\_manager": "AWS" }, "metadata": { "manual": {} }, "reference": { "resource\_id": "arn:aws:kms:ap-northeast-1:251340636361:key/0drda5e1-c40f-45d7-a647-xxxxxxx", "external\_link": "<https://console.aws.amazon.com/kms/home?region=ap-northeast-1#/kms/defaultKeys/0drda5e1-c40f-45d7-a647-xxxxxxx/>" }, "tags": { "custom": { "b" : "c" }, "aws" : { "env": "dev" } }, "collection\_info": { "service\_account\_id": "sa-abcd1234", "secret\_id": "secret-abcd1234", "collector\_id": "collector-abcd1234", "last\_collected\_at": "2022-06-22T06:38:48.989Z" }, "ip\_addresses": \[], "region\_code": "ap-northeast-1", "workspace\_id": "workspace-58010aa2e451", "domain\_id": "domain-58010aa2e451", "created\_at": "2022-06-22T06:38:48.989Z", "updated\_at": "2022-06-22T06:38:48.989Z", "launched\_at": "2020-08-03T15:00:54.000Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### list

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

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

{{< tabs " list " >}}

{{< tab "Request Example" >}}

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

* **query** (Query)
* **cloud\_service\_id** (string)
* **name** (string)
* **state** (string)
* **ip\_address** (string)
* **account** (string)
* **instance\_type** (string)
* **cloud\_service\_type** (string)
* **cloud\_service\_group** (string)
* **provider** (string)
* **region\_code** (string)
* **workspace\_id** (string)
* **project\_id** (string)
* **project\_group\_id** (string)

{{< highlight json >}} { "query": { "filter": \[ { "key": "cloud\_service\_type", "value": "Key", "operator": "eq" } ] } } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

[CloudServicesInfo](#CLOUDSERVICESINFO)

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

{{< highlight json >}} { "results": \[{ "cloud\_service\_id": "cloud-svc-c00f38a173e1", "name": "cloud\_service\_test2", "state": "ACTIVE", "account": "251340636361", "cloud\_service\_type": "Key", "cloud\_service\_group": "KMS", "provider": "aws", "data": { "alias\_arn": null, "origin": "AWS\_KMS", "cloudwatch": { "region\_name": "ap-northeast-1", "namespace": "AWS/KMS", "dimensions": \[ { "Value": "0drda5e1-c40f-45d7-a647-xxxxxxx", "Name": "KeyId" } ] }, "aws\_account\_id": "251340636361", "creation\_date": "2020-07-09T09:39:03.097000+0000", "encryption\_algorithms": \[ "SYMMETRIC\_DEFAULT" ], "key\_usage": "ENCRYPT\_DECRYPT", "key\_id": "0drda5e1-c40f-45d7-a647-xxxxxxx", "key\_type\_path": "defaultKeys", "key\_rotated": false, "description": "Default master key that protects my Secrets Manager data when no other key is defined", "key\_state": "Enabled", "customer\_master\_key\_spec": "SYMMETRIC\_DEFAULT", "enabled": true, "arn": "arn:aws:kms:ap-northeast-1:251340636361:key/0drda5e1-c40f-45d7-a647-xxxxxxx", "key\_manager": "AWS" }, "metadata": { "manual": {} }, "reference": { "resource\_id": "arn:aws:kms:ap-northeast-1:251340636361:key/0drda5e1-c40f-45d7-a647-xxxxxxx", "external\_link": "<https://console.aws.amazon.com/kms/home?region=ap-northeast-1#/kms/defaultKeys/0drda5e1-c40f-45d7-a647-xxxxxxx/>" }, "tags": { "description": "spaceone" }, "collection\_info": { "service\_account\_id": "sa-abcd1234", "secret\_id": "secret-abcd1234", "collector\_id": "collector-abcd1234", "last\_collected\_at": "2022-06-22T06:38:48.989Z" }, "ip\_addresses": \[ "1.1.1.1", "2.2.2.2" ], "region\_code": "ap-northeast-1", "workspace\_id": "workspace-58010aa2e451", "domain\_id": "domain-58010aa2e451", "created\_at": "2022-06-22T06:38:48.989Z", "updated\_at": "2022-06-22T06:38:48.989Z", "launched\_at": "2020-08-03T15:00:54.000Z" }], "total\_count": 1 } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

<br>

### export

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

<br>

### analyze

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

<br>

### stat

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

\ <br>

## Message

### CloudServiceAnalyzeQuery

* **query** (AnalyzeQuery) `Required`

  <br>

### CloudServiceExportRequest

* **options** (ExportOption) `Repeated` `Required`
* **file\_format** (FileFormat)
* **file\_name** (string)
* **timezone** (string)

  <br>

### CloudServiceInfo

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

  *This id value is unique at each domain.*
* **name** (string) `Required`

  *Name of cloud resource from CSP like AWS, Azure, GCP*
* **state** (string) `Required`

  *State of cloud resource*
* **ip\_addresses** (string) `Repeated` `Required`

  *IP addresses of cloud resource having public IP*
* **account** (string) `Required`

  *Account ID of cloud resource*
* **instance\_type** (string) `Required`

  *Instance type of cloud resource*
* **instance\_size** (float) `Required`

  *Instance size of cloud resource*
* **cloud\_service\_type** (string) `Required`

  *Classification of cloud resource*
* **cloud\_service\_group** (string) `Required`

  *Group of cloud resource that is parent of cloud\_service\_type*
* **provider** (string) `Required`

  *Cloud Service provider like AWS, Azure, GCP*
* **data** (Struct) `Required`

  *Original data from CSP*
* **metadata** (Struct) `Required`

  *Metadata for Dynamic UI converting at SpaceONE*
* **reference** (CloudServiceReference) `Required`
* **tags** (Struct) `Required`

  *Tags from CSP*
* **tag\_keys** (Struct) `Required`
* **collection\_info** (CollectionInfo) `Required`

  *Collection information*
* **region\_code** (string) `Required`
* **domain\_id** (string) `Required`

  *Domain Id*
* **workspace\_id** (string) `Required`

  *Workspace Id*
* **project\_id** (string) `Required`

  *Project Id*
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`
* **deleted\_at** (string) `Required`

  <br>

### CloudServiceQuery

* **query** (Query)
* **cloud\_service\_id** (string)
* **name** (string)
* **state** (string)
* **ip\_address** (string)
* **account** (string)
* **instance\_type** (string)
* **cloud\_service\_type** (string)
* **cloud\_service\_group** (string)
* **provider** (string)
* **region\_code** (string)
* **workspace\_id** (string)
* **project\_id** (string)
* **project\_group\_id** (string)

  <br>

### CloudServiceReference

* **resource\_id** (string) `Required`
* **external\_link** (string) `Required`

  <br>

### CloudServiceRequest

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

  <br>

### CloudServiceStatQuery

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

  <br>

### CloudServicesInfo

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

  <br>

### CollectionInfo

* **service\_account\_id** (string) `Required`
* **secret\_id** (string) `Required`
* **collector\_id** (string) `Required`
* **last\_collected\_at** (string) `Required`

  <br>

### CreateServiceRequest

* **cloud\_service\_type** (string) `Required`
* **provider** (string) `Required`
* **cloud\_service\_group** (string) `Required`
* **data** (Struct) `Required`
* **name** (string)
* **account** (string)
* **instance\_type** (string)
* **instance\_size** (float)
* **ip\_addresses** (string) `Repeated`
* **metadata** (Struct)
* **reference** (CloudServiceReference)
* **tags** (Struct)
* **region\_code** (string)
* **project\_id** (string)

  <br>

### UpdateCloudServiceRequest

* **cloud\_service\_id** (string) `Required`
* **name** (string)
* **account** (string)
* **instance\_type** (string)
* **instance\_size** (float)
* **ip\_addresses** (string) `Repeated`
* **data** (Struct)
* **metadata** (Struct)
* **reference** (CloudServiceReference)
* **tags** (Struct)
* **region\_code** (string)
* **project\_id** (string)

  <br>