ListContainerInstances
Returns a list of container instances in a specified cluster. You can filter the
results of a ListContainerInstances
operation with cluster query language
statements inside the filter
parameter. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
Request Syntax
{
"cluster": "string
",
"filter": "string
",
"maxResults": number
,
"nextToken": "string
",
"status": "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.
- cluster
-
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.
Type: String
Required: No
- filter
-
You can filter the results of a
ListContainerInstances
operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.Type: String
Required: No
- maxResults
-
The maximum number of container instance results that
ListContainerInstances
returned in paginated output. When this parameter is used,ListContainerInstances
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListContainerInstances
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter isn't used, thenListContainerInstances
returns up to 100 results and anextToken
value if applicable.Type: Integer
Required: No
- nextToken
-
The
nextToken
value returned from aListContainerInstances
request indicating that more results are available to fulfill the request and further calls are needed. IfmaxResults
was provided, it's possible the number of results to be fewer thanmaxResults
.Note
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
Type: String
Required: No
- status
-
Filters the container instances by status. For example, if you specify the
DRAINING
status, the results include only container instances that have been set toDRAINING
using UpdateContainerInstancesState. If you don't specify this parameter, the default is to include container instances set to all states other thanINACTIVE
.Type: String
Valid Values:
ACTIVE | DRAINING | REGISTERING | DEREGISTERING | REGISTRATION_FAILED
Required: No
Response Syntax
{
"containerInstanceArns": [ "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.
- containerInstanceArns
-
The list of container instances with full ARN entries for each container instance associated with the specified cluster.
Type: Array of strings
- nextToken
-
The
nextToken
value to include in a futureListContainerInstances
request. When the results of aListContainerInstances
request exceedmaxResults
, this value can be used to retrieve the next page of results. This value isnull
when there are no more results to return.Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- ClientException
-
These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.
The following list includes additional causes for the error:
-
The
RunTask
could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in thePROVISIONING
per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.
HTTP Status Code: 400
-
- ClusterNotFoundException
-
The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
HTTP Status Code: 400
- InvalidParameterException
-
The specified parameter isn't valid. Review the available parameters for the API request.
HTTP Status Code: 400
- ServerException
-
These errors are usually caused by a server issue.
HTTP Status Code: 500
Examples
In the following example or examples, the Authorization header contents
(AUTHPARAMS
) must be replaced with an Amazon Signature Version 4
signature. For more information, see Signature
Version 4 Signing Process in the
Amazon General
Reference.
You only need to learn how to sign HTTP requests if you intend to
create them manually. When you use the Amazon Command Line Interface
Example
This example request lists the container instances in the "example" cluster.
Sample Request
POST / HTTP/1.1
Host: ecs.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 2
X-Amz-Target: AmazonEC2ContainerServiceV20141113.ListContainerInstances
X-Amz-Date: 20150429T175306Z
Content-Type: application/x-amz-json-1.1
Authorization: AUTHPARAMS
{"containerInstanceArns":["arn:aws:ecs:us-east-1:012345678910:container-instance/example/1eb22c8ab33149b397dc769f68cc1319","arn:aws:ecs:us-east-1:012345678910:container-instance/example/5cf7e311a2b74d3882650353cf3b2214"]}
Sample Response
HTTP/1.1 200 OK
Server: Server
Date: Wed, 29 Apr 2015 17:53:06 GMT
Content-Type: application/x-amz-json-1.1
Content-Length: 492
Connection: keep-alive
x-amzn-RequestId: 123a4b56-7c89-01d2-3ef4-example5678f
{
"containerInstanceArns": [
"arn:aws:ecs:us-east-1:012345678910:container-instance/example/1eb22c8ab33149b397dc769f68cc1319",
"arn:aws:ecs:us-east-1:012345678910:container-instance/example/5cf7e311a2b74d3882650353cf3b2214"
]
}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: