NSX-T Data Center REST API

Return a Container Application within a container project

Returns information about a specific Container Application within a project.

Request:

Method:

GET

URI Path(s):

/api/v1/fabric/container-applications/{container-application-id}

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ContainerApplication+

ContainerApplication (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_ips	List of cluster IPs The IPv4 and IPv6 clusterIPs of the container application.	array of IPAddress
container_cluster_id	Identifier of the container cluster Identifier of the container cluster this container application belongs to.	string	Readonly
container_project_id	Identifier of the project Identifier of the project which this container application 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 Identifier of the container application on container cluster e.g. PCF app id, k8s service id.	string	Required
load_balancer_ingress	List of load-balancer ingress points Specifies list of load-balancer ingress points	array of ContainerLoadBalancerIngress
network_errors	Network errors List of network errors related to container application.	array of NetworkError
network_status	Network status of container application Network status of container application.	string	Enum: HEALTHY, UNHEALTHY
node_port_local_endpoints	List of NodePortLocalEndpoint Specifies list of local endpoint, when service is NodePortLocal.	array of NodePortLocalEndpoint
origin_properties	Origin properties Array of additional specific properties of container application in key-value format.	array of KeyValuePair
resource_type	Must be set to the value ContainerApplication	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
service_ports	List of service port Specifies list of service port.	array of ContainerServicePort
status	Status of the container application Status of the container application.	string	Enum: UNKNOWN, HEALTHY, UP, DOWN, DEGRADED
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
type	Type of container application	string	Enum: CLUSTER_IP, NODE_PORT, LOAD_BALANCER, EXTERNAL_NAME

Example Response:

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

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