ListContainerApps - Elastic High Performance Computing - Alibaba Cloud Documentation Center

Queries the list of containerized applications and their information.

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
ehpc:ListContainerApps	READ	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Valid values: 1 to 50. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object
PageSize	integer	The number of entries returned per page.	1
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE7****
PageNumber	integer	The page number returned.	1
TotalCount	integer	The total number of containerized applications.	1
ContainerApps	object []	The array of containerized applications.
Type	string	The type of the container. Set the value to singularity.	singularity
Description	string	The description of the containerized application.	ExampleDescription
CreateTime	string	The time at which the containerized application was created.	2018-07-18T17:46:47
Repository	string	The name of the repository.	busybox
ImageTag	string	The tags of the image.	latest
Name	string	The name of the containerized application.	ExampleName
Id	string	The ID of the container application.	ehpc-container-ABDUGSkjs****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The specified parameter %s is invalid.	The specified parameter %s is invalid.
406	DbError	A database service error occurred.	Database request failed.
406	AliyunError	An Alibaba Cloud product error occurred.	An Alibaba Cloud product error occurred.
407	NotAuthorized	You are not authorized by RAM for this request.	The request is not authorized by RAM.
500	UnknownError	An unknown error occurred.	An unknown error occurred.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server	The request has failed due to a temporary failure of the server.

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