---
title: "GET /sol/nslcm/v1/ns_instances"
method: GET
path: "/sol/nslcm/v1/ns_instances"
---

# GET /sol/nslcm/v1/ns_instances

`GET /sol/nslcm/v1/ns_instances`

Lists your network instances.

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

## Query parameters

- `max_results` integer
- `nextpage_opaque_marker` string

## Response `200`

Success

- ListSolNetworkInstancesOutput
  - `networkInstances` ListSolNetworkInstanceInfo[] — Lists network instances.
    - `arn` string, required — Network instance ARN.
    - `id` string, required — ID of the network instance.
    - `metadata` object, required — The metadata of the network instance.
      - `createdAt` string, date-time, required — The date that the resource was created.
      - `lastModified` string, date-time, required — The date that the resource was last modified.
    - `nsInstanceDescription` string, required — Human-readable description of the network instance.
    - `nsInstanceName` string, required — Human-readable name of the network instance.
    - `nsState` 'INSTANTIATED' | 'NOT_INSTANTIATED' | 'UPDATED' | 'IMPAIRED' | 'UPDATE_FAILED' | 'STOPPED' | 'DELETED' | 'INSTANTIATE_IN_PROGRESS' | 'INTENT_TO_UPDATE_IN_PROGRESS' | 'UPDATE_IN_PROGRESS' | 'TERMINATE_IN_PROGRESS', required — The state of the network instance.
    - `nsdId` string, required — ID of the network service descriptor in the network package.
    - `nsdInfoId` string, required — ID of the network service descriptor in the network package.
  - `nextToken` string — The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.

## Other responses

- `480` — InternalServerException
- `481` — ThrottlingException
- `482` — ValidationException
- `483` — AccessDeniedException

---

[API](https://skmtc.net/aws/apis/tnb.md) · [All operations](https://skmtc.net/aws/apis/tnb/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/tnb/versions/0ae8563a8404/schema)