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
  • Region
  • create
  • update
  • delete
  • get
  • list
  • stat
  • Message
  • CreateRegionRequest
  • RegionInfo
  • RegionQuery
  • RegionRequest
  • RegionStatQuery
  • RegionsInfo
  • UpdateRegionRequest
  1. content
  2. en
  3. inventory
  4. v2

Region

A Region is a resource storing regional information from each cloud service provider. Regional data stored by the resource includes the latitude and longitude of the region.

Package : spaceone.api.inventory.v2

Region

Region Methods:

Method
Request
Response

create

Creates a new Region. As the parameter region_key, which is automatically created when a Region is created, is in a form of {provider}.{region_code}, it is unique regardless of providers. You can also specify the latitude, longitude, and continent information in tags.

POST /inventory/v2/region/create

update

Updates a specific Region. You can make changes in Region settings, including name and tags. The tags contain the continent, latitude, and longitude.

POST /inventory/v2/region/update

delete

Deletes a specific Region. You must specify the region_id of the Region to delete.

POST /inventory/v2/region/delete

get

Gets a specific Region. Prints detailed information about the Region, including name, region_code, and a location coordinate.

POST /inventory/v2/region/get

list

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

POST /inventory/v2/region/list

stat

POST /inventory/v2/region/stat

Message

CreateRegionRequest

  • name (string) Required

  • region_code (string) Required

  • provider (string)

  • tags (Struct)

RegionInfo

  • region_id (string) Required

  • name (string) Required

  • region_key (string) Required

  • region_code (string) Required

  • provider (string) Required

  • tags (Struct) Required

  • domain_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required

RegionQuery

  • query (Query)

  • region_id (string)

  • name (string)

  • region_key (string)

  • region_code (string)

  • provider (string)

RegionRequest

  • region_id (string) Required

RegionStatQuery

  • query (StatisticsQuery) Required

RegionsInfo

  • results (RegionInfo) Repeated Required

  • total_count (int32) Required

UpdateRegionRequest

  • region_id (string) Required

  • name (string)

  • tags (Struct)

Previousv2Nextv2

Last updated 5 months ago

create
CreateRegionRequest
RegionInfo
update
UpdateRegionRequest
RegionInfo
delete
RegionRequest
Empty
get
RegionRequest
RegionInfo
list
RegionQuery
RegionsInfo
stat
RegionStatQuery
Struct