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
  • ExchangeRate
  • set
  • reset
  • enable
  • disable
  • get
  • list
  • Message
  • ExchangeRateInfo
  • ExchangeRateQuery
  • ExchangeRateRequest
  • ExchangeRatesInfo
  • SetExchangeRateRequest
  1. content
  2. en
  3. cost_analysis
  4. v1

ExchangeRate

An ExchangeRate is a resource defining the exchange rate of currencies. This resource can set a custom exchange rate for a specific domain, separately from the exchange rate of the default domain set in config.

Package : spaceone.api.cost_analysis.v1

ExchangeRate

ExchangeRate Methods:

Method
Request
Response

set

Overrides a value of a specific ExchangeRate. This method is used to change the ExchangeRate in a specific domain. You can set the currency and rate of the resource.

POST /cost-analysis/v1/exchange-rate/set

{{< tabs " set " >}}

{{< tab "Request Example" >}}

  • currency (string) Required

  • rate (float) Required

  • domain_id (string) Required

{{< highlight json >}} { "currency": "KRW", "rate": 1300 } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

  • currency (string) Required

  • rate (float) Required

  • state (State) Required

  • is_default (bool) Required

  • domain_id (string) Required

{{< highlight json >}} { "currency": "KRW", "rate": 1300.0, "state": "ENABLED", "is_default": true } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

reset

Resets a value of a specific ExchangeRate and changes the ExchangeRate to the ExchangeRate of the default domain.

POST /cost-analysis/v1/exchange-rate/reset

{{< tabs " reset " >}}

{{< tab "Request Example" >}}

  • currency (string) Required

  • domain_id (string) Required

{{< highlight json >}} { "currency": "KRW" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

  • currency (string) Required

  • rate (float) Required

  • state (State) Required

  • is_default (bool) Required

  • domain_id (string) Required

{{< highlight json >}} { "currency": "KRW", "rate": 1300.0, "state": "ENABLED", "is_default": true } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

enable

POST /cost-analysis/v1/exchange-rate/enable

{{< tabs " enable " >}}

{{< tab "Request Example" >}}

  • currency (string) Required

  • domain_id (string) Required

{{< highlight json >}} { "currency": "KRW" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

  • currency (string) Required

  • rate (float) Required

  • state (State) Required

  • is_default (bool) Required

  • domain_id (string) Required

{{< highlight json >}} { "currency": "KRW", "rate": 1300.0, "state": "ENABLED", "is_default": true } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

disable

POST /cost-analysis/v1/exchange-rate/disable

{{< tabs " disable " >}}

{{< tab "Request Example" >}}

  • currency (string) Required

  • domain_id (string) Required

{{< highlight json >}} { "currency": "KRW" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

  • currency (string) Required

  • rate (float) Required

  • state (State) Required

  • is_default (bool) Required

  • domain_id (string) Required

{{< highlight json >}} { "currency": "KRW", "rate": 1300.0, "state": "ENABLED", "is_default": true } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

get

Gets a specific ExchangeRate. Prints detailed information about the ExchangeRate, including currency and rate.

POST /cost-analysis/v1/exchange-rate/get

{{< tabs " get " >}}

{{< tab "Request Example" >}}

  • currency (string) Required

  • domain_id (string) Required

{{< highlight json >}} { "currency": "KRW" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

  • currency (string) Required

  • rate (float) Required

  • state (State) Required

  • is_default (bool) Required

  • domain_id (string) Required

{{< highlight json >}} { "currency": "KRW", "rate": 1300.0, "state": "ENABLED", "is_default": true } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

list

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

POST /cost-analysis/v1/exchange-rate/list

{{< tabs " list " >}}

{{< tab "Request Example" >}}

  • domain_id (string) Required

{{< highlight json >}} {

} {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

  • results (ExchangeRateInfo) Repeated Required

  • total_count (int32) Required

{{< highlight json >}} { "results": [ { "currency": "JPY", "rate": 129.8, "state": "ENABLED", "is_default": true, "domain_id": "domain-58010aa2e451" }, { "currency": "KRW", "rate": 1242.7, "state": "ENABLED", "is_default": true, "domain_id": "domain-58010aa2e451" } ], "total_count": 2 } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

Message

ExchangeRateInfo

  • currency (string) Required

  • rate (float) Required

  • state (State) Required

  • is_default (bool) Required

  • domain_id (string) Required

ExchangeRateQuery

  • domain_id (string) Required

ExchangeRateRequest

  • currency (string) Required

  • domain_id (string) Required

ExchangeRatesInfo

  • results (ExchangeRateInfo) Repeated Required

  • total_count (int32) Required

SetExchangeRateRequest

  • currency (string) Required

  • rate (float) Required

  • domain_id (string) Required

PreviousDataSourceRuleNextJob

Last updated 2 years ago

SetExchangeRateRequest
ExchangeRateRequest
ExchangeRateRequest
ExchangeRateRequest
ExchangeRateRequest
ExchangeRateQuery
ExchangeRateInfo
ExchangeRateInfo
ExchangeRateInfo
ExchangeRateInfo
ExchangeRateInfo
ExchangeRatesInfo
set
SetExchangeRateRequest
ExchangeRateInfo
reset
ExchangeRateRequest
ExchangeRateInfo
enable
ExchangeRateRequest
ExchangeRateInfo
disable
ExchangeRateRequest
ExchangeRateInfo
get
ExchangeRateRequest
ExchangeRateInfo
list
ExchangeRateQuery
ExchangeRatesInfo