CloudServiceQuerySet

A CloudServiceQuerySet is query set for storing statistics data of CloudService.

Package : spaceone.api.inventory.v1

CloudServiceQuerySet

CloudServiceQuerySet Methods:

create

Create a new query set. Periodic statistics data is created based on the query set. query parameters refer to AnalyzeQuery.

POST /inventory/v1/cloud-service-query-set/create

{{< tabs " create " >}}

{{< tab "Request Example" >}}

CreateCloudServiceQuerySetRequest

  • name (string) Required

  • query_options (AnalyzeQuery) Required

  • provider (string) Required

  • cloud_service_group (string) Required

  • cloud_service_type (string) Required

  • resource_group (ResourceGroup) Required

  • unit (Struct)

  • tags (Struct)

  • workspace_id (string)

{{< highlight json >}} { "name": "EC2 Count by Instance Type", "query_options": "", "unit": { "Disk Size": "GB", "Memory": "GB", "CPU": "Core" }, "provider": "aws", "cloud_service_group": "EC2", "cloud_service_type": "Instance", "tags": { "foo": "bar" } } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

CloudServiceQuerySetInfo

  • query_set_id (string) Required

  • name (string) Required

  • state (State) Required

  • query_options (AnalyzeQuery) Required

  • query_type (QueryType) Required

  • unit (Struct) Required

  • data_keys (string) Repeated Required

  • additional_info_keys (string) Repeated Required

  • provider (string) Required

  • cloud_service_group (string) Required

  • cloud_service_type (string) Required

  • tags (Struct) Required

  • resource_group (ResourceGroup) Required

  • domain_id (string) Required

  • workspace_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required

