GetServerDetails
Retrieves detailed information about a specified server.
Request Syntax
GET /get-server-details/serverId?maxResults=maxResults&nextToken=nextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- maxResults
-
The maximum number of items to include in the response. The maximum value is 100.
- nextToken
-
The token from a previous call that you use to retrieve the next set of results. For example, if a previous call to this action returned 100 items, but you set
maxResultsto 10. You'll receive a set of 10 results along with a token. You then use the returned token to retrieve the next set of 10.Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
.*\S.* - serverId
-
The ID of the server.
Length Constraints: Minimum length of 1. Maximum length of 27.
Pattern:
.*\S.*Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"associatedApplications": [
{
"id": "string",
"name": "string"
}
],
"nextToken": "string",
"serverDetail": {
"antipatternReportS3Object": {
"s3Bucket": "string",
"s3key": "string"
},
"antipatternReportStatus": "string",
"antipatternReportStatusMessage": "string",
"applicationComponentStrategySummary": [
{
"count": number,
"strategy": "string"
}
],
"dataCollectionStatus": "string",
"id": "string",
"lastAnalyzedTimestamp": number,
"listAntipatternSeveritySummary": [
{
"count": number,
"severity": "string"
}
],
"name": "string",
"recommendationSet": {
"strategy": "string",
"targetDestination": "string",
"transformationTool": {
"description": "string",
"name": "string",
"tranformationToolInstallationLink": "string"
}
},
"serverError": {
"serverErrorCategory": "string"
},
"serverType": "string",
"statusMessage": "string",
"systemInfo": {
"cpuArchitecture": "string",
"fileSystemType": "string",
"networkInfoList": [
{
"interfaceName": "string",
"ipAddress": "string",
"macAddress": "string",
"netMask": "string"
}
],
"osInfo": {
"type": "string",
"version": "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.
- associatedApplications
-
The associated application group the server belongs to, as defined in AWS Application Discovery Service.
Type: Array of AssociatedApplication objects
- nextToken
-
The token you use to retrieve the next set of results, or null if there are no more results.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
.*\S.* - serverDetail
-
Detailed information about the server.
Type: ServerDetail object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The user does not have permission to perform the action. Check the AWS Identity and Access Management (IAM) policy associated with this user.
HTTP Status Code: 403
- InternalServerException
-
The server experienced an internal error. Try again.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified ID in the request is not found.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The request body isn't valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
