cloudforet-apis
  • README
  • content
    • en
      • Cloudforet API Documentation
      • board
        • _index
        • v1
          • Board
          • Post
          • v1
      • config
        • _index
        • v1
          • DomainConfig
          • PublicConfig
          • UserConfig
          • WorkspaceConfig
          • v1
      • core
        • _index
        • v1
          • Handler
          • Query
          • ServerInfo
          • v1
        • v2
          • Handler
          • Plugin
          • Query
          • v2
      • cost_analysis
        • _index
        • plugin
          • Cost
          • DataSource
          • Job
          • plugin
        • v1
          • Budget
          • BudgetUsage
          • Cost
          • CostQuerySet
          • CostReport
          • CostReportConfig
          • CostReportData
          • CustomWidget
          • DataSource
          • DataSourceAccount
          • DataSourceRule
          • ExchangeRate
          • Job
          • JobTask
          • PublicDashboard
          • Schedule
          • UnifiedCost
          • UserDashboard
          • v1
      • dashboard
        • _index
        • v1
          • CustomWidget
          • Dashboard
          • DomainDashboard
          • PrivateDashboard
          • PrivateDataTable
          • PrivateFolder
          • PrivateWidget
          • ProjectDashboard
          • PublicDashboard
          • PublicDataTable
          • PublicFolder
          • PublicWidget
          • v1
      • file_manager
        • _index
        • v1
          • File
          • PublicFile
          • v1
      • identity
        • _index
        • plugin
          • AccountCollector
          • Auth
          • ExternalAuth
          • plugin
        • v1
          • ApiKey
          • Authorization
          • Domain
          • DomainOwner
          • Endpoint
          • Policy
          • Project
          • ProjectGroup
          • Provider
          • Role
          • RoleBinding
          • ServiceAccount
          • Token
          • User
          • v1
        • v2
          • Agent
          • ApiKey
          • App
          • Authorization
          • Domain
          • Endpoint
          • ExternalAuth
          • Job
          • Package
          • Policy
          • Project
          • ProjectGroup
          • Provider
          • Role
          • RoleBinding
          • Schema
          • ServiceAccount
          • System
          • Token
          • TrustedAccount
          • TrustedServiceAccount
          • User
          • UserGroup
          • UserProfile
          • Workspace
          • WorkspaceGroup
          • WorkspaceGroupDetails
          • WorkspaceGroupUser
          • WorkspaceUser
          • v2
      • inventory
        • _index
        • plugin
          • Collector
          • Job
          • plugin
        • v1
          • ChangeHistory
          • CloudService
          • CloudServiceQuerySet
          • CloudServiceReport
          • CloudServiceStats
          • CloudServiceType
          • Collector
          • CollectorRule
          • Job
          • JobTask
          • Metric
          • MetricData
          • MetricExample
          • Namespace
          • Note
          • Region
          • ResourceGroup
          • v1
        • v2
          • Region
          • v2
      • monitoring
        • _index
        • plugin
          • DataSource
          • Event
          • Log
          • Metric
          • Webhook
          • plugin
        • v1
          • Alert
          • DataSource
          • EscalationPolicy
          • Event
          • EventRule
          • Log
          • MaintenanceWindow
          • Metric
          • Note
          • ProjectAlertConfig
          • Webhook
          • v1
      • mzc_service_api
        • _index
        • v1
          • Contract
          • Offering
          • Organization
          • v1
      • notification
        • _index
        • plugin
          • Notification
          • Protocol
          • plugin
        • v1
          • Notification
          • NotificationUsage
          • ProjectChannel
          • Protocol
          • Quota
          • UserChannel
          • v1
      • opsflow
        • _index
        • v1
          • Comment
          • Event
          • Task
          • TaskCategory
          • TaskType
          • v1
      • plugin
        • _index
        • v1
          • Plugin
          • Supervisor
          • v1
      • repository
        • _index
        • v1
          • DashboardTemplate
          • Plugin
          • Policy
          • Repository
          • Schema
          • v1
        • v2
          • Common
          • Provider
          • RemoteRepository
          • Schema
          • v2
      • sample
        • _index
        • v1
          • Helloworld
          • v1
      • search
        • _index
        • v1
          • Resource
          • v1
      • secret
        • _index
        • v1
          • Secret
          • SecretGroup
          • TrustedSecret
          • UserSecret
          • v1
      • statistics
        • _index
        • plugin
          • Storage
          • plugin
        • v1
          • History
          • Resource
          • Schedule
          • Storage
          • v1
