All Products
Search
Document Center

Simple Application Server:ListCustomImages

Last Updated:Feb 01, 2024

Queries the information about custom images in a region.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the simple application servers corresponding to the custom images. You can call the ListRegions operation to query the most recent region list.

cn-hangzhou
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The value of ClientToken can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

123e4567-e89b-12d3-a456-426655440000
ImageIdsstringNo

The image IDs of the simple application server. The value can be a JSON array that consists of up to 100 image IDs. Separate multiple image IDs with commas (,).

["fe9c66133a9d4688872869726b52****", "794c230fd3e64ea19f83f4d7a0ad****"]
PageSizeintegerNo

The number of entries per page.

  • Maximum value: 100.
  • Default value: 10.
10
PageNumberintegerNo

The page number. Default value: 1.

1
ImageNamesstringNo

The image names of the simple application servers. The value can be a JSON array that consists of up to 100 image names. Separate multiple image names with commas (,).

["test1****", "test2****"]
SystemSnapshotIdstringNo

The ID of the system disk snapshot.

s-bp14m09pq8***0g6
DataSnapshotIdstringNo

The ID of the data disk snapshot.

s-acscasca****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

20758A-585D-4A41-A9B2-28DA8F4F534F
CustomImagesobject []

The queried custom images.

CreationTimestring

The time when the snapshot was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2022-10-09T02:28:06Z
DataSnapshotNamestring

The name of the data disk snapshot.

SystemSnapshotIdstring

The ID of the system disk snapshot.

s-bp1h173hj21puxb***
InShareboolean

Indicates whether the custom image is shared with Elastic Compute Service (ECS).

false
InstanceIdstring

The ID of the simple application server.

2d06ee0520b44de1ae88d4be****
DataSnapshotIdstring

The ID of the data disk snapshot.

s-bp19rn9u8eqzlfb***
RegionIdstring

The region ID of the custom images.

cn-hangzhou
SystemSnapshotNamestring

The name of the system disk snapshot.

Descriptionstring

The description of the custom image.

Namestring

The name of the custom image.

hua
ImageIdstring

The ID of the custom image.

m-bp1e79zktg26n2b***
Statusstring

The status of the custom image.

1
InstanceNamestring

The name of the simple application server.

swas-asdf23***
TotalCountstring

The total number of entries returned.

4
PageSizestring

The number of entries per page.

10
PageNumberstring

The page number.

1

Examples

Sample success responses

JSONformat

{
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "CustomImages": [
    {
      "CreationTime": "2022-10-09T02:28:06Z",
      "DataSnapshotName": "",
      "SystemSnapshotId": "s-bp1h173hj21puxb***",
      "InShare": false,
      "InstanceId": "2d06ee0520b44de1ae88d4be****",
      "DataSnapshotId": "s-bp19rn9u8eqzlfb***",
      "RegionId": "cn-hangzhou",
      "SystemSnapshotName": "",
      "Description": "",
      "Name": "hua",
      "ImageId": "m-bp1e79zktg26n2b***",
      "Status": "1",
      "InstanceName": "swas-asdf23***"
    }
  ],
  "TotalCount": "4",
  "PageSize": "10",
  "PageNumber": "1"
}

Error codes

HTTP status codeError codeError message
500InternalErrorAn error occurred while processing your request.

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

Change history

Change timeSummary of changesOperation
No change history