GetSolFunctionInstance
Gets the details of a network function instance, including the instantation state and metadata from the function package descriptor in the network function package.
A network function instance is a function in a function package .
Request Syntax
GET /sol/vnflcm/v1/vnf_instances/vnfInstanceId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- vnfInstanceId
-
ID of the network function.
Pattern:
^fi-[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",
"instantiatedVnfInfo": {
"vnfcResourceInfo": [
{
"metadata": {
"cluster": "string",
"helmChart": "string",
"nodeGroup": "string"
}
}
],
"vnfState": "string"
},
"instantiationState": "string",
"metadata": {
"createdAt": "string",
"lastModified": "string"
},
"nsInstanceId": "string",
"tags": {
"string" : "string"
},
"vnfdId": "string",
"vnfdVersion": "string",
"vnfPkgId": "string",
"vnfProductName": "string",
"vnfProvider": "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 function 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}:(function-instance/fi-[a-f0-9]{17})$ - id
-
Network function instance ID.
Type: String
Pattern:
^fi-[a-f0-9]{17}$ - instantiatedVnfInfo
-
Information about the network function.
A network function instance is a function in a function package .
Type: GetSolVnfInfo object
- instantiationState
-
Network function instantiation state.
Type: String
Valid Values:
INSTANTIATED | NOT_INSTANTIATED - metadata
-
The metadata of a network function instance.
A network function instance is a function in a function package .
Type: GetSolFunctionInstanceMetadata object
- nsInstanceId
-
Network instance ID.
Type: String
Pattern:
^ni-[a-f0-9]{17}$ -
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.
- vnfdId
-
Function package 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}$ - vnfdVersion
-
Function package descriptor version.
Type: String
- vnfPkgId
-
Function package ID.
Type: String
Pattern:
^fp-[a-f0-9]{17}$ - vnfProductName
-
Network function product name.
Type: String
- vnfProvider
-
Network function provider.
Type: String
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