Powered by GitBook
On this page
  • CloudServiceStats
  • list
  • analyze
  • stat
  • Message
  • CloudServiceStatInfo
  • CloudServiceStatsAnalyzeQuery
  • CloudServiceStatsInfo
  • CloudServiceStatsQuery
  • CloudServiceStatsStatQuery
  1. content
  2. en
  3. inventory
  4. v1

CloudServiceStats

PreviousCloudServiceReportNextCloudServiceType

Last updated 1 year ago

A CloudServiceStats is statistics data created from from cloud service query sets.

Package : spaceone.api.inventory.v1

CloudServiceStats

CloudServiceStats Methods:

Method
Request
Response

list

Gets a list of raw statistics data. You can use a query to get a filtered list of statistics data.

POST /inventory/v1/cloud-service-stats/list

{{< tabs " list " >}}

{{< tab "Request Example" >}}

  • query_set_id (string) Required

  • query (Query)

  • provider (string)

  • cloud_service_group (string)

  • cloud_service_type (string)

  • region_code (string)

  • account (string)

  • workspace_id (string)

  • project_id (string)

{{< highlight json >}} { "query": , "query_set_id": "query-set-abcd1234", "provider": "aws", "cloud_service_group": "EC2", "cloud_service_type": "Instance", "region_code": "us-east-1", "account": "aws-account-id", "project_id": "project-abcd1234" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

  • results (CloudServiceStatInfo) Repeated Required

  • total_count (int32) Required

{{< highlight json >}} { "results": [ { "query_set_id": "query-set-abcd1234", "key": "Disk Size", "data": { "Disk Size": 1040, "Memory Size": 1024, "CPU": 2 }, "unit": { "Disk Size": "GB", "Memory": "GB", "CPU": "Core" }, "provider": "aws", "cloud_service_group": "EC2", "cloud_service_type": "Instance", "region_code": "us-east-1", "account": "aws-account-id", "additional_info": { "instance_type": "t2.micro" }, "project_id": "project-abcd1234", "domain_id": "domain-58010aa2e451", "created_date": "2022-06-22" }, {...} ], "total_count": 2 } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

analyze

POST /inventory/v1/cloud-service-stats/analyze

stat

POST /inventory/v1/cloud-service-stats/stat

Message

CloudServiceStatInfo

  • query_set_id (string) Required

  • data (Struct) Required

  • unit (Struct) Required

  • provider (string) Required

  • cloud_service_group (string) Required

  • cloud_service_type (string) Required

  • region_code (string) Required

  • account (string) Required

  • additional_info (Struct) Required

  • domain_id (string) Required

  • workspace_id (string) Required

  • project_id (string) Required

  • created_date (string) Required

CloudServiceStatsAnalyzeQuery

  • query (TimeSeriesAnalyzeQuery) Required

  • query_set_id (string) Required

CloudServiceStatsInfo

  • results (CloudServiceStatInfo) Repeated Required

  • total_count (int32) Required

CloudServiceStatsQuery

  • query_set_id (string) Required

  • query (Query)

  • provider (string)

  • cloud_service_group (string)

  • cloud_service_type (string)

  • region_code (string)

  • account (string)

  • workspace_id (string)

  • project_id (string)

CloudServiceStatsStatQuery

  • query (StatisticsQuery) Required

  • query_set_id (string)

CloudServiceStatsQuery
CloudServiceStatsInfo
list
CloudServiceStatsQuery
CloudServiceStatsInfo
analyze
CloudServiceStatsAnalyzeQuery
Struct
stat
CloudServiceStatsStatQuery
Struct