DataSource

DataSource #

A DataSource is a plugin instance collecting metric and log data from Cloudforet.

Package : spaceone.api.monitoring.v1



DataSource #

DataSource Methods:

MethodRequestResponse
registerRegisterDataSourceRequestDataSourceInfo
updateUpdateDataSourceRequestDataSourceInfo
enableDataSourceRequestDataSourceInfo
disableDataSourceRequestDataSourceInfo
deregisterDataSourceRequestEmpty
update_pluginUpdateDataSourcePluginRequestDataSourceInfo
verify_pluginDataSourceRequestEmpty
getDataSourceRequestDataSourceInfo
listDataSourceQueryDataSourcesInfo
statDataSourceStatQueryStruct

register #

Registers a DataSource with information of the plugin to use. Information of the plugin includes version, provider, upgrade_mode.

POST /monitoring/v1/data-source/register

RegisterDataSourceRequest

  • name (string) Required

  • plugin_info (DataSourcePluginInfo) Required

  • tags (Struct)

{
       "name": "datasource-test",
       "plugin_info": {"plugin_id": "plugin-123456789012",
                       "version": "1.1.4.20220617.135934",
                       "options": {},
                       "provider": "aws",
                       "metadata": {
                           "supported_resource_type": ["inventory.Server", "inventory.CloudService"],
                           "required_keys": ["data.cloudwatch"],
                           "supported_stat": ["AVERAGE", "MAX", "MIN", "SUM"]},
                       "upgrade_mode": "AUTO"
                       },
       "tags": {"a": "b"},
       "domain_id": "domain-123456789012"
}

DataSourceInfo

  • data_source_id (string) Required

  • name (string) Required

  • state (State) Required

  • monitoring_type (MonitoringType) Required

  • provider (string) Required

  • capability (Struct) Required

  • plugin_info (DataSourcePluginInfo) Required

  • tags (Struct) Required

  • domain_id (string) Required

  • created_at (string) Required

{
   "data_source_id": "ds-123456789012",
   "name": "datasource-test",
   "state": "ENABLED",
   "monitoring_type": "METRIC",
   "provider": "aws",
   "capability": {
       "supported_schema": [
           "aws_access_key",
           "aws_assume_role"
       ],
       "use_resource_secret": true,
       "monitoring_type": "METRIC"
   },
   "plugin_info": {
       "plugin_id": "plugin-123456789012",
       "version": "1.1.4.20220617.135934",
       "options": {},
       "provider": "aws",
       "metadata": {
           "supported_stat": [
               "AVERAGE",
               "MAX",
               "MIN",
               "SUM"
           ],
           "supported_resource_type": [
               "inventory.Server",
               "inventory.CloudService"
           ],
           "required_keys": [
               "data.cloudwatch"
           ]
       },
       "upgrade_mode": "AUTO"
   },
   "tags": {
       "a": "b"
   },
   "domain_id": "domain-123456789012",
   "created_at": "2022-06-21T01:17:12.144Z"
}

update #

Updates a specific DataSource. You can make changes in DataSource settings, including name and tags.

POST /monitoring/v1/data-source/update

UpdateDataSourceRequest

  • data_source_id (string) Required

  • name (string)

  • tags (Struct)

{
       "data_source_id": "ds-123456789012",
       "name": "tmp-datasource_test",
       "tags": {"b": "c"},
       "domain_id": "domain-123456789012"
}

DataSourceInfo

  • data_source_id (string) Required

  • name (string) Required

  • state (State) Required

  • monitoring_type (MonitoringType) Required

  • provider (string) Required

  • capability (Struct) Required

  • plugin_info (DataSourcePluginInfo) Required

  • tags (Struct) Required

  • domain_id (string) Required

  • created_at (string) Required

