Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetSolNetworkInstance

Gets the details of the network instance.

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

Request Syntax


GET /sol/nslcm/v1/ns_instances/nsInstanceId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

nsInstanceId

ID of the network instance.

Pattern: ^ni-[a-f0-9]{17}$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "id": "string",
   "lcmOpInfo": { 
      "nsLcmOpOccId": "string"
   },
   "metadata": { 
      "createdAt": "string",
      "lastModified": "string"
   },
   "nsdId": "string",
   "nsdInfoId": "string",
   "nsInstanceDescription": "string",
   "nsInstanceName": "string",
   "nsState": "string",
   "tags": { 
      "string" : "string" 
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn

Network instance ARN.

Type: String

Pattern: ^arn:(aws|aws-cn|aws-iso|aws-iso-b|aws-us-gov):tnb:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]):\d{12}:(network-instance/ni-[a-f0-9]{17})$

id

Network instance ID.

Type: String

Pattern: ^ni-[a-f0-9]{17}$

lcmOpInfo

Lifecycle management operation details on the network instance.

Lifecycle management operations are deploy, update, or delete operations.

Type: LcmOperationInfo object

metadata

The metadata of a network instance.

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

Type: GetSolNetworkInstanceMetadata object

nsdId

Network service descriptor ID.

Type: String

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

nsdInfoId

Network service descriptor info ID.

Type: String

Pattern: ^np-[a-f0-9]{17}$

nsInstanceDescription

Network instance description.

Type: String

nsInstanceName

Network instance name.

Type: String

nsState

Network instance state.

Type: String

tags

A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your AWS costs.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Pattern: ^(?!aws:).{1,128}$

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Insufficient permissions to make request.

HTTP Status Code: 403

InternalServerException

Unexpected error occurred. Problem on the server.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource that doesn't exist.

HTTP Status Code: 404

ThrottlingException

Exception caused by throttling.

HTTP Status Code: 429

ValidationException

Unable to process the request because the client provided input failed to satisfy request constraints.

HTTP Status Code: 400