{{< highlight json >}} { "query_set_id": "query-set-abcd1234", "name": "EC2 Count by Instance Type", "state": "ENABLED", "query_options": "", "query_type": "MANAGED", "unit": { "Disk Size": "GB", "Memory": "GB", "CPU": "Core" }, "data_keys": [ "Disk Size", "Memory", "CPU ], "additional_info_keys": [ "instance_type" ], "provider": "aws", "cloud_service_group": "EC2", "cloud_service_type": "Instance", "tags": { "foo": "bar" }, "domain_id": "domain-58010aa2e451", "created_at": "2022-06-22T01:38:16.301Z" "updated_at": "2023-03-16T06:00:00.000Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

update

Update a specific query set. You can only update the query set of custom type.

POST /inventory/v1/cloud-service-query-set/update

{{< tabs " update " >}}

{{< tab "Request Example" >}}

UpdateCloudServiceQuerySetRequest

  • query_set_id (string) Required

  • name (string)

  • query_options (AnalyzeQuery)

  • unit (Struct)

  • tags (Struct)

{{< highlight json >}} { "query_set_id": "query-set-abcd1234", "name": "Changed Name", "query_options": "", "unit": { "Disk Size": "GB", "Memory": "GB", "CPU": "Core" }, "tags": { "changed_key": "changed_value" } } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

CloudServiceQuerySetInfo

  • query_set_id (string) Required

  • name (string) Required

  • state (State) Required

  • query_options (AnalyzeQuery) Required

  • query_type (QueryType) Required

  • unit (Struct) Required

  • data_keys (string) Repeated Required

  • additional_info_keys (string) Repeated Required

  • provider (string) Required

  • cloud_service_group (string) Required

  • cloud_service_type (string) Required

  • tags (Struct) Required

  • resource_group (ResourceGroup) Required

  • domain_id (string) Required

  • workspace_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required

{{< highlight json >}} { "query_set_id": "query-set-abcd1234", "name": "EC2 Count by Instance Type", "state": "ENABLED", "query_options": "", "query_type": "MANAGED", "unit": { "Disk Size": "GB", "Memory": "GB", "CPU": "Core" }, "data_keys": [ "Disk Size", "Memory", "CPU ], "additional_info_keys": [ "instance_type" ], "provider": "aws", "cloud_service_group": "EC2", "cloud_service_type": "Instance", "tags": { "foo": "bar" }, "domain_id": "domain-58010aa2e451", "created_at": "2022-06-22T01:38:16.301Z" "updated_at": "2023-03-16T06:00:00.000Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

delete

Delete a specific query set.

POST /inventory/v1/cloud-service-query-set/delete

{{< tabs " delete " >}}

{{< tab "Request Example" >}}

CloudServiceQuerySetRequest

  • query_set_id (string) Required

{{< highlight json >}} { "query_set_id": "query-set-abcd1234" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

run

Run a specific query set and store the result in the statistics data.

POST /inventory/v1/cloud-service-query-set/run

{{< tabs " run " >}}

{{< tab "Request Example" >}}

CloudServiceQuerySetRequest

  • query_set_id (string) Required

{{< highlight json >}} { "query_set_id": "query-set-abcd1234" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

test

Run a specific query set and store the result in the statistics data.

POST /inventory/v1/cloud-service-query-set/test

{{< tabs " test " >}}

{{< tab "Request Example" >}}

CloudServiceQuerySetRequest

  • query_set_id (string) Required

{{< highlight json >}} { "query_set_id": "query-set-abcd1234" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

enable

Enable a specific query set.

POST /inventory/v1/cloud-service-query-set/enable

{{< tabs " enable " >}}

{{< tab "Request Example" >}}

CloudServiceQuerySetRequest

  • query_set_id (string) Required

{{< highlight json >}} { "query_set_id": "query-set-abcd1234" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

CloudServiceQuerySetInfo

  • query_set_id (string) Required

  • name (string) Required

  • state (State) Required

  • query_options (AnalyzeQuery) Required

  • query_type (QueryType) Required

  • unit (Struct) Required

  • data_keys (string) Repeated Required

  • additional_info_keys (string) Repeated Required

  • provider (string) Required

  • cloud_service_group (string) Required

  • cloud_service_type (string) Required

  • tags (Struct) Required

  • resource_group (ResourceGroup) Required

  • domain_id (string) Required

  • workspace_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required

{{< highlight json >}} { "query_set_id": "query-set-abcd1234", "name": "EC2 Count by Instance Type", "state": "ENABLED", "query_options": "", "query_type": "MANAGED", "unit": { "Disk Size": "GB", "Memory": "GB", "CPU": "Core" }, "data_keys": [ "Disk Size", "Memory", "CPU ], "additional_info_keys": [ "instance_type" ], "provider": "aws", "cloud_service_group": "EC2", "cloud_service_type": "Instance", "tags": { "foo": "bar" }, "domain_id": "domain-58010aa2e451", "created_at": "2022-06-22T01:38:16.301Z" "updated_at": "2023-03-16T06:00:00.000Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

disable

Disable a specific query set. query set is not executed when disabled.

POST /inventory/v1/cloud-service-query-set/disable

{{< tabs " disable " >}}

{{< tab "Request Example" >}}

CloudServiceQuerySetRequest

  • query_set_id (string) Required

{{< highlight json >}} { "query_set_id": "query-set-abcd1234" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

CloudServiceQuerySetInfo

  • query_set_id (string) Required

  • name (string) Required

  • state (State) Required

  • query_options (AnalyzeQuery) Required

  • query_type (QueryType) Required

  • unit (Struct) Required

  • data_keys (string) Repeated Required

  • additional_info_keys (string) Repeated Required

  • provider (string) Required

  • cloud_service_group (string) Required

  • cloud_service_type (string) Required

  • tags (Struct) Required

  • resource_group (ResourceGroup) Required

  • domain_id (string) Required

  • workspace_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required

{{< highlight json >}} { "query_set_id": "query-set-abcd1234", "name": "EC2 Count by Instance Type", "state": "ENABLED", "query_options": "", "query_type": "MANAGED", "unit": { "Disk Size": "GB", "Memory": "GB", "CPU": "Core" }, "data_keys": [ "Disk Size", "Memory", "CPU ], "additional_info_keys": [ "instance_type" ], "provider": "aws", "cloud_service_group": "EC2", "cloud_service_type": "Instance", "tags": { "foo": "bar" }, "domain_id": "domain-58010aa2e451", "created_at": "2022-06-22T01:38:16.301Z" "updated_at": "2023-03-16T06:00:00.000Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

get

Get a specific query set.

POST /inventory/v1/cloud-service-query-set/get

{{< tabs " get " >}}

{{< tab "Request Example" >}}

CloudServiceQuerySetRequest

  • query_set_id (string) Required

{{< highlight json >}} { "query_set_id": "query-set-abcd1234" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

CloudServiceQuerySetInfo

  • query_set_id (string) Required

  • name (string) Required

  • state (State) Required

  • query_options (AnalyzeQuery) Required

  • query_type (QueryType) Required

  • unit (Struct) Required

  • data_keys (string) Repeated Required

  • additional_info_keys (string) Repeated Required

  • provider (string) Required

  • cloud_service_group (string) Required

  • cloud_service_type (string) Required

  • tags (Struct) Required

  • resource_group (ResourceGroup) Required

  • domain_id (string) Required

  • workspace_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required

{{< highlight json >}} { "query_set_id": "query-set-abcd1234", "name": "EC2 Count by Instance Type", "state": "ENABLED", "query_options": "", "query_type": "MANAGED", "unit": { "Disk Size": "GB", "Memory": "GB", "CPU": "Core" }, "data_keys": [ "Disk Size", "Memory", "CPU ], "additional_info_keys": [ "instance_type" ], "provider": "aws", "cloud_service_group": "EC2", "cloud_service_type": "Instance", "tags": { "foo": "bar" }, "domain_id": "domain-58010aa2e451", "created_at": "2022-06-22T01:38:16.301Z" "updated_at": "2023-03-16T06:00:00.000Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

list

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

POST /inventory/v1/cloud-service-query-set/list

{{< tabs " list " >}}

{{< tab "Request Example" >}}

CloudServiceQuerySetQuery

  • query (Query)

  • query_set_id (string)

  • name (string)

  • state (State)

  • query_type (QueryType)

  • provider (string)

  • cloud_service_group (string)

  • cloud_service_type (string)

  • workspace_id (string)

{{< highlight json >}} { "query": , "query_set_id": "query-set-abcd1234", "name": "EC2 Count by Instance Type", "state": "ENABLED", "query_type": "MANAGED", "provider": "aws", "cloud_service_group": "EC2", "cloud_service_type": "Instance", "resource_group": "DOMAIN", } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

CloudServiceQuerySetsInfo

  • results (CloudServiceQuerySetInfo) Repeated Required

  • total_count (int32) Required

{{< highlight json >}} { "results": [ { "query_set_id": "query-set-abcd1234", "name": "EC2 Count by Instance Type", "state": "ENABLED", "query_type": "MANAGED", "query_options": "", "unit": { "Disk Size": "GB", "Memory": "GB", "CPU": "Core" }, "data_keys": [ "Disk Size", "Memory", "CPU ], "additional_info_keys": [ "instance_type" ], "provider": "aws", "cloud_service_group": "EC2", "cloud_service_type": "Instance", "tags": { "foo": "bar" }, "domain_id": "domain-58010aa2e451", "created_at": "2022-06-22T01:38:16.301Z", "updated_at": "2023-03-16T06:00:00.000Z" }, {...} ], "total_count": 2 } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

stat

POST /inventory/v1/cloud-service-query-set/stat

Message

CloudServiceQuerySetInfo

  • query_set_id (string) Required

  • name (string) Required

  • state (State) Required

  • query_options (AnalyzeQuery) Required

  • query_type (QueryType) Required

  • unit (Struct) Required

  • data_keys (string) Repeated Required

  • additional_info_keys (string) Repeated Required

  • provider (string) Required

  • cloud_service_group (string) Required

  • cloud_service_type (string) Required

  • tags (Struct) Required

  • resource_group (ResourceGroup) Required

  • domain_id (string) Required

  • workspace_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required

CloudServiceQuerySetQuery

  • query (Query)

  • query_set_id (string)

  • name (string)

  • state (State)

  • query_type (QueryType)

  • provider (string)

  • cloud_service_group (string)

  • cloud_service_type (string)

  • workspace_id (string)

CloudServiceQuerySetRequest

  • query_set_id (string) Required

CloudServiceQuerySetStatQuery

  • query (StatisticsQuery) Required

CloudServiceQuerySetsInfo

  • results (CloudServiceQuerySetInfo) Repeated Required

  • total_count (int32) Required

CreateCloudServiceQuerySetRequest

  • name (string) Required

  • query_options (AnalyzeQuery) Required

  • provider (string) Required

  • cloud_service_group (string) Required

  • cloud_service_type (string) Required

  • resource_group (ResourceGroup) Required

  • unit (Struct)

  • tags (Struct)

  • workspace_id (string)

UpdateCloudServiceQuerySetRequest

  • query_set_id (string) Required

  • name (string)

  • query_options (AnalyzeQuery)

  • unit (Struct)

  • tags (Struct)

PreviousCloudServiceNextCloudServiceReport

Last updated