Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListDbInstancesForCluster

Returns a list of Timestream for InfluxDB clusters.

Request Syntax


{
   "dbClusterId": "string",
   "maxResults": number,
   "nextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

dbClusterId

Service-generated unique identifier of the DB cluster.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 64.

Pattern: [a-zA-Z0-9]+

Required: Yes

maxResults

The maximum number of items to return in the output. If the total number of items available is more than the value specified, a nextToken is provided in the output. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

The pagination token. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation.

Type: String

Length Constraints: Minimum length of 1.

Required: No

Response Syntax


{
   "items": [ 
      { 
         "allocatedStorage": number,
         "arn": "string",
         "dbInstanceType": "string",
         "dbStorageType": "string",
         "deploymentType": "string",
         "endpoint": "string",
         "id": "string",
         "instanceMode": "string",
         "name": "string",
         "networkType": "string",
         "port": number,
         "status": "string"
      }
   ],
   "nextToken": "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.

items

A list of Timestream for InfluxDB instance summaries belonging to the cluster.

Type: Array of DbInstanceForClusterSummary objects

nextToken

Token from a previous call of the operation. When this value is provided, the service returns results from where the previous response left off.

Type: String

Length Constraints: Minimum length of 1.

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400

InternalServerException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource was not found or does not exist.

resourceId: The identifier for the Timestream for InfluxDB resource associated with the request.
resourceType: The type of Timestream for InfluxDB resource associated with the request.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

retryAfterSeconds: The number of seconds the caller should wait before retrying.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by Timestream for InfluxDB.

reason: The reason that validation failed.

HTTP Status Code: 400