{
   "data_source_id": "ds-123456789012",
   "name": "datasource-test",
   "state": "ENABLED",
   "monitoring_type": "METRIC",
   "provider": "aws",
   "capability": {
       "supported_schema": [
           "aws_access_key",
           "aws_assume_role"
       ],
       "use_resource_secret": true,
       "monitoring_type": "METRIC"
   },
   "plugin_info": {
       "plugin_id": "plugin-123456789012",
       "version": "1.1.4.20220617.135934",
       "options": {},
       "provider": "aws",
       "metadata": {
           "supported_stat": [
               "AVERAGE",
               "MAX",
               "MIN",
               "SUM"
           ],
           "supported_resource_type": [
               "inventory.Server",
               "inventory.CloudService"
           ],
           "required_keys": [
               "data.cloudwatch"
           ]
       },
       "upgrade_mode": "AUTO"
   },
   "tags": {
       "a": "b"
   },
   "domain_id": "domain-123456789012",
   "created_at": "2022-06-21T01:17:12.144Z"
}

enable #

Enables a specific DataSource. By enabling a DataSource, you can communicate with an external cloud service via the plugin.

POST /monitoring/v1/data-source/enable

DataSourceRequest

  • data_source_id (string) Required
{
   "data_source_id": "ds-6167ed6b42f4",
   "domain_id": "domain-123456789012"
}

DataSourceInfo

  • data_source_id (string) Required

  • name (string) Required

  • state (State) Required

  • monitoring_type (MonitoringType) Required

  • provider (string) Required

  • capability (Struct) Required

  • plugin_info (DataSourcePluginInfo) Required

  • tags (Struct) Required

  • domain_id (string) Required

  • created_at (string) Required

{
   "data_source_id": "ds-123456789012",
   "name": "datasource-test",
   "state": "ENABLED",
   "monitoring_type": "METRIC",
   "provider": "aws",
   "capability": {
       "supported_schema": [
           "aws_access_key",
           "aws_assume_role"
       ],
       "use_resource_secret": true,
       "monitoring_type": "METRIC"
   },
   "plugin_info": {
       "plugin_id": "plugin-123456789012",
       "version": "1.1.4.20220617.135934",
       "options": {},
       "provider": "aws",
       "metadata": {
           "supported_stat": [
               "AVERAGE",
               "MAX",
               "MIN",
               "SUM"
           ],
           "supported_resource_type": [
               "inventory.Server",
               "inventory.CloudService"
           ],
           "required_keys": [
               "data.cloudwatch"
           ]
       },
       "upgrade_mode": "AUTO"
   },
   "tags": {
       "a": "b"
   },
   "domain_id": "domain-123456789012",
   "created_at": "2022-06-21T01:17:12.144Z"
}

disable #

Disables a specific DataSource. By disabling a DataSource, you can block communication with an external cloud service via the plugin.

POST /monitoring/v1/data-source/disable

DataSourceRequest

  • data_source_id (string) Required
{
   "data_source_id": "ds-6167ed6b42f4",
   "domain_id": "domain-123456789012"
}

DataSourceInfo

  • data_source_id (string) Required

  • name (string) Required

  • state (State) Required

  • monitoring_type (MonitoringType) Required

  • provider (string) Required

  • capability (Struct) Required

  • plugin_info (DataSourcePluginInfo) Required

  • tags (Struct) Required

  • domain_id (string) Required

  • created_at (string) Required

{
   "data_source_id": "ds-123456789012",
   "name": "datasource-test",
   "state": "ENABLED",
   "monitoring_type": "METRIC",
   "provider": "aws",
   "capability": {
       "supported_schema": [
           "aws_access_key",
           "aws_assume_role"
       ],
       "use_resource_secret": true,
       "monitoring_type": "METRIC"
   },
   "plugin_info": {
       "plugin_id": "plugin-123456789012",
       "version": "1.1.4.20220617.135934",
       "options": {},
       "provider": "aws",
       "metadata": {
           "supported_stat": [
               "AVERAGE",
               "MAX",
               "MIN",
               "SUM"
           ],
           "supported_resource_type": [
               "inventory.Server",
               "inventory.CloudService"
           ],
           "required_keys": [
               "data.cloudwatch"
           ]
       },
       "upgrade_mode": "AUTO"
   },
   "tags": {
       "a": "b"
   },
   "domain_id": "domain-123456789012",
   "created_at": "2022-06-21T01:17:12.144Z"
}

deregister #

Deregisters and deletes a specific DataSource. You must specify the data_source_id of the DataSource to deregister.

POST /monitoring/v1/data-source/deregister

DataSourceRequest

  • data_source_id (string) Required
{
   "data_source_id": "ds-6167ed6b42f4",
   "domain_id": "domain-123456789012"
}

update_plugin #

Updates the plugin of a specific DataSource. This method resets the plugin data in the DataSource to update the metadata.

POST /monitoring/v1/data-source/update-plugin

UpdateDataSourcePluginRequest

  • data_source_id (string) Required

  • version (string)

  • options (Struct)

  • upgrade_mode (UpgradeMode)

{
   "data_source_id": "ds-6167ed6b42f4",
   "version": "1.1.3",
   "options": {},
   "upgrade_mode": "MANUAL",
   "domain_id": "domain-123456789012"
}

DataSourceInfo

  • data_source_id (string) Required

  • name (string) Required

  • state (State) Required

  • monitoring_type (MonitoringType) Required

  • provider (string) Required

  • capability (Struct) Required

  • plugin_info (DataSourcePluginInfo) Required

  • tags (Struct) Required

  • domain_id (string) Required

  • created_at (string) Required

{
   "data_source_id": "ds-123456789012",
   "name": "datasource-test",
   "state": "ENABLED",
   "monitoring_type": "METRIC",
   "provider": "aws",
   "capability": {
       "supported_schema": [
           "aws_access_key",
           "aws_assume_role"
       ],
       "use_resource_secret": true,
       "monitoring_type": "METRIC"
   },
   "plugin_info": {
       "plugin_id": "plugin-123456789012",
       "version": "1.1.4.20220617.135934",
       "options": {},
       "provider": "aws",
       "metadata": {
           "supported_stat": [
               "AVERAGE",
               "MAX",
               "MIN",
               "SUM"
           ],
           "supported_resource_type": [
               "inventory.Server",
               "inventory.CloudService"
           ],
           "required_keys": [
               "data.cloudwatch"
           ]
       },
       "upgrade_mode": "AUTO"
   },
   "tags": {
       "a": "b"
   },
   "domain_id": "domain-123456789012",
   "created_at": "2022-06-21T01:17:12.144Z"
}

verify_plugin #

Verifies the plugin of a specific DataSource. This method validates the plugin data, version and endpoint.

POST /monitoring/v1/data-source/verify-plugin

DataSourceRequest

  • data_source_id (string) Required
{
   "data_source_id": "ds-6167ed6b42f4",
   "domain_id": "domain-123456789012"
}

get #

Gets a specific DataSource. Prints detailed information about the DataSource, including name, state, and plugin_info.

POST /monitoring/v1/data-source/get

DataSourceRequest

  • data_source_id (string) Required
{
   "data_source_id": "ds-6167ed6b42f4",
   "domain_id": "domain-123456789012"
}

DataSourceInfo

  • data_source_id (string) Required

  • name (string) Required

  • state (State) Required

  • monitoring_type (MonitoringType) Required

  • provider (string) Required

  • capability (Struct) Required

  • plugin_info (DataSourcePluginInfo) Required

  • tags (Struct) Required

  • domain_id (string) Required

  • created_at (string) Required

