All Products
Search
Document Center

Elastic High Performance Computing:DescribeContainerApp

Last Updated:Apr 09, 2024

Queries the information of a containerized application.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ehpc:DescribeContainerAppREAD
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ContainerIdstringYes

The ID of the containerized application.

You can call the ListContainerApps operation to query the ID of the containerized application.

ehpc-container-ABDUGSkjs****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

04F0F334-1335-436C-A1D7-6C044FE7****
ContainerAppInfoobject

The information of the containerized application.

Typestring

The type of the container. Set the value to singularity.

singularity
Descriptionstring

The description of the containerized application.

ExampleDescription
CreateTimestring

The time when the containerized application was created.

2018-07-18T17:46:47
Repositorystring

The name of the repository.

busybox
ImageTagstring

The tags of the image.

latest
Namestring

The name of the containerized application.

ExampleName
Idstring

The ID of the containerized application.

ehpc-container-ABDUGSkjs****

Examples

Sample success responses

JSONformat

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE7****",
  "ContainerAppInfo": {
    "Type": "singularity",
    "Description": "ExampleDescription",
    "CreateTime": "2018-07-18T17:46:47",
    "Repository": "busybox",
    "ImageTag": "latest",
    "Name": "ExampleName",
    "Id": "ehpc-container-ABDUGSkjs****"
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParamsInvalid param: %s-
404ContainerNotFoundThe specified container does not exist.
406DbErrorDatabase request failed.
407NotAuthorizedThe request is not authorized by RAM.
500UnknownErrorAn unknown error occurred.
503ServiceUnavailableThe request has failed due to a temporary failure of the serverThe request has failed due to a temporary failure of the server.

For a list of error codes, visit the Service error codes.