DC Cluster Topology.
const url = 'https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/data/namespaces/system/topology/dc_cluster_group/example';const options = { method: 'POST', headers: {Authorization: '<Authorization>', 'Content-Type': 'application/json'}, body: '{"dc_cluster_group":"example","metric_selector":{"edge":["METRIC_TYPE_IN_BYTES"],"end_time":"example","node":["METRIC_TYPE_IN_BYTES"],"start_time":"example","step":"example"}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/data/namespaces/system/topology/dc_cluster_group/example \ --header 'Authorization: <Authorization>' \ --header 'Content-Type: application/json' \ --data '{ "dc_cluster_group": "example", "metric_selector": { "edge": [ "METRIC_TYPE_IN_BYTES" ], "end_time": "example", "node": [ "METRIC_TYPE_IN_BYTES" ], "start_time": "example", "step": "example" } }'GET topology of a DC Cluster.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”DC Cluster group Name of the DC Cluster group.
Request Bodyrequired
Section titled “Request Bodyrequired”Request to GET DC Cluster group topology and the associated metrics.
object
Name of the DC Cluster group.
object
List of metrics to be returned for the edges.
End time of metric data. This field is applicable only if “include_metrics” is set to true. Format: unix_timestamp|RFC 3339
Optional: If not specified, then the end_time will be evaluated to start_time+10m
If start_time is not specified, then the end_time will be evaluated to
List of metrics to be returned for the nodes.
Start time of metric data. This field is applicable only if “include_metrics” is set to true. Format: unix_timestamp|RFC 3339
Optional: If not specified, then the start_time will be evaluated to end_time-10m
If end_time is not specified, then the start_time will be evaluated to
Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, … Tn=tn-1+step, where tn <= end_time. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days
Optional: If not specified, then step size is evaluated to <end_time - start_time>
Responses
Section titled “Responses”A successful response.
Relationship between the resources associated with a site is represented as a graph, where each resource/entity is represented as a node (example: Site (CE, RE), Network (VPC, Virtual Network), Subnet, etc.,) and their association is represented as edges (example: Site (CE) - Site (CE, RE), Network (VPC) - Subnets, etc.,). All edges are directed. However if 2 nodes have bidirectional connection, (example: Site - Site), there may be 2 edges in the response for the same pair of nodes.
object
List of edges in the topology graph.
Canonical representation of Edge in the topology graph.
object
An edge may be composed of multiple links. For example, there may be multiple tunnels between a transit gateway and a site and each tunnel is represented as individual links. In some cases, we may want to show only one link between 2 nodes, eventhough there may be multiple connections/tunnels between these nodes.
LinkTypeData contains details about the link and the metrics (if requested/available).
object
object
Endpoint identifier. Dst_id is the destination endpoint for the link is between src_id and dst_id.
Name of the link. Link name may or may not be present depending on the type of link.
Endpoint identifier. Src_id is the source endpoint for the link is between src_id and dst_id.
Metric data for the link.
Metric Data contains the metric type and the metric data.
object
Metric Data.
Metric Type Data contains key that uniquely identifies individual entity and its corresponding metric values. For example, if an instance contains multiple interfaces, then the key contains the name/value pair that identifies the interface name of the instance.
object
Labels contains the name/value pair that uniquely identifies an entity whose metric is being reported. If the Labels is empty, then the metric value is for the corresponding node or edge. For example, if an instance contains multiple interfaces, then the labels contains the name/value pairs that identifies the interface name of the instance.
object
List of metric values. May contain more than one value if timeseries data is requested.
Metric data contains timestamp and the value.
object
Timestamp
object
X-displayName: “Description” description of the method used to calculate trend.
X-displayName: “Previous Value”
X-displayName: “Value”
Configuration parameter for value
Node identifier.
Node identifier.
List of nodes in the topology graph.
Canonical representation of Node in the topology graph.
object
object
object
object
object
object
object
This field indicates the number of sites that are part of this DC Cluster group.
Identifier for the node.
object
object
Architecture.
Availability Zone.
CPU Count
F5XC node name.
Instance type.
A list of network interfaces.
A canonical form of the network interface.
object
object
Members of the Bond interface along with the corresponding link state.
BondMembersType represents the bond interface members along with the corresponding link state.
object
Link speed of Bond Interface Member in Mbps.
Link state of Bond Interface Member.
Name of the Bond Interface Member.
Indicate if DHCP server is configured on the interface.
object
object
Prefix-length of the IPv4 subnet. Must be <= 32.
Prefix part of the IPv4 subnet in string form with dot-decimal notation.
object
Prefix length of the IPv6 subnet. Must be <= 128.
Prefix part of the IPv6 subnet given in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ e.g. “2001:db8:0:0:0:2:0:0” The address can be compacted by suppressing zeros e.g. “2001:db8::2::”
object
object
Prefix-length of the IPv4 subnet. Must be <= 32.
Prefix part of the IPv4 subnet in string form with dot-decimal notation.
object
Prefix length of the IPv6 subnet. Must be <= 128.
Prefix part of the IPv6 subnet given in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ e.g. “2001:db8:0:0:0:2:0:0” The address can be compacted by suppressing zeros e.g. “2001:db8::2::”
Link State for the interface.
MAC Address of interface.
Name of interface.
Name of Virtual Network to which the interface belongs.
Name of this interface.
Private Address.
Address with additional information.
object
Address
Address type.
Indicate this address is primary or not.
Public address.
Address with additional information.
object
Address
Address type.
Indicate this address is primary or not.
Security groups.
Status
Reference to the subnets connected.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
Platform
Private Address.
Private DNS Name.
Public address.
Public DNS Name.
Security groups.
Metric data for the Instance.
Metric Data contains the metric type and the metric data.
object
Metric Data.
Metric Type Data contains key that uniquely identifies individual entity and its corresponding metric values. For example, if an instance contains multiple interfaces, then the key contains the name/value pair that identifies the interface name of the instance.
object
Labels contains the name/value pair that uniquely identifies an entity whose metric is being reported. If the Labels is empty, then the metric value is for the corresponding node or edge. For example, if an instance contains multiple interfaces, then the labels contains the name/value pairs that identifies the interface name of the instance.
object
List of metric values. May contain more than one value if timeseries data is requested.
Metric data contains timestamp and the value.
object
Timestamp
object
X-displayName: “Description” description of the method used to calculate trend.
X-displayName: “Previous Value”
X-displayName: “Value”
Configuration parameter for value
object
Cloud Resource Identifier for the node. This is only used for node which represent the cloud resource.
Description of the node. This field may or may not be populated depending on the node type and if the user provided description while creating the resource.
Level indicates the distance of the node from the root node. A value of 0 indicates the root node.
Name of the node.
Owner ID
Status in the node.
List of key/value pairs associated with the node.
object
object
object
IPv4 CIDR
IPv6 CIDR
Load Balancer Present in this Network.
Load Balancer.
object
ID of the LB.
Name of the LB.
Reference to the network peers.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
Reference to the regions.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
Metric data for the Network.
Metric Data contains the metric type and the metric data.
object
Metric Data.
Metric Type Data contains key that uniquely identifies individual entity and its corresponding metric values. For example, if an instance contains multiple interfaces, then the key contains the name/value pair that identifies the interface name of the instance.
object
Labels contains the name/value pair that uniquely identifies an entity whose metric is being reported. If the Labels is empty, then the metric value is for the corresponding node or edge. For example, if an instance contains multiple interfaces, then the labels contains the name/value pairs that identifies the interface name of the instance.
object
List of metric values. May contain more than one value if timeseries data is requested.
Metric data contains timestamp and the value.
object
Timestamp
object
X-displayName: “Description” description of the method used to calculate trend.
X-displayName: “Previous Value”
X-displayName: “Value”
Configuration parameter for value
object
List of route tables associated with the network.
Metadata associated with the route table.
object
Cloud Resource Identifier this route table.
Name of the route table.
Map of string keys and values that annotated in the topology node.
object
object
object
Reference to the DC Cluster group.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
Reference to the network.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
Reference to the transit gateway.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
Metric data for the Site.
Metric Data contains the metric type and the metric data.
object
Metric Data.
Metric Type Data contains key that uniquely identifies individual entity and its corresponding metric values. For example, if an instance contains multiple interfaces, then the key contains the name/value pair that identifies the interface name of the instance.
object
Labels contains the name/value pair that uniquely identifies an entity whose metric is being reported. If the Labels is empty, then the metric value is for the corresponding node or edge. For example, if an instance contains multiple interfaces, then the labels contains the name/value pairs that identifies the interface name of the instance.
object
List of metric values. May contain more than one value if timeseries data is requested.
Metric data contains timestamp and the value.
object
Timestamp
object
X-displayName: “Description” description of the method used to calculate trend.
X-displayName: “Previous Value”
X-displayName: “Value”
Configuration parameter for value
object
Availability zone.
Site Node Count.
Provides mapping for node, private IP and public IP.
Node Information for connectivity across sites.
object
Name of the master/main node on the site.
Site Local Inside IP address.
Site Local Outside IP address.
object
object
object
object
object
If ‘Type’ is Spoke, ‘Hub’ refers to a Site Mesh Group of ‘type’ Hub. Spoke sites connect to all the member sites of Hub Site Mesh Group. Hub will be empty when Site Mesh Group type is Hub or Full Mesh.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
object
object
object
object
object
object
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
Topology Sites referenced in this site_mesh_group.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
Virtual Site referenced in this site_mesh_group.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
object
Summary of the edges status between the sites in the site mesh group.
Summary information for an edge.
object
Links count.
Summary of the link status between the sites in the site mesh group.
Summary information for a link type.
object
Links count.
If the site mesh group is of type “Hub”, this field indicates the number of sites in all the spoke mesh groups that are connected to this site mesh group. If the site mesh group is of type “Spoke”, this field indicates the number of sites in the hub as well as the sites in other spoke groups that are attached to this hub.
This field indicates the number of sites that are part of this site mesh group.
object
object
Availability zone.
IPv4 CIDR
IPv6 CIDR
Reference to the network.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
Reference to the regions. (Used for GCP)
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
Metric data for the Subnet.
Metric Data contains the metric type and the metric data.
object
Metric Data.
Metric Type Data contains key that uniquely identifies individual entity and its corresponding metric values. For example, if an instance contains multiple interfaces, then the key contains the name/value pair that identifies the interface name of the instance.
object
Labels contains the name/value pair that uniquely identifies an entity whose metric is being reported. If the Labels is empty, then the metric value is for the corresponding node or edge. For example, if an instance contains multiple interfaces, then the labels contains the name/value pairs that identifies the interface name of the instance.
object
List of metric values. May contain more than one value if timeseries data is requested.
Metric data contains timestamp and the value.
object
Timestamp
object
X-displayName: “Description” description of the method used to calculate trend.
X-displayName: “Previous Value”
X-displayName: “Value”
Configuration parameter for value
object
List of route tables associated with the subnet.
Metadata associated with the route table.
object
Cloud Resource Identifier this route table.
Name of the route table.
Map of string keys and values that annotated in the topology node.
object
object
object
TGW Attachements.
AWS TGW Attachment.
object
Associated Route Table ID.
Association State.
Configuration parameter for cidr
Reference to the Cloud Connect.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
TGW Attachment ID.
TGW Attachment Name.
Resource ID.
Resource Name.
Resource Type.
Reference to the Segment.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
Auto accept shared attachment.
DNS support.
Reference to the network.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
VPN ecmp support.
Metric data for the Transit Gateway.
Metric Data contains the metric type and the metric data.
object
Metric Data.
Metric Type Data contains key that uniquely identifies individual entity and its corresponding metric values. For example, if an instance contains multiple interfaces, then the key contains the name/value pair that identifies the interface name of the instance.
object
Labels contains the name/value pair that uniquely identifies an entity whose metric is being reported. If the Labels is empty, then the metric value is for the corresponding node or edge. For example, if an instance contains multiple interfaces, then the labels contains the name/value pairs that identifies the interface name of the instance.
object
List of metric values. May contain more than one value if timeseries data is requested.
Metric data contains timestamp and the value.
object
Timestamp
object
X-displayName: “Description” description of the method used to calculate trend.
X-displayName: “Previous Value”
X-displayName: “Value”
Configuration parameter for value
Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.
Example
{ "edges": [ { "links": [ { "info": { "status": "LINK_STATUS_NOT_APPLICABLE", "type": "LINK_TYPE_TUNNEL" }, "metric": [ { "data": [ { "values": [ { "trend_value": { "sentiment": "TREND_SENTIMENT_NONE" } } ] } ], "type": "METRIC_TYPE_IN_BYTES", "unit": "UNIT_MILLISECONDS" } ] } ], "status": "LINK_STATUS_NOT_APPLICABLE" } ], "nodes": [ { "instance": { "info": { "interfaces": [ { "f5xc_status": { "active_state": "STATE_UNKNOWN", "ip_mode": "STATIC", "link_quality": "QUALITY_UNKNOWN", "link_type": "LINK_TYPE_UNKNOWN", "network_type": "VIRTUAL_NETWORK_SITE_LOCAL" } } ] }, "metric": [ { "data": [ { "values": [ { "trend_value": { "sentiment": "TREND_SENTIMENT_NONE" } } ] } ], "type": "METRIC_TYPE_IN_BYTES", "unit": "UNIT_MILLISECONDS" } ] }, "metadata": { "provider_type": "PROVIDER_TYPE_UNSPECIFIED" }, "network": { "metric": [ { "data": [ { "values": [ { "trend_value": { "sentiment": "TREND_SENTIMENT_NONE" } } ] } ], "type": "METRIC_TYPE_IN_BYTES", "unit": "UNIT_MILLISECONDS" } ] }, "site": { "info": { "app_type": "SITE_APPTYPE_NONE", "gateway_type": "INGRESS_GATEWAY", "orchestration_mode": "NOT_MANAGED", "site_type": "INVALID" }, "metric": [ { "data": [ { "values": [ { "trend_value": { "sentiment": "TREND_SENTIMENT_NONE" } } ] } ], "type": "METRIC_TYPE_IN_BYTES", "unit": "UNIT_MILLISECONDS" } ] }, "site_mesh_group": { "info": { "site_type": "INVALID", "type": "SITE_MESH_GROUP_TYPE_INVALID" }, "summary": { "edge_status_summary": [ { "status": "LINK_STATUS_NOT_APPLICABLE" } ], "link_status_summary": [ { "status": "LINK_STATUS_NOT_APPLICABLE", "type": "LINK_TYPE_TUNNEL" } ] } }, "subnet": { "info": { "interface_type": "OUTSIDE" }, "metric": [ { "data": [ { "values": [ { "trend_value": { "sentiment": "TREND_SENTIMENT_NONE" } } ] } ], "type": "METRIC_TYPE_IN_BYTES", "unit": "UNIT_MILLISECONDS" } ] }, "transit_gateway": { "metric": [ { "data": [ { "values": [ { "trend_value": { "sentiment": "TREND_SENTIMENT_NONE" } } ] } ], "type": "METRIC_TYPE_IN_BYTES", "unit": "UNIT_MILLISECONDS" } ] } } ]}Returned when operation is not authorized.
Examplegenerated
exampleReturned when there is no permission to access resource.
Examplegenerated
exampleReturned when resource is not found.
Examplegenerated
exampleReturned when operation on resource is conflicting with current value.
Examplegenerated
exampleReturned when operation has been rejected as it is happening too frequently.
Examplegenerated
exampleReturned when server encountered an error in processing API.
Examplegenerated
exampleReturned when service is unavailable temporarily.
Examplegenerated
exampleReturned when server timed out processing request.
Examplegenerated
example