EntitiesService_GetEntities

EntitiesService_GetEntities

Responses

• 200
• default

---

A successful response.

application/json

• Schema
• Example (from schema)

---

Schema

• entities_by_ip_address object

  Entities defines mapping of entities.

  entities object

  property name* object

  Entity represents a pod, VM, and so on.

  ip_address string required

  Possible values: Value must match regular expression ^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$

  IP address of the entity.

  name string

  Name of the entity. For example, pod name.

  namespace string

  Namespace of the entity. For example, pod namespace.

  node_name string

  Node name of the entity. For example, hostname.

  services string[]

  Possible values: >= 1

  Services of the entity.

  uid string required

  Unique identifier of the entity.

• entities_by_name object

  Entities defines mapping of entities.

  entities object

  property name* object

  Entity represents a pod, VM, and so on.

  ip_address string required

  Possible values: Value must match regular expression ^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$

  IP address of the entity.

  name string

  Name of the entity. For example, pod name.

  namespace string

  Namespace of the entity. For example, pod namespace.

  node_name string

  Node name of the entity. For example, hostname.

  services string[]

  Possible values: >= 1

  Services of the entity.

  uid string required

  Unique identifier of the entity.

{
  "entities_by_ip_address": {
    "entities": {}
  },
  "entities_by_name": {
    "entities": {}
  }
}

An unexpected error response.

application/json

• Schema
• Example (from schema)

---

Schema

• code int32

  The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

• details object[]

  A list of messages that carry the error details. There is a common set of message types for APIs to use.

  Array [

  @type string

  A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).

  In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

  • If no scheme is provided, https is assumed.
  • An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
  • Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

  Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.

  Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

  ]
• message string

  A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

GET /v1/discovery/entities

Request

Base URL

https://aperture-agent

curl / cURL

curl -L -X GET 'https://aperture-agent/v1/discovery/entities' \
-H 'Accept: application/json'

python / requests

curl -L -X GET 'https://aperture-agent/v1/discovery/entities' \
-H 'Accept: application/json'

go / native

curl -L -X GET 'https://aperture-agent/v1/discovery/entities' \
-H 'Accept: application/json'