Queries the image list.
Debugging
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:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis 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:ListImages | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| PageNumber | long | No | The number of the page to return. | 1 |
| PageSize | long | No | The number of pieces per page. | 10 |
| ImageCategory | string | No | The source of the image. Valid values:
| Custom |
| ImageType | string | No | The type of the images. Valid values:
Default value: VM | VM |
| ImageIds | array | No | The array of image IDs. | |
| string | No | The image ID. | m-uf6bzz76jb4ai9****** | |
| ImageNames | array | No | The array of image names. | |
| string | No | The name of the image. | appimage | |
| Mode | string | No | The query mode. Valid values:
| Merge |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "896D338C-E4F4-41EC-A154-D605E5DE****",
"Success": true,
"TotalCount": 1,
"PageSize": 20,
"PageNumber": 1,
"Images": [
{
"ImageType": "VM",
"ImageId": "m-bp181x855551ww5yq****",
"AppId": "ci-vm-kHLPzEWun6zz****",
"Name": "app-image",
"Version": "v1.0",
"Description": "",
"CreateTime": "2022-12-09T07:06:34Z",
"OsTag": "Ubuntu 22.04 64 bit",
"UpdateTime": "2024-09-25 14:15:28",
"DocumentId": 30,
"Weight": 70
}
]
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidParams | The specified parameter %s is invalid. | The specified parameter %s is invalid. |
| 400 | InDebt | Your account has overdue payments. | Your account has overdue payments. |
| 400 | NotEnabled | You have not enabled this service. | You have not enabled this service |
| 406 | EcsError | An error occurred while calling the ECS API operation. | An error occurred while calling the ECS API operation. |
| 406 | AliyunError | An Alibaba Cloud product error occurred. | Alibaba Cloud product error. %s |
| 406 | DbError | A database error occurred. | A database error occurred. |
| 407 | NotAuthorized | No authorization is granted. | No authorization is granted. |
| 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.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-12-18 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2024-12-05 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
| 2024-11-18 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2024-05-14 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
