REST Resource: projects.locations.realms

Resource: Realm

A Realm represents a distinct network domain or security zone. It groups Ranges that share the same traffic and management characteristics. All the ranges in a Realm are routable to each other, meaning that they cannot overlap.

JSON representation 
{
  "name": string,
  "trafficType": enum (TrafficType),
  "managementType": enum (ManagementType),
  "registryBook": string,
  "discoveryMetadata": {
    object (DiscoveryMetadata)
  },
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "ipVersion": enum (IpVersion),
  "aggregatedData": {
    object (RealmAggregatedData)
  }
}
Fields
name

string

Required. Identifier. The resource name of the Realm.
trafficType

enum (TrafficType)

Required. Traffic type of the Realm.
managementType

enum (ManagementType)

Required. Management type of the Realm.
registryBook

string

Required. Name of the RegistryBook that claims the Realm.
discoveryMetadata

object (DiscoveryMetadata)

Output only. Discovery metadata of the Realm.
createTime

string (Timestamp format)

Output only. The time at which the Realm was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. The time at which the Realm was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Optional. User-defined labels.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
ipVersion

enum (IpVersion)

Optional. IP version of the Realm.
aggregatedData

object (RealmAggregatedData)

Output only. Aggregated data for the Realm. Populated only when the view is AGGREGATE.

TrafficType

Traffic type of the Realm.

Enums
TRAFFIC_TYPE_UNSPECIFIED Unspecified traffic type.
UNSET Unset traffic type.
INTERNET Internet traffic.
PRIVATE Private traffic.
LINKLOCAL Linklocal traffic.

ManagementType

Management type of the Realm.

Enums
MANAGEMENT_TYPE_UNSPECIFIED Unspecified management type.
CNR Managed by Cloud Number Registry.
USER Managed by User.

IpVersion

IP version of the Realm.

Enums
IP_VERSION_UNSPECIFIED Unspecified IP version.
IPV4 IPv4 IP version.
IPV6 IPv6 IP version.

RealmAggregatedData

Aggregated data for the Realm.

JSON representation 
{
  "discoveredRangesCount": integer,
  "customRangesCount": integer
}
Fields
discoveredRangesCount

integer

Output only. Number of DiscoveredRanges in the Realm.
customRangesCount

integer

Output only. Number of CustomRanges in the Realm.

Methods

create

 Creates a new Realm in a given project and location.

delete

 Deletes a single Realm.

get

 Gets details of a single Realm.

list

 Lists Realms in a given project and location.

patch

 Updates the parameters of a single Realm.