NSX-T Data Center REST API

Return a container application instance

Returns information about a specific container application instance.

Request:

Method:

GET

URI Path(s):

/api/v1/fabric/container-application-instances/<container-application-instance-id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/fabric/container-application-instances/a2068f56-6026-11e9-980c-dca9048e157d

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ContainerApplicationInstance+

ContainerApplicationInstance (schema)

Name	Description	Type	Notes
_last_sync_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cluster_node_id	Cluster node id Cluster node id where application instance is running.	string
container_application_ids	Identifiers of the container application List of identifiers of the container application.	array of string
container_cluster_id	Identifier of the container cluster Identifier of the container cluster this application instance belongs to.	string	Readonly
container_project_id	Identifier of the project Identifier of the container project which this container application instance belongs to.	string
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
external_id	External identifier of the container application instance Identifier of the container application instance on container cluster.	string	Required
network_errors	Network errors List of network errors related to container application instance.	array of NetworkError
network_status	Network status of container application instance Network status of container application instance.	string	Enum: HEALTHY, UNHEALTHY
origin_properties	Origin properties Array of additional specific properties of container application instance in key-value format.	array of KeyValuePair
resource_type	Must be set to the value ContainerApplicationInstance	string	Required
scope	List of scopes for discovered resource Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.	array of DiscoveredResourceScope
status	Status of the container application instance Status of the container application instance.	string	Enum: UNKNOWN, HEALTHY, UP, DOWN, DEGRADED
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "external_id": "a2068f56-6026-11e9-980c-dca9048e157d", "container_cluster_id": "a19ad270-6026-11e9-980c-dca9048e157d", "container_project_id": "a1ba2e72-6026-11e9-980c-dca9048e157d", "container_application_ids": [ "a1e60b5a-6026-11e9-980c-dca9048e157d" ], "tags": [ { "scope": "dis:k8s:key", "tag": "val" } ], "origin_properties": [ { "key": "prop0", "value": "val0" } ], "status": "UP", "resource_type": "ContainerApplicationInstance", "display_name": "app-instance-1", "_last_sync_time": 1555405475693 }

Required Permissions:

read

Feature:

containers_inventory

Additional Errors:

• 404 Not Found
• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable