v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1456373564.1 KB

Describes the specified services running in your cluster.

post/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.DescribeServices

Headers

X-Amz-Target'AmazonEC2ContainerServiceV20141113.DescribeServices' required

Request body

clusterstring

The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the service or services you are describing were launched in any cluster other than the default cluster.

servicesString[] required

A list of services to describe. You may specify up to 10 services to describe in a single operation.

includeServiceField[]

Determines whether you want to see the resource tags for the service. If <code>TAGS</code> is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.

Response

Success

Example response

{
  "failures": [],
  "services": [
    {
      "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/default",
      "createdAt": "2016-08-29T16:25:52.130Z",
      "deploymentConfiguration": {
        "maximumPercent": 200,
        "minimumHealthyPercent": 100
      },
      "deployments": [
        {
          "createdAt": "2016-08-29T16:25:52.130Z",
          "desiredCount": 1,
          "id": "ecs-svc/9223370564341623665",
          "pendingCount": 0,
          "runningCount": 0,
          "status": "PRIMARY",
          "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6",
          "updatedAt": "2016-08-29T16:25:52.130Z"
        }
      ],
      "desiredCount": 1,
      "events": [
        {
          "createdAt": "2016-08-29T16:25:58.520Z",
          "id": "38c285e5-d335-4b68-8b15-e46dedc8e88d",
          "message": "(service ecs-simple-service) was unable to place a task because no container instance met all of its requirements. The closest matching (container-instance 3f4de1c5-ffdd-4954-af7e-75b4be0c8841) is already using a port required by your task. For more information, see the Troubleshooting section of the Amazon ECS Developer Guide."
        }
      ],
      "loadBalancers": [],
      "pendingCount": 0,
      "runningCount": 0,
      "serviceArn": "arn:aws:ecs:us-east-1:012345678910:service/ecs-simple-service",
      "serviceName": "ecs-simple-service",
      "status": "ACTIVE",
      "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6"
    }
  ]
}