Skip to content

Latest commit

 

History

History
39 lines (30 loc) · 3.76 KB

GetEndpoints.md

File metadata and controls

39 lines (30 loc) · 3.76 KB

GetEndpoints

Properties

Name Type Description Notes
application_boundary_scope str Use when querying calls of an application: `INBOUND`: only inbound calls `ALL`: all the calls to that application (inbound + internal) [optional]
application_id str An Instana generated unique identifier for an Application. If specified, the list of results will be filtered for the specified Application ID. Eg: `Av62RoIKQv-A3n6DbMQh9g`. One can see the application id from Instana UI by going to an Application Perspective page. In the URL, there will be `appId=Av62RoIKQv-A3n6DbMQh9g`. Alternatively, one can use `Get applications` API endpoint to get the application id in `id` parameter. [optional]
endpoint_id str An Instana generated unique identifier for an Endpoint. If specified, the list of results will be filtered for the specified Endpoint ID. Eg `NCRq5oYnan5x-PkdTPQwLLUdu5M`. One can see the endpoint id from Instana UI by going to an Endpoint page. In the URL, there will be `endpointId=NCRq5oYnan5x-PkdTPQwLLUdu5M`. Alternatively, one can use `Get endpoints` API endpoint to get the endpoint id in `id` parameter. [optional]
endpoint_types List[str] A list of endpoint types, each of which is a string. An endpoint can specified for a database, an SDK, etc. [optional]
exclude_synthetic bool A variable used to specify whether synthetic endpoints should be excluded. If set to 'true', synthetic endpoints will be excluded from the result. [optional]
metrics List[AppDataMetricConfiguration] A list of objects each of which defines a metric and the (statistical) aggregation -- MEAN, SUM, MAX, etc -- that should be used to summarize it for the defined time frame. Eg: `[{ 'metric': 'latency', 'aggregation': 'MEAN'}]`. To know more about supported metrics and its aggregation, See `Get Metric catalog`.
name_filter str filter by endpoint name with `contains` semantic. Eg: Let's say there are 2 Endpoint names `GET /api/fetch` and `GET /api/update`, you can set `GET /api/` here to include the two Endpoints. [optional]
order Order [optional]
pagination Pagination [optional]
service_id str An Instana generated unique identifier for a Service. If specified, the list of results will be filtered for the specified Service ID. Eg: `3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. One can see the service id from Instana UI by going to a Service page. In the URL, there will be `serviceId=3feb3dcd206c166ef2b41c707e0cd38d7cd325aa`. Alternatively, one can use `Get services` API endpoint to get the service id in `id` parameter. [optional]
time_frame TimeFrame [optional]

Example

from instana_client.models.get_endpoints import GetEndpoints

# TODO update the JSON string below
json = "{}"
# create an instance of GetEndpoints from a JSON string
get_endpoints_instance = GetEndpoints.from_json(json)
# print the JSON string representation of the object
print(GetEndpoints.to_json())

# convert the object into a dict
get_endpoints_dict = get_endpoints_instance.to_dict()
# create an instance of GetEndpoints from a dict
get_endpoints_from_dict = GetEndpoints.from_dict(get_endpoints_dict)

[Back to Model list] [Back to API list] [Back to README]