Liking cljdoc? Tell your friends :D

clj-oci.region

OCI Region API wrapper.

  • list-regions — all available OCI regions (global, no params)
  • list-region-subscriptions — regions subscribed by a tenancy
  • create-region-subscription — subscribe a tenancy to a new region

Uses IdentityClient via clj-oci.clients. No caching — region data is static and calls are infrequent.

OCI Region API wrapper.

- `list-regions` — all available OCI regions (global, no params)
- `list-region-subscriptions` — regions subscribed by a tenancy
- `create-region-subscription` — subscribe a tenancy to a new region

Uses `IdentityClient` via `clj-oci.clients`. No caching — region data
is static and calls are infrequent.
raw docstring

create-region-subscriptionclj

(create-region-subscription tenancy-id region-key)
(create-region-subscription tenancy-id region-key opts)

Subscribes tenancy-id to the region identified by region-key.

For tenancies whose home region differs from the auth provider's default, supply :region in opts — the request must hit the home-region endpoint of the queried tenancy.

Returns {:data {...}} with the new RegionSubscription or {:error ...}.

Options: :region — region-id or 3-letter code routing the request :opc-retry-token — idempotency token (expires after 24h)

Subscribes `tenancy-id` to the region identified by `region-key`.

For tenancies whose home region differs from the auth provider's
default, supply `:region` in `opts` — the request must hit the
home-region endpoint of the queried tenancy.

Returns {:data {...}} with the new RegionSubscription or {:error ...}.

Options:
  :region          — region-id or 3-letter code routing the request
  :opc-retry-token — idempotency token (expires after 24h)
raw docstring

list-region-subscriptionsclj

(list-region-subscriptions tenancy-id)
(list-region-subscriptions tenancy-id opts)

Returns the regions subscribed by tenancy-id.

For tenancies whose home region differs from the auth provider's default, supply :region in opts (region-id like "us-chicago-1" or 3-letter code like "ord"). The query must hit the home region of the queried tenancy — wrong-region queries return a TenantNotFound 404 even with IAM access.

Returns {:data {:items [{:regionKey "PHX" :regionName "us-phoenix-1" :status "Ready" :isHomeRegion true} ...]}} or {:error ...} on failure. Status is "Ready" or "InProgress".

Returns the regions subscribed by `tenancy-id`.

For tenancies whose home region differs from the auth provider's
default, supply `:region` in `opts` (region-id like "us-chicago-1"
or 3-letter code like "ord"). The query must hit the *home region*
of the queried tenancy — wrong-region queries return a
`TenantNotFound` 404 even with IAM access.

Returns {:data {:items [{:regionKey "PHX" :regionName "us-phoenix-1"
                         :status "Ready" :isHomeRegion true} ...]}}
or {:error ...} on failure.
Status is "Ready" or "InProgress".
raw docstring

list-regionsclj

(list-regions)

Returns all OCI regions.

The Identity API returns every region in one response (no pagination). This is a global catalog endpoint (no tenancy in the request) — the singleton client is always sufficient.

Returns {:data {:items [{:key "PHX" :name "us-phoenix-1"} ...]}} or {:error ...} on failure.

Returns all OCI regions.

The Identity API returns every region in one response (no pagination).
This is a global catalog endpoint (no tenancy in the request) — the
singleton client is always sufficient.

Returns {:data {:items [{:key "PHX" :name "us-phoenix-1"} ...]}}
or {:error ...} on failure.
raw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close