GET /microservice/{uuid}

/microservice/{uuid}

Request

URI

GET

https://api_host/api/microservice/{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.

Responses

200

Returns MicroService of type(s) application/json

{
    "_last_modified": "string",
    "application_name": "string",
    "cloud_config_cksum": "string",
    "configpb_attributes": {
        "version": 0
    },
    "containers": [
        {
            "container_id": "string",
            "host": "string",
            "ip": {
                "addr": "string",
                "type": "string"
            },
            "port": 0,
            "task_id": "string"
        }
    ],
    "created_by": "string",
    "description": "string",
    "ip_list": false,
    "name": "string",
    "orchestrator_name": "string",
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}

string

_last_modified

Optional

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

string

application_name

Required

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

cloud_config_cksum

Optional

Checksum of cloud configuration for Microservice. Internally set by cloud connector. Field introduced in 17.2.8. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ConfigPbAttributes

configpb_attributes

Optional

configpb_attributes

array of MicroServiceContainer

containers

Optional

The list of containers for this microservice. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

created_by

Optional

Creator name. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

description

Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean

ip_list

Optional

Flag to indicate if container IP list is provided by cloud connectorThis is applicable for overlay cases. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

name

Required

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

orchestrator_name

Required

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

tenant_ref

Optional

It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

url

Optional

url

string

uuid

Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

401

Operation doesn't return any data structure

On This Page

Description