GET /gslbsmruntime/{uuid}

GET /gslbsmruntime/{uuid}

/gslbsmruntime/{uuid}

Request
URI
GET
https://{api_host}/api/gslbsmruntime/{uuid}
COPY
Path Parameters
string
uuid
Required

UUID of the object to fetch

Query Parameters
string
name
Optional

object name

string
fields
Optional

List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.

boolean
include_name
Optional

All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.

boolean
skip_default
Optional

Default values are not set.

string
join_subresources
Optional

It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Header Parameters
string
X-Avi-Tenant
Optional

Avi Tenant Header

string
X-Avi-Tenant-UUID
Optional

Avi Tenant Header UUID

string
X-Avi-Version
Required

The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.

string
X-CSRFToken
Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns GslbSMRuntime of type(s) application/json
{
    "_last_modified": "string",
    "cluster_leader": "string",
    "cluster_uuid": "string",
    "dns_configs": [
        {
            "domain_name": "string"
        }
    ],
    "dns_info": {
        "dns_active": false,
        "dns_vs_states": [
            {
                "geo_download": {
                    "last_changed_time": {
                        "secs": 0,
                        "usecs": 0
                    },
                    "state": "string"
                },
                "gslb_download": {
                    "last_changed_time": {
                        "secs": 0,
                        "usecs": 0
                    },
                    "state": "string"
                },
                "name": "string",
                "oper_status": {
                    "last_changed_time": {
                        "secs": 0,
                        "usecs": 0
                    },
                    "reason": [
                        "string"
                    ],
                    "reason_code": 0,
                    "reason_code_string": "string",
                    "state": "string"
                },
                "placement_rules": [
                    {
                        "placement_allowed": false,
                        "sub_domain": "string",
                        "transition_ops": "string"
                    }
                ],
                "se_list": [
                    "string"
                ],
                "uuid": "string",
                "valid_dns_vs": false
            }
        ],
        "gs_status": {
            "last_changed_time": {
                "secs": 0,
                "usecs": 0
            },
            "num_partial_updates": 0,
            "partial_update_threshold": 0,
            "state": "string",
            "type": "string"
        },
        "retry_count": 0
    },
    "enabled": false,
    "events": [
        {
            "msg": [
                "string"
            ],
            "name": "string",
            "timestamp": {
                "secs": 0,
                "usecs": 0
            },
            "uuid": "string"
        }
    ],
    "health_monitor_info": "string",
    "leader_cluster_uuid": "string",
    "member_type": "string",
    "name": "string",
    "node_uuid": "string",
    "num_of_retries": 0,
    "obj_uuid": "string",
    "oper_status": {
        "last_changed_time": {
            "secs": 0,
            "usecs": 0
        },
        "reason": [
            "string"
        ],
        "reason_code": 0,
        "reason_code_string": "string",
        "state": "string"
    },
    "remote_info": {
        "gslb_info": {
            "repl_state": {
                "cfg_version": 0,
                "cfg_version_in_flight": 0,
                "last_changed_time": {
                    "secs": 0,
                    "usecs": 0
                },
                "local_config": {
                    "vsgs_info": [
                        {
                            "dnsvs_uuid": "string",
                            "ops": "string",
                            "timestamp": {
                                "secs": 0,
                                "usecs": 0
                            }
                        }
                    ]
                },
                "reason": "string",
                "site_uuid": "string",
                "status": "string",
                "uuid": "string"
            }
        },
        "ops_info": {
            "rrtoken": [
                "string"
            ]
        },
        "sync_info": {
            "errored_objects": [
                {
                    "ds_name": "string",
                    "name": "string",
                    "ops": "string",
                    "reason": "string",
                    "status": 0,
                    "uuid": "string"
                }
            ],
            "last_changed_time": {
                "secs": 0,
                "usecs": 0
            },
            "last_fail_obj": {
                "event_type": "string",
                "obj_name": "string",
                "obj_uuid": "string"
            },
            "prev_target_version": 0,
            "reason": "string",
            "recommendation": "string",
            "site_version": 0,
            "sync_state": "string",
            "target_version": 0
        },
        "sync_stats": {
            "acknowledged_version": 0,
            "pending_object_count": 0,
            "received_version": 0
        }
    },
    "role": "string",
    "site_name": "string",
    "site_type": "string",
    "state": "string",
    "sw_version": "string",
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string",
    "view_id": 0
}
string
_last_modified
Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

string
cluster_leader
Optional

The controller cluster leader node UUID. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
cluster_uuid
Optional

The site controller cluster UUID. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

array of object
dns_configs
Optional

Sub domain configuration for the GSLB. GSLB service's FQDN must be a match one of these subdomains. . Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

object
dns_info
Optional

dns_info

boolean
enabled
Optional

Activate/de-activate state retrieved from the cfg. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

array of object
events
Optional

Captures SM related events. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
health_monitor_info
Optional

This field will provide information on origin(site name) of the health monitoring information. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
leader_cluster_uuid
Required

Mark this Site as leader of GSLB configuration. This site is the one among the Avi sites. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
member_type
Optional
Constraints: default: GSLB_PASSIVE_MEMBER

The site's member type A leader is set to ACTIVE while all members are set to passive. . Enum options - GSLB_ACTIVE_MEMBER, GSLB_PASSIVE_MEMBER. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
name
Optional

The name of DB entry. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
node_uuid
Optional

The controller cluster node UUID that processes the site.Sites are sharded across the cluster nodes. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

integer As int32 As int32
num_of_retries
Optional

Number of retry attempts to reach the remote site. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
obj_uuid
Optional

GSLB SM Runtime object uuid. Points to the GSLB to which this belongs. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

object
oper_status
Optional

oper_status

object
remote_info
Optional

remote_info

string
role
Optional
Constraints: default: GSLB_NOT_A_MEMBER

Site Role Leader or Follower. Enum options - GSLB_LEADER, GSLB_MEMBER, GSLB_NOT_A_MEMBER. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
site_name
Optional

The Gslb site name. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
site_type
Optional

Indicates if it is Avi Site or third-party. Enum options - GSLB_AVI_SITE, GSLB_THIRD_PARTY_SITE. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
state
Optional
Constraints: default: SITE_STATE_NULL

Represents the state of the site. Enum options - SITE_STATE_NULL, SITE_STATE_JOIN_IN_PROGRESS, SITE_STATE_LEAVE_IN_PROGRESS, SITE_STATE_INIT, SITE_STATE_UNREACHABLE, SITE_STATE_MMODE, SITE_STATE_DISABLE_IN_PROGRESS, SITE_STATE_DISABLED, SITE_STATE_HS_IN_PROGRESS. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
sw_version
Optional
Constraints: default: Not-Initialized

Current Software version of the site. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
tenant_ref
Optional

Uuid of the tenant. It is a reference to an object of type Tenant. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

The uuid of DB entry. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

integer As uint64 As uint64
view_id
Optional

The view-id is used in change-leader mode to differentiate partitioned groups while they have the same GSLB namespace. Each partitioned group will be able to operate independently by using the view-id. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.


401

log in failed

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/gslbsmruntime/{uuid}