{
   "data_source_id": "ds-123456789012",
   "name": "datasource-test",
   "state": "ENABLED",
   "monitoring_type": "METRIC",
   "provider": "aws",
   "capability": {
       "supported_schema": [
           "aws_access_key",
           "aws_assume_role"
       ],
       "use_resource_secret": true,
       "monitoring_type": "METRIC"
   },
   "plugin_info": {
       "plugin_id": "plugin-123456789012",
       "version": "1.1.4.20220617.135934",
       "options": {},
       "provider": "aws",
       "metadata": {
           "supported_stat": [
               "AVERAGE",
               "MAX",
               "MIN",
               "SUM"
           ],
           "supported_resource_type": [
               "inventory.Server",
               "inventory.CloudService"
           ],
           "required_keys": [
               "data.cloudwatch"
           ]
       },
       "upgrade_mode": "AUTO"
   },
   "tags": {
       "a": "b"
   },
   "domain_id": "domain-123456789012",
   "created_at": "2022-06-21T01:17:12.144Z"
}

list #

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

POST /monitoring/v1/data-source/list

DataSourceQuery

  • query (Query)

  • data_source_id (string)

  • name (string)

  • state (string)

  • monitoring_type (MonitoringType)

  • provider (string)

{
   "query": {},
   "domain_id": "domain-123456789012"
}

DataSourcesInfo

  • results (DataSourceInfo) Repeated Required

  • total_count (int32) Required

{
   "results": [
       {
           "data_source_id": "ds-89f1e81528e9",
           "name": "AWS CloudTrail",
           "state": "ENABLED",
           "monitoring_type": "LOG",
           "provider": "aws",
           "capability": {
               "use_resource_secret": true,
               "monitoring_type": "LOG",
               "supported_schema": [
                   "aws_access_key",
                   "aws_assume_role"
               ]
           },
           "plugin_info": {
               "plugin_id": "plugin-9881b9b440a4",
               "version": "1.0-dev2",
               "options": {},
               "provider": "aws",
               "metadata": {
                   "required_keys": [
                       "reference.resource_id"
                   ],
                   "supported_resource_type": [
                       "inventory.Server",
                       "inventory.CloudService"
                   ]
               },
               "upgrade_mode": "AUTO"
           },
           "tags": {},
           "domain_id": "domain-123456789012",
           "created_at": "2021-03-31T08:39:45.532Z"
       }
   ],
   "total_count": 2
}

stat #

POST /monitoring/v1/data-source/stat



Message #

DataSourceInfo #

  • data_source_id (string) Required

  • name (string) Required

  • state (State) Required

  • monitoring_type (MonitoringType) Required

  • provider (string) Required

  • capability (Struct) Required

  • plugin_info (DataSourcePluginInfo) Required

  • tags (Struct) Required

  • domain_id (string) Required

  • created_at (string) Required


DataSourcePluginInfo #

  • plugin_id (string) Required

  • version (string) Required

  • options (Struct) Required

  • metadata (Struct) Required

  • upgrade_mode (UpgradeMode) Required

  • secret_id (string) Required

  • provider (string) Required


DataSourceQuery #

  • query (Query)

  • data_source_id (string)

  • name (string)

  • state (string)

  • monitoring_type (MonitoringType)

  • provider (string)


DataSourceRequest #

  • data_source_id (string) Required


DataSourceStatQuery #

  • query (StatisticsQuery) Required


DataSourcesInfo #

  • results (DataSourceInfo) Repeated Required

  • total_count (int32) Required


RegisterDataSourceRequest #

  • name (string) Required

  • plugin_info (DataSourcePluginInfo) Required

  • tags (Struct)


UpdateDataSourcePluginRequest #

  • data_source_id (string) Required

  • version (string)

  • options (Struct)

  • upgrade_mode (UpgradeMode)


UpdateDataSourceRequest #

  • data_source_id (string) Required

  • name (string)

  • tags (Struct)


Calendar May 17, 2024
Edit Edit this page

Documentation Distributed under CC BY 4.0

Copyright © Cloudforet a Series of LF Projects, LLC. For website terms of use, trademark policy and other project policies please see https://lfprojects.org.