action bluemix_get_containers_groups_name_or_id {
  label: "Inspect a container group."
  description: "This endpoint retrieves detailed information about a container group with a given name (corresponding IBM Containers command: `cf ic group inspect GROUP`)."
  provider: bluemix
  method: GET
  path: "/containers/groups/{name_or_id}"
  encoding: json
  input: {
    type: "object"
    properties: {
      "X-Auth-Project-Id": {
        type: "string"
      }
      "X-Auth-Token": {
        type: "string"
      }
      name_or_id: {
        type: "string"
      }
    }
    required: ["X-Auth-Project-Id", "X-Auth-Token", "name_or_id"]
    additionalProperties: false
  }
  output: {
    properties: {
      "Anti-affinity": {
        type: "string"
        description: "If set to `true` the container instances in the group are spread across separate physical compute nodes, which reduces the likelihood of containers crashing due to hardware failures. If set to `false`, the container instances in the group share the same physical compute node. "
      }
      Autorecovery: {
        type: "string"
        description: "Can be either true or false. If set to true, the Autorecovery mode is enabled for your container group. In case a container instance crashes or stops, this instance is removed and a new one is automatically recreated. If set to false, the Autorecovery mode is disabled. In case a container instances crashes or stops, it is not automatically recreated by IBM Containers."
      }
      AvailabilityZone: {
        type: "string"
        description: "Current IBM Containers availability zone on Openstack. "
      }
      Cmd: {
        type: "array"
        description: "The Docker command that was specified to be run when the container instances are started. "
        items: {
          type: "string"
        }
      }
      Creation_time: {
        type: "string"
        description: "Timestamp when the container group was created."
      }
      Env: {
        type: "array"
        description: "The list of environmental variables that were defined for the container group. Each environment variable consists of a unique key and a value."
        items: {
          type: "string"
        }
      }
      Id: {
        type: "string"
        description: "Unique identifier representing a specific container group."
      }
      Image: {
        type: "string"
        description: "The unique ID of the container image your container group instances are based on."
      }
      ImageName: {
        type: "string"
        description: "The full path to the container image in your private Bluemix repository."
      }
      Memory: {
        type: "integer"
        format: "int32"
        description: "The size of each container instance that runs in the container group in MegaByte."
      }
      Name: {
        type: "string"
        description: "The name of the container group."
      }
      NumberInstances: {
        type: "object"
        properties: {
          CurrentSize: {
            type: "integer"
            format: "int32"
            description: "The current number of container instances that are running in your container group. "
          }
          Desired: {
            type: "integer"
            format: "int32"
            description: "The number of container instances that you require."
          }
          Max: {
            type: "integer"
            format: "int32"
            description: "The maximum number of container instance that you want to run in your container group."
          }
          Min: {
            type: "integer"
            format: "int32"
            description: "The minimum number of container instances that you want to run in your container group."
          }
        }
      }
      Port: {
        type: "integer"
        format: "int32"
        description: "The public port that has been exposed. If you specified a route, your container group is accessible from the Internet. "
      }
      Route_Status: {
        type: "object"
        properties: {
          in_progress: {
            type: "boolean"
            description: "Can be either true or false. If set to true, then the route is in the process of being mapped to the container group and set up in the GoRouter. Is set to false, then the set up of the route is completed."
          }
          message: {
            type: "string"
            description: "Info message for the user."
          }
          successful: {
            type: "boolean"
            description: "Can be either true or false. If set to true, then the route is successfully registrered with the GoRouter. If set to false, then the route registration has not yet finished yet or could not be completed without errors."
          }
        }
      }
      Routes: {
        type: "array"
        description: "The public route that is mapped to the container group. When you expose a public port, you can use the route to access your container group from the Internet."
        items: {
          type: "string"
        }
      }
      Status: {
        type: "string"
        description: "The current status of the container group. The container group status is a composite of ACTION and STATUS:<br><br> ACTIONS = (CREATE, DELETE, UPDATE, ROLLBACK, SUSPEND, RESUME, ADOPT, SNAPSHOT, CHECK, RESTORE)<br><br> STATUSES = (IN_PROGRESS, FAILED, COMPLETE)"
      }
      UpdatedTime: {
        type: "string"
        description: "Timestamp when the container group was updated. If the container group was not updated before, `null` is returned."
      }
      Volumes: {
        type: "array"
        description: "List of volumes to be associated with the container, in the format of volume name:path:mode where mode can be ro or rw."
        items: {
          type: "string"
        }
      }
    }
  }
}